Class LiveBroadcastsResource.ControlRequest
Controls the settings for a slate that can be displayed in the broadcast stream.
Inheritance
Inherited Members
Namespace: Google.Apis.YouTube.v3
Assembly: Google.Apis.YouTube.v3.dll
Syntax
public class ControlRequest : YouTubeBaseServiceRequest<LiveBroadcast>, IClientServiceRequest<LiveBroadcast>, IClientServiceRequestConstructors
ControlRequest(IClientService, String, String)
Constructs a new Control request.
Declaration
public ControlRequest(IClientService service, string id, string part)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| System.String | id | |
| System.String | part |
Properties
DisplaySlate
The displaySlate parameter specifies whether the slate is being enabled or disabled.
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
Id
The id parameter specifies the YouTube live broadcast ID that uniquely identifies the broadcast in which the slate is being updated.
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
OffsetTimeMs
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.
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 string Part { get; }Property Value
| Type | Description |
|---|---|
| System.String |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Walltime
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.
Declaration
[RequestParameter("walltime", RequestParameterType.Query)]
public virtual DateTime? Walltime { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.DateTime> |
Methods
InitParameters()
Initializes Control parameter list.
Declaration
protected override void InitParameters()