Network.Google.Resource.YouTube.LiveBroadcasts.Control

Controls the settings for a slate that can be displayed in the broadcast stream.

See: YouTube Data API Reference for youtube.liveBroadcasts.control.

REST Resource

type LiveBroadcastsControlResource = "youtube" :> ("v3" :> ("liveBroadcasts" :> ("control" :> (QueryParam "id" Text :> (QueryParam "part" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "displaySlate" Bool :> (QueryParam "walltime" DateTime' :> (QueryParam "offsetTimeMs" (Textual Word64) :> (QueryParam "alt" AltJSON :> Post '[JSON] LiveBroadcast)))))))))))

A resource alias for youtube.liveBroadcasts.control method which the LiveBroadcastsControl request conforms to.

Creating a Request

liveBroadcastsControl

Arguments

:: Text

lbcPart

-> Text

lbcId

-> LiveBroadcastsControl

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

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

• lbcPart
• lbcOnBehalfOfContentOwner
• lbcOnBehalfOfContentOwnerChannel
• lbcId
• lbcDisplaySlate
• lbcWalltime
• lbcOffSetTimeMs

data LiveBroadcastsControl

Controls the settings for a slate that can be displayed in the broadcast stream.

See: liveBroadcastsControl smart constructor.

Instances

Eq LiveBroadcastsControl

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

Methods

(==) :: LiveBroadcastsControl -> LiveBroadcastsControl -> Bool

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

Data LiveBroadcastsControl

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

Methods

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

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

toConstr :: LiveBroadcastsControl -> Constr

dataTypeOf :: LiveBroadcastsControl -> DataType

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

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

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

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

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

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

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

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

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

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

Show LiveBroadcastsControl

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

Methods

showsPrec :: Int -> LiveBroadcastsControl -> ShowS

show :: LiveBroadcastsControl -> String

showList :: [LiveBroadcastsControl] -> ShowS

Generic LiveBroadcastsControl

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

Associated Types

type Rep LiveBroadcastsControl :: Type -> Type

Methods

from :: LiveBroadcastsControl -> Rep LiveBroadcastsControl x

to :: Rep LiveBroadcastsControl x -> LiveBroadcastsControl

GoogleRequest LiveBroadcastsControl

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

Associated Types

type Rs LiveBroadcastsControl :: Type

type Scopes LiveBroadcastsControl :: [Symbol]

Methods

requestClient :: LiveBroadcastsControl -> GClient (Rs LiveBroadcastsControl)

type Rep LiveBroadcastsControl

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

type Rep LiveBroadcastsControl = D1 (MetaData "LiveBroadcastsControl" "Network.Google.Resource.YouTube.LiveBroadcasts.Control" "gogol-youtube-0.4.0-ICfv3TXlvc9ZGnb0rCY6m" False) (C1 (MetaCons "LiveBroadcastsControl'" PrefixI True) ((S1 (MetaSel (Just "_lbcPart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_lbcOnBehalfOfContentOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lbcOnBehalfOfContentOwnerChannel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_lbcId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_lbcDisplaySlate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_lbcWalltime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime')) :*: S1 (MetaSel (Just "_lbcOffSetTimeMs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word64)))))))

type Scopes LiveBroadcastsControl

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

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

type Rs LiveBroadcastsControl

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

type Rs LiveBroadcastsControl = LiveBroadcast

Request Lenses

lbcPart :: Lens' LiveBroadcastsControl 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.

lbcOnBehalfOfContentOwner :: Lens' LiveBroadcastsControl (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.

lbcOnBehalfOfContentOwnerChannel :: Lens' LiveBroadcastsControl (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.

lbcId :: Lens' LiveBroadcastsControl Text

The id parameter specifies the YouTube live broadcast ID that uniquely identifies the broadcast in which the slate is being updated.

lbcDisplaySlate :: Lens' LiveBroadcastsControl (Maybe Bool)

The displaySlate parameter specifies whether the slate is being enabled or disabled.

lbcWalltime :: Lens' LiveBroadcastsControl (Maybe UTCTime)

The walltime parameter specifies the wall clock time at which the specified slate change will occur. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.

lbcOffSetTimeMs :: Lens' LiveBroadcastsControl (Maybe Word64)

The offsetTimeMs parameter specifies a positive time offset when the specified slate change will occur. The value is measured in milliseconds from the beginning of the broadcast's monitor stream, which is the time that the testing phase for the broadcast began. Even though it is specified in milliseconds, the value is actually an approximation, and YouTube completes the requested action as closely as possible to that time. If you do not specify a value for this parameter, then YouTube performs the action as soon as possible. See the Getting started guide for more details. Important: You should only specify a value for this parameter if your broadcast stream is delayed.