Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.YouTube.Captions.Insert

Contents

REST Resource
Creating a Request
Request Lenses

Description

Uploads a caption track.

See: YouTube Data API Reference for youtube.captions.insert.

Synopsis

type CaptionsInsertResource = ("youtube" :> ("v3" :> ("captions" :> (QueryParam "part" Text :> (QueryParam "onBehalfOf" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "sync" Bool :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Caption :> Post '[JSON] Caption))))))))) :<|> ("upload" :> ("youtube" :> ("v3" :> ("captions" :> (QueryParam "part" Text :> (QueryParam "onBehalfOf" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "sync" Bool :> (QueryParam "alt" AltJSON :> (QueryParam "uploadType" Multipart :> (MultipartRelated '[JSON] Caption :> Post '[JSON] Caption)))))))))))
captionsInsert :: Text -> Caption -> CaptionsInsert
data CaptionsInsert
ciOnBehalfOf :: Lens' CaptionsInsert (Maybe Text)
ciPart :: Lens' CaptionsInsert Text
ciPayload :: Lens' CaptionsInsert Caption
ciOnBehalfOfContentOwner :: Lens' CaptionsInsert (Maybe Text)
ciSync :: Lens' CaptionsInsert (Maybe Bool)

REST Resource

type CaptionsInsertResource = ("youtube" :> ("v3" :> ("captions" :> (QueryParam "part" Text :> (QueryParam "onBehalfOf" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "sync" Bool :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Caption :> Post '[JSON] Caption))))))))) :<|> ("upload" :> ("youtube" :> ("v3" :> ("captions" :> (QueryParam "part" Text :> (QueryParam "onBehalfOf" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "sync" Bool :> (QueryParam "alt" AltJSON :> (QueryParam "uploadType" Multipart :> (MultipartRelated '[JSON] Caption :> Post '[JSON] Caption))))))))))) Source #

A resource alias for youtube.captions.insert method which the CaptionsInsert request conforms to.

Creating a Request

captionsInsert Source #

Arguments

:: Text	`ciPart`
-> Caption	`ciPayload`
-> CaptionsInsert

Creates a value of CaptionsInsert with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CaptionsInsert Source #

Uploads a caption track.

See: captionsInsert smart constructor.

Instances

Eq CaptionsInsert Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.Insert Methods (==) :: CaptionsInsert -> CaptionsInsert -> Bool # (/=) :: CaptionsInsert -> CaptionsInsert -> Bool #
Data CaptionsInsert Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.Insert Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CaptionsInsert -> c CaptionsInsert # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CaptionsInsert # toConstr :: CaptionsInsert -> Constr # dataTypeOf :: CaptionsInsert -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CaptionsInsert) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CaptionsInsert) # gmapT :: (forall b. Data b => b -> b) -> CaptionsInsert -> CaptionsInsert # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CaptionsInsert -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CaptionsInsert -> r # gmapQ :: (forall d. Data d => d -> u) -> CaptionsInsert -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CaptionsInsert -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CaptionsInsert -> m CaptionsInsert # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CaptionsInsert -> m CaptionsInsert # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CaptionsInsert -> m CaptionsInsert #
Show CaptionsInsert Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.Insert Methods showsPrec :: Int -> CaptionsInsert -> ShowS # show :: CaptionsInsert -> String # showList :: [CaptionsInsert] -> ShowS #
Generic CaptionsInsert Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.Insert Associated Types type Rep CaptionsInsert :: Type -> Type # Methods from :: CaptionsInsert -> Rep CaptionsInsert x # to :: Rep CaptionsInsert x -> CaptionsInsert #
GoogleRequest CaptionsInsert Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.Insert Associated Types type Rs CaptionsInsert :: Type # type Scopes CaptionsInsert :: [Symbol] # Methods requestClient :: CaptionsInsert -> GClient (Rs CaptionsInsert) #
GoogleRequest (MediaUpload CaptionsInsert) Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.Insert Associated Types type Rs (MediaUpload CaptionsInsert) :: Type # type Scopes (MediaUpload CaptionsInsert) :: [Symbol] # Methods requestClient :: MediaUpload CaptionsInsert -> GClient (Rs (MediaUpload CaptionsInsert)) #
type Rep CaptionsInsert Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.Insert type Rep CaptionsInsert = D1 (MetaData "CaptionsInsert" "Network.Google.Resource.YouTube.Captions.Insert" "gogol-youtube-0.4.0-ICfv3TXlvc9ZGnb0rCY6m" False) (C1 (MetaCons "CaptionsInsert'" PrefixI True) ((S1 (MetaSel (Just "_ciOnBehalfOf") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ciPart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :: (S1 (MetaSel (Just "_ciPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Caption) :: (S1 (MetaSel (Just "_ciOnBehalfOfContentOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ciSync") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))))
type Scopes CaptionsInsert Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.Insert type Scopes CaptionsInsert = "https://www.googleapis.com/auth/youtube.force-ssl" ': ("https://www.googleapis.com/auth/youtubepartner" ': ([] :: [Symbol]))
type Rs CaptionsInsert Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.Insert type Rs CaptionsInsert = Caption
type Scopes (MediaUpload CaptionsInsert) Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.Insert type Scopes (MediaUpload CaptionsInsert) = Scopes CaptionsInsert
type Rs (MediaUpload CaptionsInsert) Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.Insert type Rs (MediaUpload CaptionsInsert) = Caption

Request Lenses

ciOnBehalfOf :: Lens' CaptionsInsert (Maybe Text) Source #

ID of the Google+ Page for the channel that the request is be on behalf of

ciPart :: Lens' CaptionsInsert Text Source #

The part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.

ciPayload :: Lens' CaptionsInsert Caption Source #

Multipart request metadata.

ciOnBehalfOfContentOwner :: Lens' CaptionsInsert (Maybe Text) Source #

Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

ciSync :: Lens' CaptionsInsert (Maybe Bool) Source #

The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will disregard any time codes that are in the uploaded caption file and generate new time codes for the captions. You should set the sync parameter to true if you are uploading a transcript, which has no time codes, or if you suspect the time codes in your file are incorrect and want YouTube to try to fix them.