| Copyright | (c) 2015 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
Description
Uploads a caption track.
See: YouTube Data API Reference for youtube.captions.insert.
- 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" AltMedia :> (MultipartRelated `[JSON]` Caption RequestBody :> 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" AltMedia :> (MultipartRelated `[JSON]` Caption RequestBody :> Post `[JSON]` Caption))))))))))) Source
A resource alias for youtube.captions.insert method which the
CaptionsInsert request conforms to.
Creating a Request
Arguments
| :: Text | |
| -> Caption | |
| -> 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
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.