LiveStreams: update
Stay organized with collections
Save and categorize content based on your preferences.
Updates a video stream. If the properties that you want to change cannot be updated, then you need to create a new stream with the proper settings.
Common use cases
Request
HTTP request
PUT https://www.googleapis.com/youtube/v3/liveStreams
Authorization
This request requires authorization with at least one of the following scopes (
read more about authentication and authorization
).
Scope
|
https://www.googleapis.com/auth/youtube
|
https://www.googleapis.com/auth/youtube.force-ssl
|
Parameters
The following table lists the parameters that this query supports. All of the parameters listed are query parameters.
Parameters
|
Required parameters
|
part
|
string
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
.
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. If the request body does not specify a value for a mutable property, the existing value for that property will be removed.
|
Optional parameters
|
onBehalfOfContentOwner
|
string
This parameter can only be used in a properly
authorized request
.
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
. 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.
|
Request body
Provide a
liveStream resource
in the request body.
For that resource:
-
You must specify a value for these properties:
id
snippet.title
cdn.frameRate
cdn.ingestionType
cdn.resolution
-
You can set values for these properties:
snippet.title
snippet.description
If you are submitting an update request, and your request does not specify a value for a property that already has a value, the property's existing value will be deleted.
Errors
The following table identifies error messages that the API could return in response to a call to this method. Please see the
error message
documentation for more detail.
Error type
|
Error detail
|
Description
|
forbidden (403)
|
liveStreamModificationNotAllowed
|
The specified live stream cannot be modified in its current state. For more information, see
Life of a Broadcast
.
|
forbidden (403)
|
liveStreamModificationNotAllowed
|
The API does not allow you to change the value of the
cdn.format
,
cdn.frameRate
,
cdn.ingestionType
, or
cdn.resolution
fields after the stream is created.
|
forbidden (403)
|
liveStreamModificationNotAllowed
|
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
.
|
insufficientPermissions
|
insufficientLivePermissions
|
The request is not authorized to update the specified live stream. For more information, see
Implementing OAuth2 authentication
.
|
insufficientPermissions
|
liveStreamingNotEnabled
|
The user that authorized the request is not enabled to stream live video on YouTube. The user can find more information at
https://www.youtube.com/features
.
|
invalidValue (400)
|
invalidDescription
|
The
snippet.description
property's value in the
liveStream resource
can have up to 10000 characters.
|
invalidValue (400)
|
invalidTitle
|
The
snippet.title
property's value in the
liveStream resource
must be between 1 and 128 characters long.
|
notFound (404)
|
liveStreamNotFound
|
The specified live stream doesn't exist.
|
required (400)
|
idRequired
|
The
liveStream resource
must specify a value for the
id
property.
|
required (400)
|
ingestionTypeRequired
|
The
liveStream resource
must specify a value for the
cdn.ingestionType
property.
|
required (400)
|
titleRequired
|
The
liveStream resource
must specify a value for the
snippet.title
property.
|
Try it!
Use the
APIs Explorer
to call this API and see the API request and response.
Except as otherwise noted, the content of this page is licensed under the
Creative Commons Attribution 4.0 License
, and code samples are licensed under the
Apache 2.0 License
. For details, see the
Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-04-26 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]