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 |
Uploads a video to YouTube and optionally sets the video's metadata.
See: YouTube Data API Reference for youtube.videos.insert
.
Synopsis
- type VideosInsertResource = ("youtube" :> ("v3" :> ("videos" :> (QueryParam "part" Text :> (QueryParam "stabilize" Bool :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "notifySubscribers" Bool :> (QueryParam "autoLevels" Bool :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Video :> Post '[JSON] Video))))))))))) :<|> ("upload" :> ("youtube" :> ("v3" :> ("videos" :> (QueryParam "part" Text :> (QueryParam "stabilize" Bool :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "notifySubscribers" Bool :> (QueryParam "autoLevels" Bool :> (QueryParam "alt" AltJSON :> (QueryParam "uploadType" Multipart :> (MultipartRelated '[JSON] Video :> Post '[JSON] Video)))))))))))))
- videosInsert :: Text -> Video -> VideosInsert
- data VideosInsert
- viPart :: Lens' VideosInsert Text
- viStabilize :: Lens' VideosInsert (Maybe Bool)
- viPayload :: Lens' VideosInsert Video
- viOnBehalfOfContentOwner :: Lens' VideosInsert (Maybe Text)
- viOnBehalfOfContentOwnerChannel :: Lens' VideosInsert (Maybe Text)
- viNotifySubscribers :: Lens' VideosInsert Bool
- viAutoLevels :: Lens' VideosInsert (Maybe Bool)
REST Resource
type VideosInsertResource = ("youtube" :> ("v3" :> ("videos" :> (QueryParam "part" Text :> (QueryParam "stabilize" Bool :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "notifySubscribers" Bool :> (QueryParam "autoLevels" Bool :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Video :> Post '[JSON] Video))))))))))) :<|> ("upload" :> ("youtube" :> ("v3" :> ("videos" :> (QueryParam "part" Text :> (QueryParam "stabilize" Bool :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "notifySubscribers" Bool :> (QueryParam "autoLevels" Bool :> (QueryParam "alt" AltJSON :> (QueryParam "uploadType" Multipart :> (MultipartRelated '[JSON] Video :> Post '[JSON] Video))))))))))))) Source #
A resource alias for youtube.videos.insert
method which the
VideosInsert
request conforms to.
Creating a Request
:: Text | |
-> Video | |
-> VideosInsert |
Creates a value of VideosInsert
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data VideosInsert Source #
Uploads a video to YouTube and optionally sets the video's metadata.
See: videosInsert
smart constructor.
Instances
Request Lenses
viPart :: Lens' VideosInsert Text Source #
The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.
viStabilize :: Lens' VideosInsert (Maybe Bool) Source #
The stabilize parameter indicates whether YouTube should adjust the video to remove shaky camera motions.
viOnBehalfOfContentOwner :: Lens' VideosInsert (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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
viOnBehalfOfContentOwnerChannel :: Lens' VideosInsert (Maybe Text) Source #
This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
viNotifySubscribers :: Lens' VideosInsert Bool Source #
The notifySubscribers parameter indicates whether YouTube should send a notification about the new video to users who subscribe to the video's channel. A parameter value of True indicates that subscribers will be notified of newly uploaded videos. However, a channel owner who is uploading many videos might prefer to set the value to False to avoid sending a notification about each new video to the channel's subscribers.
viAutoLevels :: Lens' VideosInsert (Maybe Bool) Source #
The autoLevels parameter indicates whether YouTube should automatically enhance the video's lighting and color.