Class LiveBroadcastsResource.ControlRequest

Slate and recording control of the live broadcast. Support actions: slate on/off, recording start/stop/pause/resume. Design doc: goto/yt-api-liveBroadcast-control

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<LiveBroadcast>
YouTubeBaseServiceRequest<LiveBroadcast>
LiveBroadcastsResource.ControlRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.YouTube.v3
Assembly: Google.Apis.YouTube.v3.dll
Syntax
public class ControlRequest : YouTubeBaseServiceRequest<LiveBroadcast>, IClientServiceRequest<LiveBroadcast>, IClientServiceRequest

Constructors

ControlRequest(IClientService, String, Repeatable<String>)

Constructs a new Control request.

Declaration
public ControlRequest(IClientService service, string id, Repeatable<string> part)
Parameters
Type Name Description
IClientService service
System.String id
Repeatable<System.String> part

Properties

DisplaySlate

Whether display or hide slate.

Declaration
[RequestParameter("displaySlate", RequestParameterType.Query)]
public virtual bool? DisplaySlate { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.YouTube.v3.Data.LiveBroadcast>.HttpMethod

Id

Broadcast to operate.

Declaration
[RequestParameter("id", RequestParameterType.Query)]
public virtual string Id { get; }
Property Value
Type Description
System.String

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.YouTube.v3.Data.LiveBroadcast>.MethodName

OffsetTimeMs

The exact time when the actions (e.g. slate on) are executed. It is an offset from the first frame of the monitor stream. If not set, it means "now" or ASAP. This field should not be set if the monitor stream is disabled, otherwise an error will be returned.

Declaration
[RequestParameter("offsetTimeMs", RequestParameterType.Query)]
public virtual ulong? OffsetTimeMs { get; set; }
Property Value
Type Description
System.Nullable<System.UInt64>

OnBehalfOfContentOwner

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.

Declaration
[RequestParameter("onBehalfOfContentOwner", RequestParameterType.Query)]
public virtual string OnBehalfOfContentOwner { get; set; }
Property Value
Type Description
System.String

OnBehalfOfContentOwnerChannel

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.

Declaration
[RequestParameter("onBehalfOfContentOwnerChannel", RequestParameterType.Query)]
public virtual string OnBehalfOfContentOwnerChannel { get; set; }
Property Value
Type Description
System.String

Part

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.

Declaration
[RequestParameter("part", RequestParameterType.Query)]
public virtual Repeatable<string> Part { get; }
Property Value
Type Description
Repeatable<System.String>

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.YouTube.v3.Data.LiveBroadcast>.RestPath

Walltime

The wall clock time at which the action should be executed. Only one of offset_time_ms and walltime may be set at a time.

Declaration
[RequestParameter("walltime", RequestParameterType.Query)]
public virtual object Walltime { get; set; }
Property Value
Type Description
System.Object

Methods

InitParameters()

Initializes Control parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.YouTube.v3.YouTubeBaseServiceRequest<Google.Apis.YouTube.v3.Data.LiveBroadcast>.InitParameters()

Implements