List

Returns a list of video streams that match the API request parameters

7 variables
37 variables

Returns a list of video streams that match the API request parameters

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
  • View your YouTube account

Input

This building block consumes 7 input parameters

  = Parameter name
  = Format

part STRING Required

The part parameter specifies a comma-separated list of one or more liveStream resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, cdn, and status

id STRING

The id parameter specifies a comma-separated list of YouTube stream IDs that identify the streams being retrieved. In a liveStream resource, the id property specifies the stream's ID

maxResults INTEGER

The maxResults parameter specifies the maximum number of items that should be returned in the result set

mine BOOLEAN

The mine parameter can be used to instruct the API to only return streams owned by the authenticated user. Set the parameter value to true to only retrieve your own streams

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

pageToken STRING

The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved

Output

This building block provides 37 output parameters

  = Parameter name
  = Format

etag STRING

Etag of this resource

eventId STRING

Serialized EventId of the request which produced this response

items[] OBJECT

A live stream describes a live ingestion point

items[].cdn OBJECT

Brief description of the live stream cdn settings

items[].cdn.format STRING

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

items[].cdn.frameRate ENUMERATION

The frame rate of the inbound video data

items[].cdn.ingestionInfo OBJECT

Describes information necessary for ingesting an RTMP or an HTTP stream

items[].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

items[].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

items[].cdn.ingestionInfo.streamName STRING

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

items[].cdn.ingestionType ENUMERATION

The method or protocol used to transmit the video stream

items[].cdn.resolution ENUMERATION

The resolution of the inbound video data

items[].contentDetails OBJECT

Detailed settings of a stream

items[].contentDetails.closedCaptionsIngestionUrl STRING

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

items[].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.

items[].etag STRING

Etag of this resource

items[].id STRING

The ID that YouTube assigns to uniquely identify the stream

items[].kind STRING

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

items[].snippet OBJECT

items[].snippet.channelId STRING

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

items[].snippet.description STRING

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

items[].snippet.isDefaultStream BOOLEAN

items[].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

items[].snippet.title STRING

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

items[].status OBJECT

Brief description of the live stream status

items[].status.healthStatus OBJECT

items[].status.healthStatus.lastUpdateTimeSeconds INTEGER

The last time this status was updated (in seconds)

items[].status.healthStatus.status ENUMERATION

The status code of this stream

items[].status.streamStatus ENUMERATION

kind STRING

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

nextPageToken STRING

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set

pageInfo OBJECT

Paging details for lists of resources, including total number of items available and number of resources returned in a single page

pageInfo.resultsPerPage INTEGER

The number of results included in the API response

pageInfo.totalResults INTEGER

The total number of results in the result set

prevPageToken STRING

The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set

tokenPagination OBJECT

Stub token pagination template to suppress results

visitorId STRING

The visitorId identifies the visitor