Insert

Creates a video stream

34 variables
31 variables

Creates a video stream. The stream enables you to send your video to YouTube, which can then broadcast the video to your audience

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • Manage your YouTube account
  • See, edit, and permanently delete your YouTube videos, ratings, comments and captions

Input

This building block consumes 34 input parameters

  = Parameter name
  = Format

part STRING Required

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, cdn, and status

onBehalfOfContentOwner STRING

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

onBehalfOfContentOwnerChannel STRING

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

cdn OBJECT

Brief description of the live stream cdn settings

cdn.format STRING

The format of the video stream that you are sending to Youtube

cdn.frameRate ENUMERATION

The frame rate of the inbound video data

cdn.ingestionInfo OBJECT

Describes information necessary for ingesting an RTMP or an HTTP stream

cdn.ingestionInfo.backupIngestionAddress STRING

The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL

cdn.ingestionInfo.ingestionAddress STRING

The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.

Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format:

STREAM_URL/STREAM_NAME

cdn.ingestionInfo.streamName STRING

The HTTP or RTMP stream name that YouTube assigns to the video stream

cdn.ingestionType ENUMERATION

The method or protocol used to transmit the video stream

cdn.resolution ENUMERATION

The resolution of the inbound video data

contentDetails OBJECT

Detailed settings of a stream

contentDetails.closedCaptionsIngestionUrl STRING

The ingestion URL where the closed captions of this stream are sent

contentDetails.isReusable BOOLEAN

Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times.

If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways:

  • A non-reusable stream can only be bound to one broadcast.
  • A non-reusable stream might be deleted by an automated process after the broadcast ends.
  • The liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream.

etag STRING

Etag of this resource

id STRING

The ID that YouTube assigns to uniquely identify the stream

kind STRING

Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream"

snippet OBJECT

snippet.channelId STRING

The ID that YouTube uses to uniquely identify the channel that is transmitting the stream

snippet.description STRING

The stream's description. The value cannot be longer than 10000 characters

snippet.isDefaultStream BOOLEAN

snippet.publishedAt DATE_TIME

The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format

snippet.title STRING

The stream's title. The value must be between 1 and 128 characters long

status OBJECT

Brief description of the live stream status

status.healthStatus OBJECT

status.healthStatus.configurationIssues[] OBJECT

status.healthStatus.configurationIssues[].description STRING

The long-form description of the issue and how to resolve it

status.healthStatus.configurationIssues[].reason STRING

The short-form reason for this issue

status.healthStatus.configurationIssues[].severity ENUMERATION

How severe this issue is to the stream

status.healthStatus.configurationIssues[].type ENUMERATION

The kind of error happening

status.healthStatus.lastUpdateTimeSeconds INTEGER

The last time this status was updated (in seconds)

status.healthStatus.status ENUMERATION

The status code of this stream

status.streamStatus ENUMERATION

Output

This building block provides 31 output parameters

  = Parameter name
  = Format

cdn OBJECT

Brief description of the live stream cdn settings

cdn.format STRING

The format of the video stream that you are sending to Youtube

cdn.frameRate ENUMERATION

The frame rate of the inbound video data

cdn.ingestionInfo OBJECT

Describes information necessary for ingesting an RTMP or an HTTP stream

cdn.ingestionInfo.backupIngestionAddress STRING

The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL

cdn.ingestionInfo.ingestionAddress STRING

The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.

Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format:

STREAM_URL/STREAM_NAME

cdn.ingestionInfo.streamName STRING

The HTTP or RTMP stream name that YouTube assigns to the video stream

cdn.ingestionType ENUMERATION

The method or protocol used to transmit the video stream

cdn.resolution ENUMERATION

The resolution of the inbound video data

contentDetails OBJECT

Detailed settings of a stream

contentDetails.closedCaptionsIngestionUrl STRING

The ingestion URL where the closed captions of this stream are sent

contentDetails.isReusable BOOLEAN

Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times.

If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways:

  • A non-reusable stream can only be bound to one broadcast.
  • A non-reusable stream might be deleted by an automated process after the broadcast ends.
  • The liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream.

etag STRING

Etag of this resource

id STRING

The ID that YouTube assigns to uniquely identify the stream

kind STRING

Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream"

snippet OBJECT

snippet.channelId STRING

The ID that YouTube uses to uniquely identify the channel that is transmitting the stream

snippet.description STRING

The stream's description. The value cannot be longer than 10000 characters

snippet.isDefaultStream BOOLEAN

snippet.publishedAt DATE_TIME

The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format

snippet.title STRING

The stream's title. The value must be between 1 and 128 characters long

status OBJECT

Brief description of the live stream status

status.healthStatus OBJECT

status.healthStatus.configurationIssues[] OBJECT

status.healthStatus.configurationIssues[].description STRING

The long-form description of the issue and how to resolve it

status.healthStatus.configurationIssues[].reason STRING

The short-form reason for this issue

status.healthStatus.configurationIssues[].severity ENUMERATION

How severe this issue is to the stream

status.healthStatus.configurationIssues[].type ENUMERATION

The kind of error happening

status.healthStatus.lastUpdateTimeSeconds INTEGER

The last time this status was updated (in seconds)

status.healthStatus.status ENUMERATION

The status code of this stream

status.streamStatus ENUMERATION