Struct google_youtube3::LiveBroadcastControlCall

pub struct LiveBroadcastControlCall<'a, C, A> where
    C: 'a,
    A: 'a,  { /* fields omitted */ }

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

A builder for the control method supported by a liveBroadcast resource. It is not used directly, but through a LiveBroadcastMethods instance.

Settable Parts

• id
• snippet
• contentDetails
• status

Scopes

You will need authorization for at least one of the following scopes to make a valid call, possibly depending on parts:

• https://www.googleapis.com/auth/youtube
• https://www.googleapis.com/auth/youtube.force-ssl

The default scope will be Scope::Full.

Example

Instantiate a resource method builder

 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.live_broadcasts().control("id", "part")
             .walltime("clita")
             .on_behalf_of_content_owner_channel("eos")
             .on_behalf_of_content_owner("dolores")
             .offset_time_ms("vero")
             .display_slate(false)
             .doit();

Methods

impl<'a, C, A> LiveBroadcastControlCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken, 

pub fn doit(self) -> Result<(Response, LiveBroadcast)>

Perform the operation you have build so far.

pub fn id(self, new_value: &str) -> LiveBroadcastControlCall<'a, C, A>

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

Sets the id query property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn part(self, new_value: &str) -> LiveBroadcastControlCall<'a, C, A>

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.

Sets the part query property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

Settable Parts

• id
• snippet
• contentDetails
• status

pub fn walltime(self, new_value: &str) -> LiveBroadcastControlCall<'a, C, 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.

Sets the walltime query property to the given value.

pub fn on_behalf_of_content_owner_channel(
    self,
    new_value: &str
) -> LiveBroadcastControlCall<'a, C, 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.

Sets the on behalf of content owner channel query property to the given value.

pub fn on_behalf_of_content_owner(
    self,
    new_value: &str
) -> LiveBroadcastControlCall<'a, C, 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.

Sets the on behalf of content owner query property to the given value.

pub fn offset_time_ms(
    self,
    new_value: &str
) -> LiveBroadcastControlCall<'a, C, A>

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.

Sets the offset time ms query property to the given value.

pub fn display_slate(
    self,
    new_value: bool
) -> LiveBroadcastControlCall<'a, C, A>

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

Sets the display slate query property to the given value.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> LiveBroadcastControlCall<'a, C, A>

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

pub fn param<T>(self, name: T, value: T) -> LiveBroadcastControlCall<'a, C, A> where
    T: AsRef<str>, 

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• quotaUser (query-string) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• userIp (query-string) - Deprecated. Please use quotaUser instead.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for the response.

pub fn add_scope<T, S>(self, scope: T) -> LiveBroadcastControlCall<'a, C, A> where
    T: Into<Option<S>>,
    S: AsRef<str>, 

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::Full.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

Trait Implementations

impl<'a, C, A> CallBuilder for LiveBroadcastControlCall<'a, C, A>