youtube  v3
Public Member Functions | List of all members
google_youtube_api::LiveBroadcastsResource_ControlMethod Class Reference

#include <you_tube_service.h>

Inheritance diagram for google_youtube_api::LiveBroadcastsResource_ControlMethod:
google_youtube_api::YouTubeServiceBaseRequest

Public Member Functions

 LiveBroadcastsResource_ControlMethod (const YouTubeService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &id, const absl::string_view &part)
 
virtual ~LiveBroadcastsResource_ControlMethod ()
 
void clear_display_slate ()
 
bool get_display_slate () const
 
void set_display_slate (bool value)
 
void clear_offset_time_ms ()
 
uint64 get_offset_time_ms () const
 
void set_offset_time_ms (uint64 value)
 
void clear_on_behalf_of_content_owner ()
 
const string & get_on_behalf_of_content_owner () const
 
string * mutable_onBehalfOfContentOwner ()
 
void set_on_behalf_of_content_owner (const string &value)
 
void clear_on_behalf_of_content_owner_channel ()
 
const string & get_on_behalf_of_content_owner_channel () const
 
string * mutable_onBehalfOfContentOwnerChannel ()
 
void set_on_behalf_of_content_owner_channel (const string &value)
 
void clear_walltime ()
 
client::DateTime get_walltime () const
 
void set_walltime (client::DateTime value)
 
virtual util::Status AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
 
virtual util::Status AppendOptionalQueryParameters (string *target)
 
util::Status ExecuteAndParseResponse (LiveBroadcast *data)
 
- Public Member Functions inherited from google_youtube_api::YouTubeServiceBaseRequest
 YouTubeServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
 
virtual ~YouTubeServiceBaseRequest ()
 
void clear_alt ()
 
const string & get_alt () const
 
string * mutable_alt ()
 
void set_alt (const string &value)
 
void clear_fields ()
 
const string & get_fields () const
 
string * mutable_fields ()
 
void set_fields (const string &value)
 
void clear_key ()
 
const string & get_key () const
 
string * mutable_key ()
 
void set_key (const string &value)
 
void clear_oauth_token ()
 
const string & get_oauth_token () const
 
string * mutable_oauthToken ()
 
void set_oauth_token (const string &value)
 
void clear_pretty_print ()
 
bool get_pretty_print () const
 
void set_pretty_print (bool value)
 
void clear_quota_user ()
 
const string & get_quota_user () const
 
string * mutable_quotaUser ()
 
void set_quota_user (const string &value)
 
void clear_user_ip ()
 
const string & get_user_ip () const
 
string * mutable_userIp ()
 
void set_user_ip (const string &value)
 

Additional Inherited Members

- Protected Member Functions inherited from google_youtube_api::YouTubeServiceBaseRequest
void AddJsonContentToRequest (const client::JsonCppData *content)
 

Detailed Description

Implements the control method.

This class uses the Command Pattern. Construct an instance with the required parameters, then set any additional optional parameters by using the attribute setters. To invoke the method, call Execute.

One or more of these authorization scopes are required for this method: https://www.googleapis.com/auth/youtube https://www.googleapis.com/auth/youtube.force-ssl

Constructor & Destructor Documentation

◆ LiveBroadcastsResource_ControlMethod()

google_youtube_api::LiveBroadcastsResource_ControlMethod::LiveBroadcastsResource_ControlMethod ( const YouTubeService _service_,
client::AuthorizationCredential *  _credential_,
const absl::string_view &  id,
const absl::string_view &  part 
)

The standard constructor takes all the required method parameters.

Parameters
[in]<em>service</em>The service instance to send to when executed.
[in]<em>credential</em>If not NULL, the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.
[in]idThe id parameter specifies the YouTube live broadcast ID that uniquely identifies the broadcast in which the slate is being updated.
[in]partThe 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.

◆ ~LiveBroadcastsResource_ControlMethod()

google_youtube_api::LiveBroadcastsResource_ControlMethod::~LiveBroadcastsResource_ControlMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_youtube_api::LiveBroadcastsResource_ControlMethod::AppendOptionalQueryParameters ( string *  target)
virtual

Appends the optional query parameters to the target URL.

Parameters
[in,out]targetThe URL string to append to.

Reimplemented from google_youtube_api::YouTubeServiceBaseRequest.

◆ AppendVariable()

util::Status google_youtube_api::LiveBroadcastsResource_ControlMethod::AppendVariable ( const StringPiece &  variable_name,
const client::UriTemplateConfig &  config,
string *  target 
)
virtual

Appends variable value to the target string.

This is a helper function used to resolve templated variables in the URI.

Parameters
[in]variable_nameThe name of the templated variable.
[in]configA pass-through parameter used for lists and maps.
[in,out]targetThe string to append the value to.

Reimplemented from google_youtube_api::YouTubeServiceBaseRequest.

◆ clear_display_slate()

void google_youtube_api::LiveBroadcastsResource_ControlMethod::clear_display_slate ( )
inline

Clears the 'displaySlate' attribute so it is no longer set.

◆ clear_offset_time_ms()

void google_youtube_api::LiveBroadcastsResource_ControlMethod::clear_offset_time_ms ( )
inline

Clears the 'offsetTimeMs' attribute so it is no longer set.

◆ clear_on_behalf_of_content_owner()

void google_youtube_api::LiveBroadcastsResource_ControlMethod::clear_on_behalf_of_content_owner ( )
inline

Clears the 'onBehalfOfContentOwner' attribute so it is no longer set.

◆ clear_on_behalf_of_content_owner_channel()

void google_youtube_api::LiveBroadcastsResource_ControlMethod::clear_on_behalf_of_content_owner_channel ( )
inline

Clears the 'onBehalfOfContentOwnerChannel' attribute so it is no longer set.

◆ clear_walltime()

void google_youtube_api::LiveBroadcastsResource_ControlMethod::clear_walltime ( )
inline

Clears the 'walltime' attribute so it is no longer set.

◆ ExecuteAndParseResponse()

util::Status google_youtube_api::LiveBroadcastsResource_ControlMethod::ExecuteAndParseResponse ( LiveBroadcast data)
inline

Executes the method and parses the response into a data object on success.

Parameters
[out]dataLoads from the response payload JSON data on success.
Returns
Success if an HTTP 2xx response was received. Otherwise the status indicates the reason for failure. Finer detail may be available from the underlying http_request to distinguish the transport_status from the overal HTTP request status.

◆ get_display_slate()

bool google_youtube_api::LiveBroadcastsResource_ControlMethod::get_display_slate ( ) const
inline

Gets the optional 'displaySlate' attribute.

If the value is not set then the default value will be returned.

◆ get_offset_time_ms()

uint64 google_youtube_api::LiveBroadcastsResource_ControlMethod::get_offset_time_ms ( ) const
inline

Gets the optional 'offsetTimeMs' attribute.

If the value is not set then the default value will be returned.

◆ get_on_behalf_of_content_owner()

const string& google_youtube_api::LiveBroadcastsResource_ControlMethod::get_on_behalf_of_content_owner ( ) const
inline

Gets the optional 'onBehalfOfContentOwner' attribute.

If the value is not set then the default value will be returned.

◆ get_on_behalf_of_content_owner_channel()

const string& google_youtube_api::LiveBroadcastsResource_ControlMethod::get_on_behalf_of_content_owner_channel ( ) const
inline

Gets the optional 'onBehalfOfContentOwnerChannel' attribute.

If the value is not set then the default value will be returned.

◆ get_walltime()

client::DateTime google_youtube_api::LiveBroadcastsResource_ControlMethod::get_walltime ( ) const
inline

Gets the optional 'walltime' attribute.

If the value is not set then the default value will be returned.

◆ mutable_onBehalfOfContentOwner()

string* google_youtube_api::LiveBroadcastsResource_ControlMethod::mutable_onBehalfOfContentOwner ( )
inline

Gets a modifiable pointer to the optional onBehalfOfContentOwner' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_onBehalfOfContentOwnerChannel()

string* google_youtube_api::LiveBroadcastsResource_ControlMethod::mutable_onBehalfOfContentOwnerChannel ( )
inline

Gets a modifiable pointer to the optional onBehalfOfContentOwnerChannel' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ set_display_slate()

void google_youtube_api::LiveBroadcastsResource_ControlMethod::set_display_slate ( bool  value)
inline

Sets the 'displaySlate' attribute.

Parameters
[in]valueThe displaySlate parameter specifies whether the slate is being enabled or disabled.

◆ set_offset_time_ms()

void google_youtube_api::LiveBroadcastsResource_ControlMethod::set_offset_time_ms ( uint64  value)
inline

Sets the 'offsetTimeMs' attribute.

Parameters
[in]valueThe 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.

◆ set_on_behalf_of_content_owner()

void google_youtube_api::LiveBroadcastsResource_ControlMethod::set_on_behalf_of_content_owner ( const string &  value)
inline

Sets the 'onBehalfOfContentOwner' attribute.

Parameters
[in]valueNote: 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.

◆ set_on_behalf_of_content_owner_channel()

void google_youtube_api::LiveBroadcastsResource_ControlMethod::set_on_behalf_of_content_owner_channel ( const string &  value)
inline

Sets the 'onBehalfOfContentOwnerChannel' attribute.

Parameters
[in]valueThis 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.

◆ set_walltime()

void google_youtube_api::LiveBroadcastsResource_ControlMethod::set_walltime ( client::DateTime  value)
inline

Sets the 'walltime' attribute.

Parameters
[in]valueThe 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.

The documentation for this class was generated from the following files: