Network.Google.Resource.YouTube.LiveBroadcasts.Transition

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.

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)))))))))

A resource alias for youtube.liveBroadcasts.transition method which the LiveBroadcastsTransition request conforms to.

Creating a Request

liveBroadcastsTransition

Arguments

:: Text

lbtPart

-> LiveBroadcastsTransitionBroadcastStatus

lbtBroadcastStatus

-> Text

lbtId

-> 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:

• lbtPart
• lbtBroadcastStatus
• lbtOnBehalfOfContentOwner
• lbtOnBehalfOfContentOwnerChannel
• lbtId

data LiveBroadcastsTransition

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

Eq LiveBroadcastsTransition

Defined in Network.Google.Resource.YouTube.LiveBroadcasts.Transition

Methods

(==) :: LiveBroadcastsTransition -> LiveBroadcastsTransition -> Bool

(/=) :: LiveBroadcastsTransition -> LiveBroadcastsTransition -> Bool

Data LiveBroadcastsTransition

Defined in Network.Google.Resource.YouTube.LiveBroadcasts.Transition

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LiveBroadcastsTransition -> c LiveBroadcastsTransition

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LiveBroadcastsTransition

toConstr :: LiveBroadcastsTransition -> Constr

dataTypeOf :: LiveBroadcastsTransition -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LiveBroadcastsTransition)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LiveBroadcastsTransition)

gmapT :: (forall b. Data b => b -> b) -> LiveBroadcastsTransition -> LiveBroadcastsTransition

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LiveBroadcastsTransition -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LiveBroadcastsTransition -> r

gmapQ :: (forall d. Data d => d -> u) -> LiveBroadcastsTransition -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> LiveBroadcastsTransition -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LiveBroadcastsTransition -> m LiveBroadcastsTransition

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LiveBroadcastsTransition -> m LiveBroadcastsTransition

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LiveBroadcastsTransition -> m LiveBroadcastsTransition

Show LiveBroadcastsTransition

Defined in Network.Google.Resource.YouTube.LiveBroadcasts.Transition

Methods

showsPrec :: Int -> LiveBroadcastsTransition -> ShowS

show :: LiveBroadcastsTransition -> String

showList :: [LiveBroadcastsTransition] -> ShowS

Generic LiveBroadcastsTransition

Defined in Network.Google.Resource.YouTube.LiveBroadcasts.Transition

Associated Types

type Rep LiveBroadcastsTransition :: Type -> Type

Methods

from :: LiveBroadcastsTransition -> Rep LiveBroadcastsTransition x

to :: Rep LiveBroadcastsTransition x -> LiveBroadcastsTransition

GoogleRequest LiveBroadcastsTransition

Defined in Network.Google.Resource.YouTube.LiveBroadcasts.Transition

Associated Types

type Rs LiveBroadcastsTransition :: Type

type Scopes LiveBroadcastsTransition :: [Symbol]

Methods

requestClient :: LiveBroadcastsTransition -> GClient (Rs LiveBroadcastsTransition)

type Rep LiveBroadcastsTransition

Defined in Network.Google.Resource.YouTube.LiveBroadcasts.Transition

type Rep LiveBroadcastsTransition = D1 (MetaData "LiveBroadcastsTransition" "Network.Google.Resource.YouTube.LiveBroadcasts.Transition" "gogol-youtube-0.4.0-ICfv3TXlvc9ZGnb0rCY6m" False) (C1 (MetaCons "LiveBroadcastsTransition'" PrefixI True) ((S1 (MetaSel (Just "_lbtPart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_lbtBroadcastStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LiveBroadcastsTransitionBroadcastStatus)) :*: (S1 (MetaSel (Just "_lbtOnBehalfOfContentOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lbtOnBehalfOfContentOwnerChannel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lbtId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Scopes LiveBroadcastsTransition

Defined in Network.Google.Resource.YouTube.LiveBroadcasts.Transition

type Scopes LiveBroadcastsTransition = "https://www.googleapis.com/auth/youtube" ': ("https://www.googleapis.com/auth/youtube.force-ssl" ': ([] :: [Symbol]))

type Rs LiveBroadcastsTransition

Defined in Network.Google.Resource.YouTube.LiveBroadcasts.Transition

type Rs LiveBroadcastsTransition = LiveBroadcast

Request Lenses

lbtPart :: Lens' LiveBroadcastsTransition Text

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

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)

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)

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.

lbtId :: Lens' LiveBroadcastsTransition Text

The id parameter specifies the unique ID of the broadcast that is transitioning to another status.