Show / Hide Table of Contents

Class LiveBroadcastsResource

The "liveBroadcasts" collection of methods.

Inheritance
System.Object
LiveBroadcastsResource
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 LiveBroadcastsResource

Constructors

LiveBroadcastsResource(IClientService)

Constructs a new resource.

Declaration
public LiveBroadcastsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Bind(String, String)

Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast.

Declaration
public virtual LiveBroadcastsResource.BindRequest Bind(string id, string part)
Parameters
Type Name Description
System.String id

The id parameter specifies the unique ID of the broadcast that is being bound to a video stream.

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.

Returns
Type Description
LiveBroadcastsResource.BindRequest

Control(String, String)

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

Declaration
public virtual LiveBroadcastsResource.ControlRequest Control(string id, string part)
Parameters
Type Name Description
System.String id

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

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.

Returns
Type Description
LiveBroadcastsResource.ControlRequest

Delete(String)

Deletes a broadcast.

Declaration
public virtual LiveBroadcastsResource.DeleteRequest Delete(string id)
Parameters
Type Name Description
System.String id

The id parameter specifies the YouTube live broadcast ID for the resource that is being deleted.

Returns
Type Description
LiveBroadcastsResource.DeleteRequest

Insert(LiveBroadcast, String)

Creates a broadcast.

Declaration
public virtual LiveBroadcastsResource.InsertRequest Insert(LiveBroadcast body, string part)
Parameters
Type Name Description
LiveBroadcast body

The body of the request.

System.String part

The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.

The part properties that you can include in the parameter value are id, snippet, contentDetails, and status.

Returns
Type Description
LiveBroadcastsResource.InsertRequest

List(String)

Returns a list of YouTube broadcasts that match the API request parameters.

Declaration
public virtual LiveBroadcastsResource.ListRequest List(string part)
Parameters
Type Name 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.

Returns
Type Description
LiveBroadcastsResource.ListRequest

Transition(LiveBroadcastsResource.TransitionRequest.BroadcastStatusEnum, String, String)

Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream. Before calling this method, you should confirm that the value of the status.streamStatus property for the stream bound to your broadcast is active.

Declaration
public virtual LiveBroadcastsResource.TransitionRequest Transition(LiveBroadcastsResource.TransitionRequest.BroadcastStatusEnum broadcastStatus, string id, string part)
Parameters
Type Name Description
LiveBroadcastsResource.TransitionRequest.BroadcastStatusEnum broadcastStatus

The broadcastStatus parameter identifies the state to which the broadcast is changing. Note that to transition a broadcast to either the testing or live state, the status.streamStatus must be active for the stream that the broadcast is bound to.

System.String id

The id parameter specifies the unique ID of the broadcast that is transitioning to another status.

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.

Returns
Type Description
LiveBroadcastsResource.TransitionRequest

Update(LiveBroadcast, String)

Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object.

Declaration
public virtual LiveBroadcastsResource.UpdateRequest Update(LiveBroadcast body, string part)
Parameters
Type Name Description
LiveBroadcast body

The body of the request.

System.String part

The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.

The part properties that you can include in the parameter value are id, snippet, contentDetails, and status.

Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a broadcast's privacy status is defined in the status part. As such, if your request is updating a private or unlisted broadcast, and the request's part parameter value includes the status part, the broadcast's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the broadcast will revert to the default privacy setting.

Returns
Type Description
LiveBroadcastsResource.UpdateRequest
Back to top