| 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.LiveBroadcasts.Transition
Description
Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream. Before calling this method, you should confirm that the value of the status.streamStatus property for the stream bound to your broadcast is active.
See: YouTube Data API Reference for youtube.liveBroadcasts.transition.
Synopsis
- type LiveBroadcastsTransitionResource = "youtube" :> ("v3" :> ("liveBroadcasts" :> ("transition" :> (QueryParam "broadcastStatus" LiveBroadcastsTransitionBroadcastStatus :> (QueryParam "id" Text :> (QueryParam "part" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] LiveBroadcast)))))))))
- liveBroadcastsTransition :: Text -> LiveBroadcastsTransitionBroadcastStatus -> Text -> LiveBroadcastsTransition
- data LiveBroadcastsTransition
- lbtPart :: Lens' LiveBroadcastsTransition Text
- lbtBroadcastStatus :: Lens' LiveBroadcastsTransition LiveBroadcastsTransitionBroadcastStatus
- lbtOnBehalfOfContentOwner :: Lens' LiveBroadcastsTransition (Maybe Text)
- lbtOnBehalfOfContentOwnerChannel :: Lens' LiveBroadcastsTransition (Maybe Text)
- lbtId :: Lens' LiveBroadcastsTransition Text
REST Resource
type LiveBroadcastsTransitionResource = "youtube" :> ("v3" :> ("liveBroadcasts" :> ("transition" :> (QueryParam "broadcastStatus" LiveBroadcastsTransitionBroadcastStatus :> (QueryParam "id" Text :> (QueryParam "part" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] LiveBroadcast))))))))) Source #
A resource alias for youtube.liveBroadcasts.transition method which the
LiveBroadcastsTransition request conforms to.
Creating a Request
liveBroadcastsTransition Source #
Arguments
| :: Text | |
| -> LiveBroadcastsTransitionBroadcastStatus | |
| -> Text | |
| -> LiveBroadcastsTransition |
Creates a value of LiveBroadcastsTransition with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data LiveBroadcastsTransition Source #
Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream. Before calling this method, you should confirm that the value of the status.streamStatus property for the stream bound to your broadcast is active.
See: liveBroadcastsTransition smart constructor.
Instances
Request Lenses
lbtPart :: Lens' LiveBroadcastsTransition Text Source #
The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.
lbtBroadcastStatus :: Lens' LiveBroadcastsTransition LiveBroadcastsTransitionBroadcastStatus Source #
The broadcastStatus parameter identifies the state to which the broadcast is changing. Note that to transition a broadcast to either the testing or live state, the status.streamStatus must be active for the stream that the broadcast is bound to.
lbtOnBehalfOfContentOwner :: Lens' LiveBroadcastsTransition (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.
lbtOnBehalfOfContentOwnerChannel :: Lens' LiveBroadcastsTransition (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.