{-# LANGUAGE DataKinds #-} {-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE NoImplicitPrelude #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE TypeOperators #-} {-# OPTIONS_GHC -fno-warn-duplicate-exports #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} -- | -- Module : Network.Google.Resource.YouTube.LiveBroadcasts.Control -- Copyright : (c) 2015-2016 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Controls the settings for a slate that can be displayed in the broadcast -- stream. -- -- /See:/ for @youtube.liveBroadcasts.control@. module Network.Google.Resource.YouTube.LiveBroadcasts.Control ( -- * REST Resource LiveBroadcastsControlResource -- * Creating a Request , liveBroadcastsControl , LiveBroadcastsControl -- * Request Lenses , lbcPart , lbcOnBehalfOfContentOwner , lbcOnBehalfOfContentOwnerChannel , lbcId , lbcDisplaySlate , lbcWalltime , lbcOffSetTimeMs ) where import Network.Google.Prelude import Network.Google.YouTube.Types -- | A resource alias for @youtube.liveBroadcasts.control@ method which the -- 'LiveBroadcastsControl' request conforms to. 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 -- | Controls the settings for a slate that can be displayed in the broadcast -- stream. -- -- /See:/ 'liveBroadcastsControl' smart constructor. data LiveBroadcastsControl = LiveBroadcastsControl' { _lbcPart :: !Text , _lbcOnBehalfOfContentOwner :: !(Maybe Text) , _lbcOnBehalfOfContentOwnerChannel :: !(Maybe Text) , _lbcId :: !Text , _lbcDisplaySlate :: !(Maybe Bool) , _lbcWalltime :: !(Maybe DateTime') , _lbcOffSetTimeMs :: !(Maybe (Textual Word64)) } deriving (Eq,Show,Data,Typeable,Generic) -- | 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' liveBroadcastsControl :: Text -- ^ 'lbcPart' -> Text -- ^ 'lbcId' -> LiveBroadcastsControl liveBroadcastsControl pLbcPart_ pLbcId_ = LiveBroadcastsControl' { _lbcPart = pLbcPart_ , _lbcOnBehalfOfContentOwner = Nothing , _lbcOnBehalfOfContentOwnerChannel = Nothing , _lbcId = pLbcId_ , _lbcDisplaySlate = Nothing , _lbcWalltime = Nothing , _lbcOffSetTimeMs = Nothing } -- | 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. lbcPart :: Lens' LiveBroadcastsControl Text lbcPart = lens _lbcPart (\ s a -> s{_lbcPart = a}) -- | 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. lbcOnBehalfOfContentOwner :: Lens' LiveBroadcastsControl (Maybe Text) lbcOnBehalfOfContentOwner = lens _lbcOnBehalfOfContentOwner (\ s a -> s{_lbcOnBehalfOfContentOwner = a}) -- | 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. lbcOnBehalfOfContentOwnerChannel :: Lens' LiveBroadcastsControl (Maybe Text) lbcOnBehalfOfContentOwnerChannel = lens _lbcOnBehalfOfContentOwnerChannel (\ s a -> s{_lbcOnBehalfOfContentOwnerChannel = a}) -- | The id parameter specifies the YouTube live broadcast ID that uniquely -- identifies the broadcast in which the slate is being updated. lbcId :: Lens' LiveBroadcastsControl Text lbcId = lens _lbcId (\ s a -> s{_lbcId = a}) -- | The displaySlate parameter specifies whether the slate is being enabled -- or disabled. lbcDisplaySlate :: Lens' LiveBroadcastsControl (Maybe Bool) lbcDisplaySlate = lens _lbcDisplaySlate (\ s a -> s{_lbcDisplaySlate = a}) -- | 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. lbcWalltime :: Lens' LiveBroadcastsControl (Maybe UTCTime) lbcWalltime = lens _lbcWalltime (\ s a -> s{_lbcWalltime = a}) . mapping _DateTime -- | 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. lbcOffSetTimeMs :: Lens' LiveBroadcastsControl (Maybe Word64) lbcOffSetTimeMs = lens _lbcOffSetTimeMs (\ s a -> s{_lbcOffSetTimeMs = a}) . mapping _Coerce instance GoogleRequest LiveBroadcastsControl where type Rs LiveBroadcastsControl = LiveBroadcast type Scopes LiveBroadcastsControl = '["https://www.googleapis.com/auth/youtube", "https://www.googleapis.com/auth/youtube.force-ssl"] requestClient LiveBroadcastsControl'{..} = go (Just _lbcId) (Just _lbcPart) _lbcOnBehalfOfContentOwner _lbcOnBehalfOfContentOwnerChannel _lbcDisplaySlate _lbcWalltime _lbcOffSetTimeMs (Just AltJSON) youTubeService where go = buildClient (Proxy :: Proxy LiveBroadcastsControlResource) mempty