This page lists YouTube Live Streaming API changes and documentation updates. Subscribe to this changelog.
October 9, 2023
For reference only, you can find which Sticker IDs relate to which Super Stickers in this
CSV file.
The definitions of the liveChatMessage
resource's
snippet.superStickerDetails.superStickerMetadata.stickerId
property and the superChatEvent
resource's
snippet.superStickerMetadata.stickerId
property have both been updated to reflect this information.
September 15, 2023
The API now supports a new way of inserting ads into live broadcasts. In addition to
liveCuepoints
, which let you
manually insert ad breaks into a broadcast, YouTube now supports a feature to automatically
insert midroll ad breaks into a broadcast at fixed intervals.
If the broadcast owner enables automated ads, they can view the following aspects of ad behavior:
- the length of the interval between midroll ad breaks.
- the scheduling strategy for ad cuepoints. Cuepoints can be inserted concurrently for all viewers or the timing of the cuepoints can vary from viewer to viewer. The latter strategy enables YouTube to schedule cuepoints at an increased rate that allows viewers to receive cuepoints when they are eligible to do so.
- a period during which midroll ads are not shown; for this feature, the broadcast owner specifies that midroll ads insertion is paused until a particular time.
The documentation reflects the following API changes to support this feature:
- The
liveBroadcast
resource now contains amonetizationDetails
object. The object's fields indicate whether automatic ad insertion is enabled for the broadcast and specify additional information for scheduling cuepoints. - The
liveBroadcast.list
method'spart
parameter supports the valuemonetizationDetails
. - The
update
method can be used to pause midroll ads insertion for a certain period for a live broadcast. The documentation also now identifies several errors that can occur when updating the monetization details for a live broadcast.
August 1, 2023
This update contains the following changes:
-
The
liveBroadcasts.update
method no longer requires values to be specified for these fields:snippet.title
status.privacyStatus
Omitting these fields from the request will leave them unchanged.
November 1, 2022
-
The new
liveBroadcasts.cuepoint
method enables any channel owner running a live broadcast on YouTube to insert cuepoints into that broadcast, which can trigger ad breaks. This method replaces theliveCuepoints.insert
method, which only enabled YouTube content partners to insert cuepoints into live broadcasts.Several guides have been updated to reflect the availability of this new method.
-
Note: This is a deprecation announcement.
The
liveCuepoints.insert
method is now deprecated. Support for theliveCuepoints.insert
method will be removed on or after May 1, 2023. API users should update their applications to call theliveBroadcasts.cuepoint
method instead. -
Documentation for the
liveBroadcasts.control
method has been removed. A deprecation notice for that method was posted in September 2020.
October 1, 2022
This update contains the following changes:
-
The
liveBroadcasts.update
method no long requires values to be specified for these fields:contentDetails.enableContentEncryption
contentDetails.enableDvr
contentDetails.enableEmbed
contentDetails.recordFromStart
contentDetails.startWithSlate
Omitting these fields from the request will leave them unchanged.
-
Removed documentation for obsolete
liveBroadcast
fields:contentDetails.enableContentEncryption
contentDetails.startWithSlate
April 1, 2022
This update contains the following changes:
-
The
snippet.type
property now supports two new values:membershipGiftingEvent
giftMembershipReceivedEvent
-
The
liveChatMessage
resource's newsnippet.membershipGiftingDetails
property and its children contain information about the Membership Gifting event. Similarly, the newsnippet.giftMembershipReceivedDetails
property and its children contain information about the Gift Membership Received event.
September 15, 2021
This update contains the following changes:
-
The
snippet.type
property now supports two new values:newSponsorEvent
memberMilestoneChatEvent
-
The
liveChatMessage
resource's newsnippet.memberMilestoneChatDetails
property and its children contain information about the Member Milestone Chat event. Similarly, the newsnippet.newSponsorDetails
property and its children contain information about the New Sponsor event.
December 1, 2020
The API's liveBroadcasts.transition
method supports a new 403
(Forbidden
) error, which indicates that the user
has sent too many requests within a given timeframe. The error reason is userRequestsExceedRateLimit
.
September 21, 2020
-
The definition of the
liveBroadcast
resource'sstatus.madeForKids
property has been updated to clarify that the property is read-only. This does not reflect a change in API functionality.To designate a live broadcast as being child-directed, set the
status.selfDeclaredMadeForKids
property totrue
when calling theliveBroadcasts.insert
method to create the broadcast. -
Note: This change includes a deprecation announcement and an update to a prior deprecation announcement.
The
liveBroadcasts.control
method will be deprecated on or after 1 October 2020. After that date, all calls to this method will return a forbidden (403) error, and the method will later be completely removed. Clients can still implement their own slating by adding an overlay to the video sent to YouTube’s ingestion servers.The deprecation date for the deprecation announcement made on 16 April 2020, which was originally scheduled for 1 September 2020, has been pushed back and will now happen on or after 1 October 2020. Thus, the features included in that deprecation announcement and the
liveBroadcasts.control
method will all be deprecated at the same time.
July 17, 2020
Note: This is an update to a prior deprecation announcement.
The liveStream
resource's
cdn.format
field, which was deprecated in April 2016, will no longer be supported
as of August 17, 2020. Requests still using that field will fail as of that date.
If your code still uses the cdn.format
field, it must be updated to specify the
frame rate and resolution separately, using the
cdn.frameRate
and
cdn.resolution
properties.
July 6, 2020
The Delivering Live YouTube Content via HLS guide has been updated with a few changes:
- The recommended duration for a Media Segment has been updated to one to four seconds.
- A new section explains how to obtain an HLS Ingestion URL from YouTube Creator Studio.
-
Instructions for formatting the
file
parameter value have been moved to the new Completing the HLS Ingestion URL section. These instructions apply regardless of whether the HLS ingestion URL is obtained from the YouTube API or YouTube Creator Studio.
In addition, the new ingestion protocol comparison lists the ingestion protocols that YouTube supports, the codecs supported for each protocol, and additional information regarding appropriate use cases for each protocol.
April 16, 2020
This update includes a new property and a deprecation announcement:
-
The
liveBroadcast
resource now supports thecontentDetails.enableAutoStop
property. The property indicates whether a broadcast should stop automatically around one minute after the channel owner stops streaming video on the bound video stream.The life of a broadcast document has been updated to explain how the step-by-step process of creating and managing a live YouTube event changes if you set the
contentDetails.enableAutoStart
orcontentDetails.enableAutoStop
properties totrue
. -
Note: This is a deprecation announcement. These changes will go into effect on or after September 1, 2020. The actual date that the changes take effect is referred to below as the deprecation date.
This update explains a potentially breaking change. It affects API client applications that use channels' default
liveStream
andliveBroadcast
resources to stream live content on YouTube. Specifically, the broadcast ID and stream ID associated with the persistent broadcast and stream will no longer function to start new broadcasts.Your application will be affected if any of the following are true:
- It checks the value of the
liveBroadcast
resource'sisDefaultBroadcast
property. This property will not be returned after the deprecation date. - It checks the value of the
liveStream
resource'sisDefaultStream
property. This property will not be returned after the deprecation date. - It calls the
liveBroadcasts.list
method and sets thebroadcastType
parameter value topersistent
orall
. This parameter will be deprecated as part of these changes. As of the deprecation date:- If the
broadcastType
parameter value ispersistent
, then theliveBroadcasts.list
method will not return any results. - If the
broadcastType
parameter value isall
, then theliveBroadcasts.list
method will not return persistent broadcasts that existed before that time.
- If the
As background, for the past few years, YouTube has automatically created a default stream and a default broadcast for a channel when that channel was enabled for live streaming. The default stream existed indefinitely, did not have a start or end time associated with it, and could not be deleted. Similarly, the default broadcast was considered persistent. It always existed and was not bound to a particular event.
As of the deprecation date:
- YouTube will no longer create default streams and broadcasts. Instead of relying on the
default resources, API clients need to be able to create and manage
liveBroadcast
andliveStream
resources and to bind those resources together. - If a channel's default broadcast and default stream are actively live, meaning the channel is using them for a live broadcast at the time the deprecation goes into effect, the ongoing broadcast will not be affected. However, after that broadcast ends, the channel will not be able to use the default broadcast and default stream again.
- If a channel's default broadcast and default stream are not actively live, then after the deprecation goes into effect, YouTube will ignore attempts to use those resources to broadcast video.
If your application is affected, please refer to the following documents, which will help you to update your application so that it still works as expected following this change:
- A new migration guide tries to explain the steps that developers might need to address in API clients that currently use default broadcasts and streams.
- The Life of a broadcast guide takes you through a step-by-step process that explains how to create and manage a live event on YouTube. Each step explains the API calls or other things that you need to do to complete a specific action, and your application will need to follow that process when YouTube stops supporting default streams and broadcasts.
- It checks the value of the
March 31, 2020
Note: This is a deprecation announcement.
The sponsor
resource and
sponsors.list
method have been
deprecated and replaced by the member
resource and members.list
method.
The sponsors.list
method will no longer be supported on or after September 30, 2020.
API clients should update calls to the sponsors.list
method to use the
members.list
method instead. Please see the
YouTube Data API revision history for more information
about the new resource.
March 11, 2020
The Ingestion endpoint
section of the Delivering Live YouTube Content via HLS guide has been updated to
clarify the process that an encoder should use to complete the file=
parameter value
when forming the primary and backup ingestion URLs.
February 4, 2020
The Delivering Live YouTube Content via HLS
guide has been updated to note that DELETE
requests are optional and that YouTube's
HLS endpoint ignores them. For performance reasons, YouTube recommends clients do not send
DELETE
requests.
January 10, 2020
The API now supports the ability to identify child-directed content, which YouTube calls "made for kids." Learn more about "made for kids" content in the YouTube Help Center.
-
The
liveBroadcast
resource supports two new properties to enable content creators and viewers to identify "made for kids" content:-
The
selfDeclaredMadeForKids
property enables content creators to specify whether a live broadcast is child-directed content. This property can be set when creating a broadcast via theliveBroadcasts.insert
method. Note that this property is only included in API responses that containliveBroadcast
resources if the channel owner authorized the API request. -
The
madeForKids
property enables any API user to retrieve the "made for kids" status of a broadcast. For example, the status might be determined based on the value of theselfDeclaredMadeForKids
property. See the YouTube Help Center for more information about setting the audience for your channel, videos, or broadcasts.
-
The
-
In the YouTube Data API, the
channel
resource also supports newselfDeclaredMadeForKids
andmadeForKids
properties.
We have also updated the YouTube API Services Terms of Service and Developer Policies. Please see the YouTube API Services Terms of Service - Revision History for more information. The changes to the YouTube API Services Terms of Service and Developer Policies will take effect on January 10, 2020 Pacific Time.
August 20, 2019
The Requirements section of the Delivering Live YouTube Content via HLS guide has been updated with two changes:
- It explains that it is a best practice to include both acknowledged segments and outstanding segments in each Media Playlist. This practice makes it less likely for a segment to be skipped if a Media Playlist is lost on the server side. For example, you could include up to two acknowledged segments and up to five outstanding segments in each Media Playlist.
- It is now a requirement to send a Media Playlist for every Media Segment. This enables the server to recover quickly if a Media Playlist is lost. This practice was previously listed as a recommendation.
June 28, 2019
YouTube now supports HLS ingestion. Accordingly, the liveStream
resource's ingestionType
property supports the new value hls
to identify streams ingested to YouTube using HLS.
The new Delivering Live YouTube Content via HLS guide provides guidelines for using HLS to stream live content to YouTube from an encoder. The guide aims to help encoder vendors add HLS delivery support to their products.
April 4, 2019
This update contains the following changes:
-
The API reference documentation has been updated to better explain common use cases for each method and to provide dynamic, high-quality code samples through the APIs Explorer widget. See the
liveBroadcasts.list
method's documentation for an example. There are now two new elements on pages that describe API methods:-
The APIs Explorer widget lets you select authorization scopes, enter sample parameter and property values, and then send actual API requests and see actual API responses. The widget also offers a fullscreen view that shows complete code samples, which dynamically update to use the scopes and values that you have entered.
-
The Common use cases section describes one or more common use cases for the method explained on the page. For example, you could call the
liveBroadcasts.list
method to retrieve data about a specific broadcast or to retrieve data about the current user's broadcasts.You can use links in that section to populate the APIs Explorer with sample values for your use case or to open the fullscreen APIs Explorer with those values already populated. These changes aim to make it easier for you to see code samples that are directly applicable to the use case that you're trying to implement in your own application.
Code samples are currently supported for Java, JavaScript, PHP, Python, and curl.
-
-
The code samples page has also a new UI that offers all of the same features described above. Using that tool, you can explore use cases for different methods, load values into the APIs Explorer, and open the fullscreen APIs Explorer to get code samples in Java, JavaScript, PHP, and Python.
In conjunction with this change, the pages that previously listed available code samples for Java, PHP, and Python have been removed.
February 25, 2019
The documentation of the liveChatMessage
and superChatEvent
resources has been updated to reflect the fact that both resources can now contain information about Super Stickers. Super Stickers are a type of Super Chat message that displays an image. Like other Super Chats, a Super Sticker message is purchased by a fan during a YouTube live stream.
- In a
liveChatMessage
resource, thesnippet.type
property is now set tosuperStickerEvent
to indicate that the resource contains information about a Super Sticker. In that case, the resource also contains thesnippet.superStickerDetails
object, which contains additional information about the Super Sticker. - In a
superChatEvent
resource, the booleansnippet.isSuperStickerEvent
indicates whether the Super Chat message is also a Super Sticker. If so, then thesnippet.superStickerMetadata
object contains additional details about the Super Sticker.
April 5, 2018
The description of the superChatEvents.list
method has been updated to reflect the fact that the API response no longer contains fanFundingEvents
, which were deprecated in early 2017.
April 3, 2017
New Java code samples have been added that show how to list, insert, and delete live chat messages. The samples call the following methods:
February 13, 2017
This update contains the following changes:
-
Updates to existing resources and methods
-
The
liveCuepoints.insert
method has been updated to reflect the fact that theonBehalfOfContentOwner
parameter is currently required. In addition, the method's description has been updated to note that calls to that method must be authorized by an account associated with a YouTube Content Owner.
-
February 9, 2017
This update contains the following changes:
-
Updates to existing resources and methods
-
The
superChatEvents.list
method's newhl
parameter lets you specify that thesnippet.displayString
property value should be formatted according to the conventions of a particular language. That property's definition has also been updated accordingly.The parameter value must be a language code included in the list returned by the
i18nLanguages.list
method. The default value isen
, which means that the default behavior is to format display strings as they would be used in English. For example, by default, a string is formatted as$1.00
rather than$1,00
.
-
February 1, 2017
This update contains the following changes:
-
New resources and methods
-
The new
superChatEvent
resource represents a Super Chat message purchased by a fan during a YouTube live stream. In the YouTube live chat stream, Super Chats stand out from other messages in two ways:- Super Chats are highlighted with a color.
- Super Chats stay pinned in the ticker for a set period of time.
The color of the Super Chat, the period of time it stays pinned in the ticker, and the maximum message length are all determined by the purchase amount. The YouTube Help Center has more information about Super Chats.
The API supports a method to list Super Chat events for a channel's live streams in the previous 30 days. That method also returns data about Fan Funding events (
fanFundingEvents
) from the channel's last live stream.
-
-
Updates to existing resources and methods
-
The
snippet.type
property now supports thesuperChatEvent
value, which indicates that the resource describes a Super Chat.In addition, the
liveChatMessage
resource's newsnippet.superChatDetails
property and its children contain information about the Super Chat event. -
The
liveStream
resource'scdn.resolution
property now supports the value2160p
.
-
-
New and updated errors
-
The API supports the following new errors:
Error details liveBroadcasts.insert
,liveBroadcasts.update
The liveBroadcasts.insert
andliveBroadcasts.update
methods return400
(Bad Request
) errors to indicate that theliveBroadcast
resource being inserted or updated contains an invalid value for either thecontentDetails.enableEmbed
property or thecontentDetails.projection
property. The error reasons for the two new errors areinvalidEmbedSetting
andinvalidProjection
, respectively.
-
January 12, 2017
Note: This is a deprecation announcement.
In conjunction with the release of the new Super Chat feature, YouTube has deprecated the Fan Funding feature, and the Fan Funding API will be turned off on February 28, 2017. As of that date:
- The
liveChatMessages.list
method will no longer return messages with asnippet.type
offanFundingEvent
. Similarly,liveChatMessage
resources will no longer contain thesnippet.fanFundingEventDetails
object. - The
fanFundingEvents.list
method will no longer return data.
August 11, 2016
This update contains the following changes:
-
The newly published YouTube API Services Terms of Service ("the Updated Terms"), discussed in detail on the YouTube Engineering and Developers Blog, provides a rich set of updates to the current Terms of Service. In addition to the Updated Terms, which will go into effect as of February 10, 2017, this update includes several supporting documents to help explain the policies that developers must follow.
The full set of new documents is described in the revision history for the Updated Terms. In addition, future changes to the Updated Terms or to those supporting documents will also be explained in that revision history. You can subscribe to an RSS feed listing changes in that revision history from a link in that document.
May 20, 2016
YouTube now supports DASH ingestion. Accordingly, the liveStream
resource's ingestionType
property supports the new value dash
to identify streams ingested to YouTube using DASH.
The new Delivering Live YouTube Content via DASH guide provides guidelines for using the DASH Delivery format to stream live data on YouTube from an encoder. It is intended to help encoder vendors add DASH delivery support to their products.
April 18, 2016
This update contains the following changes:
-
Updates to existing resources and methods
liveStream
resource updates-
YouTube now supports streams with 1440p resolution at either 30 or 60 frames per second.
In addition, the
liveStream
resource contains new properties for specifying the frame rate and resolution of the inbound video data:Properties cdn.frameRate
The frame rate of the inbound video data. Valid values are 30fps
and60fps
.cdn.resolution
The resolution of the inbound video data. Valid property values are: 1440p
,1080p
,720p
,480p
,360p
, and240p
. -
In accordance with the introduction of the
liveStream
resource'scdn.frameRate
andcdn.resolution
properties, the resource'scdn.format
is now deprecated. Thecdn.format
property specifies resolution and frame rate in a single value.We encourage you to transition to the newly supported fields. In the meantime,
cdn.format
continues to work. In addition, requests to insert live streams currently succeed as long as you specify values for either thecdn.format
property or thecdn.frameRate
andcdn.resolution
properties. If you provide values for all three properties, the API might return an error if the values are not in agreement.Note that even though the
cdn.format
property is deprecated, it does now support two new values,1440p
and1440p_hfr
, to reflect the API's support for 1440p streams at either 30 or 60 frames per second.
-
liveBroadcast
resource updates-
The
liveBroadcast
resource contains the following new properties:Properties contentDetails.boundStreamLastUpdateTimeMs
The date and time that the live stream referenced by the broadcast's contentDetails.boundStreamId
property was last updated.contentDetails.projection
The broadcast's projection format. The property's default value is rectangular
. Valid values for the property are360
andrectangular
. -
The definition of the
liveBroadcast
resource'sstatistics.totalChatCount
property has been updated to note that the property value only shows up if the broadcast has at least one chat message.
-
liveChatMessage
resource updates-
The
snippet.type
property supports two new values –messageDeletedEvent
anduserBannedEvent
– that correspond to the new properties described in the following bullet point. The definition of thesnippet.authorChannelId
property has also been updated to explain what the property value identifies for these new message types. -
The
liveChatMessage
resource contains the following new properties:Properties snippet.messageDeletedDetails
This object contains information about a message that was deleted by a chat moderator. The object is only present if the snippet.type
property value ismessageDeletedEvent
.snippet.userBannedDetails
This object contains information about a user who has been banned from participating in the chat. The object also contains information about the ban itself, namely whether the ban is permanent or temporary. If the ban is temporary, one of the object's properties specifies the duration of the ban.
This object is only present if thesnippet.type
property value isuserBannedEvent
.
-
-
New and updated errors
-
The API supports the following new errors:
Error details liveBroadcasts.bind
The liveBroadcasts.bind
method returns a403
(Forbidden
) error to indicate that the user has sent too many requests within a given timeframe. The error reason isuserRequestsExceedRateLimit
.
TheliveBroadcasts.insert
andliveBroadcasts.update
methods already support the same error.liveStreams.insert
The liveStreams.insert
method supports four new400
(Bad Request
) errors that identify an invalid property value in theliveStream
resource that the request tried to insert. The following list identifies the error reasons and the properties with which they are associated:
invalidFormat
:cdn.format
invalidFrameRate
:cdn.frameRate
invalidIngestionType
:cdn.ingestionType
invalidResolution
:cdn.resolution
liveStreams.insert
The liveStreams.insert
method supports two new400
(Bad Request
) errors, each of which indicates that a required value is not present in theliveStream
resource that the request tried to insert. The following list identifies the error reasons and the properties with which they are associated:
frameRateRequired
:cdn.frameRate
resolutionRequired
:cdn.resolution
liveStream
resource, you must specify a value for either thecdn.format
property or for thecdn.frameRate
andcdn.resolution
properties.
- The API returns a
formatRequired
error if you do not specify a value for any of the three properties. - The API returns a
frameRateRequired
error if you specify a value forcdn.resolution
but notcdn.frameRate
. - The API returns a
resolutionRequired
error if you specify a value forcdn.frameRate
but notcdn.resolution
.
liveStreams.update
The liveStreams.update
method returns a403
(Forbidden
) error if the request tries to modify the value of any of the following non-mutable properties:cdn.format
cdn.frameRate
cdn.ingestionType
cdn.resolution
reason
in the error response isliveStreamModificationNotAllowed
.
-
December 18, 2015
European Union (EU) laws require that certain disclosures must be given to and consents obtained from end users in the EU. Therefore, for end users in the European Union, you must comply with the EU User Consent Policy. We have added a notice of this requirement in our YouTube API Terms of Service.
December 17, 2015
This update contains the following changes:
-
New resources and methods
-
The API supports several new resources to support chat functionality for live broadcasts. YouTube supports live chat functionality during active live broadcasts, and these resources and their methods support retrieval of chat messages as well as administrative functions for the chat.
Resources liveChatMessage
This resource represents a message in a YouTube live chat. YouTube supports several types of messages, including text messages and Fan Funding events. Some message types identify a particular phase of the chat, such as the beginning of a sponsors-only period or the end of the chat. The API supports methods to list, insert, and delete live chat messages. liveChatModerators
This resource identifies a chat moderator. Moderators can perform some administrative functions, such as banning users from the chat or removing messages. The API supports methods to list, insert, and delete live chat moderators. liveChatBans
This resource identifies a user who is banned from posting messages to a particular live chat. Bans can be temporary or permanent. The API supports methods to insert and delete live chat bans. fanFundingEvents
This resource represents a Fan Funding event on a YouTube channel. Fan Funding provides a way for viewers to voluntarily support YouTube Creators with one-time monetary support.
The API'sfanFundingEvents.list
method lists a channel's Fan Funding events. Fan Funding events that are initiated through a live chat during a live broadcast owned by the channel also trigger afanFundingEvent
message to the broadcast's live chat.
Learn more about Fan Funding in the YouTube Help Center.sponsors
The sponsor
resource identifies a sponsor of a YouTube channel. A sponsor pays a monthly fee to a channel. A badge shows up next to the sponsor's messages in the channel's live chats and sponsors can also participate in live chats exclusively for the channel's sponsors, if those occur.
The API'ssponsors.list
method lists a channel's sponsors. When users sign up to sponsor a channel during a live broadcast owned by that channel, the API also adds anewSponsorEvent
message to the broadcast's live chat.
Learn more about sponsorships in the YouTube Help Center.
-
-
Updates to existing resources and methods
-
The
liveBroadcast
resource contains the following new properties:Properties snippet.liveChatId
The ID for the broadcast's YouTube live chat. With this ID, you can use the liveChatMessage
resource's methods to retrieve, insert, or delete chat messages. You can also add or remove chat moderators, ban users from participating in live chats, or remove existing bans.contentDetails.closedCaptionsType
Note: This property replaces the contentDetails.enableClosedCaptions
property.
This property indicates whether closed captioning is enabled for your broadcast and, if so, what type of closed captions you are providing:closedCaptionsDisabled
: Closed captions are disabled for the live broadcast.closedCaptionsHttpPost
: You will send captions, via HTTP POST, to an ingestion URL associated with your live stream.closedCaptionsEmbedded
: Captions will be encoded in the video stream using EIA-608 and/or CEA-708 formats.
contentDetails.enableClosedCaptions
This property has been deprecated as of December 17, 2015. Use the contentDetails.closedCaptionsType
property instead. For API clients that are already using this property:- Setting the property value to
true
is equivalent to setting thecontentDetails.closedCaptionsType
property toclosedCaptionsHttpPost
. - Setting the property value to
false
is equivalent to setting thecontentDetails.closedCaptionsType
property toclosedCaptionsDisabled
.
-
The
liveBroadcasts.list
method's newbroadcastType
parameter lets you filter an API response to include event broadcasts, persistent broadcasts, or all broadcasts.A persistent broadcast is one that always exists and is not tied to a particular event. Specifically, a channel's default broadcast is a persistent broadcast, and it is accessible via the Live Dashboard in the YouTube Creator Studio. The channel's other broadcasts are event broadcasts.
-
-
The
liveStream
resource'sstatus.healthStatus.configurationIssues[].type
field reports the following new health status errors:Errors audioTooManyChannels
The audio has more than two channels, but only one (mono) or two (stereo) channels are supported. Please correct the number of audio channels. frameRateHigh
The current framerate is too high. Please set the framerate to fps or less.%(framerate)s
-
The publication date of the previous documentation update was corrected.
-
New and updated errors
-
In addition to errors defined for the new resources listed above, the API supports the following new errors:
Error details liveBroadcasts.update
HTTP Response Code forbidden (403)
Reason closedCaptionsTypeModificationNotAllowed
Description The contentDetails.closedCaptionsType
value can only be modified when the broadcast is in thecreated
orready
status.liveBroadcasts.update
HTTP Response Code invalidValue (400)
Reason invalidEnableClosedCaptions
Description In the liveBroadcast resource, the value of the contentDetails.enableClosedCaptions
property is incompatible with the value of thecontentDetails.closedCaptionType
setting. Modify the resource to only include one of the two properties, and then resubmit the request.
-
August 19, 2015
This update contains the following changes:
-
New resources and methods
-
Note: Documentation for the
liveChat
resource and its methods is confidential and only visible to select YouTube partners.The new
liveChat
resource contains a comment posted during a live broadcast on YouTube. The API supports two methods for this resource:Methods liveChats.list
List live chat messages for a broadcast. liveChats.insert
Create a new chat message. Live chat messages can only be retrieved and posted while a broadcast is live.
-
-
Updates to existing resources and methods
-
The
liveStream
resource contains the following new properties:Properties snippet.isDefaultStream
Indicates whether this stream is the default stream for the channel. A channel's default stream exists indefinitely, does not have a start or end time associated with it, and cannot be deleted. See the property's definition for more information about how default streams work. status.healthStatus
This object contains information that could be used to identify, diagnose and resolve streaming problems. The object contains a number of child properties to help you evaluate the health of a live video stream.
In particular, thestatus.healthStatus.configurationIssues[]
object lists issues affecting a video stream. A new document, Configuration Issues for LiveStream Resources, lists all of the issues that the API reports.contentDetails.isReusable
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. -
The
liveBroadcast
resource contains the following new properties:Properties snippet.isDefaultBroadcast
Indicates whether this broadcast is the default broadcast for the channel. When a YouTube channel is enabled for live streaming, YouTube creates a default stream and a default broadcast for the channel. The stream defines how the channel owner sends live video to YouTube, and the broadcast is how viewers can see the default stream. See the property's definition for more information about how default broadcasts work. contentDetails.enableLowLatency
Indicates whether this broadcast should be encoded for low-latency streaming. A low-latency stream can reduce the amount of time it takes for video to be visible to users watching a broadcast, though it can also impact the resolution for viewers of the stream. statistics.totalChatCount
The total number of live chat messages associated with the broadcast. The property and its value are present if the broadcast is visible to the user and has the live chat feature enabled. Note that this property will not specify a value after the broadcast ends. So, this property would not identify the number of chat messages for an archived video of a completed live broadcast.
-
-
New and updated errors
-
In addition to errors defined for the new
liveChat
resource, the API supports the following new error:Error details liveStreams.update
HTTP Response Code forbidden (403)
Reason liveStreamModificationNotAllowed
Description The API does not allow you to change a reusable stream to be non-reusable, or vice versa. For more information, see Understanding Broadcasts and Streams
-
May 21, 2015
This update contains the following changes:
-
YouTube now supports live video streaming at 60 frames per second (fps), which means smoother playback for gaming and other fast-action videos. When you start a live stream on YouTube at 60fps, YouTube also makes the stream available in 30fps on devices where high-frame-rate viewing is not yet available.
The
liveStream
resource'scdn.format
property supports two new values for this feature:720p_hfr
and1080p_hfr
.See the YouTube Creators Blog for more information about this feature.
August 21, 2014
This update contains the following changes:
-
The definition of the
liveBroadcasts.control
method'swalltime
parameter has been updated to note that the property value is specified in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ
). -
The API now supports the following errors:
Error type Error detail Description insufficientPermissions
liveStreamingNotEnabled
All methods for the liveBroadcast
andliveStream
resources return this error if the user that authorized the API request has not been enabled to stream live video on YouTube. Details explaining why the user cannot stream live video may be available in the user's channel settings at https://www.youtube.com/features.rateLimitExceeded
userRequestsExceedRateLimit
The liveBroadcasts.insert
andliveStreams.insert
methods both return this error to indicate that the user has sent too many requests within a given timeframe.
May 2, 2014
This update contains the following changes:
-
The descriptions of the
liveStream
resource and of theliveBroadcasts.bind
method have been updated to note that a broadcast can only be bound to one video stream, but a video stream can be bound to more than one broadcast. This change is solely a correction to the documentation; the underlying API functionality has not changed. -
The
liveBroadcast
resource'scontentDetails.monitorStream.enableMonitorStream
property has been updated to explain that if the property's value istrue
, then you must transition your broadcast to thetesting
state before you can transition it to thelive
state. (If the property's value isfalse
, your broadcast cannot have atesting
stage, so you can transition the broadcast directly to thelive
state. -
The
liveCuepoint
resource'ssettings.offsetTimeMs
property has been updated to note that you should not specify a value for the property if your broadcast does not have a monitor stream. -
All of the methods for the
liveBroadcast
andliveStream
resources now support theonBehalfOfContentOwner
andonBehalfOfContentOwnerChannel
parameters. These parameters allow you to use the same authorization credentials to complete API requests for different channels associated with the same content owner. -
The
liveCuepoints.insert
method's documentation has been updated to note that you can set a value for thesettings.walltime
property when calling that method. -
The error documentation now specifies the HTTP response code for each error type.
-
The API now supports the following error:
Error type Error detail Description insufficientPermissions
livePermissionBlocked
The liveBroadcasts.insert
,liveBroadcasts.transition
, andliveStreams.insert
methods return this error if the user that authorized the request is unable to stream live video on YouTube. Details explaining why the user cannot stream live video may be available in the user's channel settings at https://www.youtube.com/features. -
The
liveBroadcasts.insert
method'sinvalidScheduledStartTime
error has been updated to clarify that the scheduled start time must be close enough to the current date that a broadcast could be reliably scheduled at that time.
December 13, 2013
This update contains the following changes:
-
The
liveBroadcast
resource's newstatus.recordingStatus
property identifies the broadcast's current status. -
The
liveBroadcast
resource's newcontentDetails.enableClosedCaptions
property indicates whether closed captions can be ingested for the broadcast. The property value can be set when you insert or update a broadcast, but it cannot be updated once the broadcast is in thetesting
orlive
state. If you set this property totrue
, then theliveStream
resource that is bound to the broadcast will specify the ingestion URL to use for the broadcast's closed captions. -
The
liveBroadcast
resource'ssnippet.scheduledEndTime
property now supports broadcasts that are scheduled to continue indefinitely. With this change, the property is no longer required inliveBroadcasts.insert
andliveBroadcasts.update
requests.
If you retrieve aliveBroadcast
resource that does not specify a value for this property, then the broadcast is scheduled to continue indefinitely. Similarly, if you call theliveBroadcasts.insert
orliveBroadcasts.update
method and do not specify a value for this property, the broadcast will be scheduled to continue indefinitely. -
The
liveBroadcast
resource'scontentDetails.recordFromStart
property, which already had a default value oftrue
, can now only be set tofalse
if the broadcasting channel is allowed to disable recordings for live broadcasts.If your channel does not have permission to disable recordings, and you attempt to insert a broadcast with the
recordFromStart
property set tofalse
, the API will return aForbidden
error. In addition, if your channel does not have that permission and you attempt to update a broadcast to set therecordFromStart
property tofalse
, the API will return amodificationNotAllowed
error. -
The
liveBroadcast
resource no longer contains anenableArchive
property, which had been mentioned in the descriptions of thecontentDetails.enableDvr
andcontentDetails.enableEmbed
properties. -
The list of valid values for the
liveBroadcast
resource'sstatus.lifeCycleStatus
property has been updated to include a description of each status. -
The
liveCuepoint
resource's newsettings.walltime
property specifies the date and time at which the cuepoint should be inserted. The API returns an error if a request tries to insert a cuepoint that specifies a value for this property and for thesettings.offsetTimeMs
property. -
The new
contentDetails
object in aliveStream
resource contains information about the stream. Currently, the object's only property iscontentDetails.closedCaptionsIngestionUrl
, which specifies the ingestion URL for closed captions associated with the video stream. -
The list of valid values for the
liveStream
resource'sstatus.streamStatus
property has been updated to include a description of each status. -
The
liveBroadcasts.control
method's newwalltime
parameter lets you specify the date and time when a slate change will occur. The API returns an error if a request specifies a value for this parameter and for theoffsetTimeMs
parameter. -
In the API response to a
liveBroadcasts.list
request, the value of thekind
property has changed fromyoutube#liveBroadcastList
toyoutube#liveBroadcastListResponse
. -
In the API response to a
liveStreams.list
request, the value of thekind
property has changed fromyoutube#liveStreamList
toyoutube#liveStreamListResponse
. -
The
eventId
property has been deprecated from both theliveBroadcastListResponse
and theliveStreamListResponse
. -
The API supports the following new errors:
Error type Error detail Description invalidValue
conflictingTimeFields
The liveBroadcasts.control
method returns this error if your request specifies values for theoffsetTimeMs
andwalltime
parameters. A request can either omit both parameters or specify a value for one of the two parameters.invalidValue
invalidWalltime
The liveBroadcasts.control
method returns this error if thewalltime
parameter's value is invalid.forbidden
enableClosedCaptionsModificationNotAllowed
The liveBroadcasts.update
method returns this error if you attempt to update thecontentDetails.enableClosedCaptions
value and the broadcast's status is notcreated
orready
.invalidValue
conflictingTimeFields
The liveCuepoints.insert
method returns this error if your request specifies values for thesettings.offsetTimeMs
andsettings.walltime
properties. A request can either omit both properties or specify a value for one of the two properties.In addition, the
liveStreams.update
method no longer supports acdnRequired
error similar to the one that theliveStreams.insert
method supports.
May 10, 2013
This update contains the following changes:
-
YouTube no longer identifies experimental API features and services. Instead, we now provide a list of YouTube APIs that are subject to the deprecation policy.
May 2, 2013
This update contains the following changes:
-
The new
liveBroadcasts.control
method enables you to toggle the display settings for a slate that displays in the broadcast stream for a broadcast that is already in progress. If your broadcast stream is delayed, you can also use this method to specify a time offset when the requested slate change will occur. -
The definitions of the following properties have been updated to explain that the property values must be set if you update a
liveBroadcast
resource'scontentDetails
part: -
The
liveStream
resource'sstatus.streamStatus
no longer supports the valuedeleted
as a possible stream status. -
The information that the API returns for many error messages has been revised to better explain why particular errors occurred. The API also supports several new errors.
March 27, 2013
This update contains the following changes:
-
The following properties have changed in the
liveBroadcast
resource:- The
startWithSlateCuepoint
property has been renamed tostartWithSlate
. - The
enableArchive
property has been renamed torecordFromStart
. - The
slateSettings
object has been deprecated and removed from the documentation. Error messages related to theslateSettings
object or its properties have also been removed. Finally, the "Displaying Slates" section of the Getting started guide has been removed.
- The
-
The API no longer supports the ability to insert in-stream slates using the
liveCuepoints.insert
method. The following documents have been updated to reflect this change:-
The index page, Getting started guide, and Life of a broadcast tutorial no longer mention this functionality.
-
The
liveCuepoint
resource'ssettings.cueType
property no longer supportsslate
as a property value. (The only supported value isad
. -
The
liveCuepoint
resource'ssettings.eventState
property has been deprecated and removed from the documentation.
-
March 18, 2013
This update contains the following changes:
-
All of the API's error messages have been updated to more clearly explain possible errors and, when possible, offer guidance about how to fix them.
-
The API may now return several new errors. The list below identifies the error and the API method that might return that error:
liveBroadcasts.insert
– A broadcast's scheduled end time must be after its scheduled start time.liveBroadcasts.insert
– The broadcast specifies an invalid privacy status.liveBroadcasts.update
– The resource does not contain or does not set a value for thecontentDetails.enableArchive
property.liveBroadcasts.update
– The resource does not contain or does not set a value for thecontentDetails.enableContentEncryption
property.liveBroadcasts.update
– The resource does not contain or does not set a value for thecontentDetails.enableDvr
property.liveStreams.insert
– The snippet title must be between 1 and 128 characters long.liveStreams.update
– The resource does not contain or does not set a value for thesnippet.title
property.
-
The
liveStream
resource documentation has been updated to reflect that multicast and WebM are not supported ingestion methods as previously indicated. The list of formats for thecdn.format
property has been updated accordingly, and thecdn.multicastIngestionInfo
object and its child properties have been removed from the resource's documentation. In addition,http
has been removed from the list of supportedcdn.ingestionType
values.