docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/youtube_v3.liveStreams.html b/docs/dyn/youtube_v3.liveStreams.html
index 002e7bd..5fd2dfa 100644
--- a/docs/dyn/youtube_v3.liveStreams.html
+++ b/docs/dyn/youtube_v3.liveStreams.html
@@ -75,13 +75,16 @@
<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.liveStreams.html">liveStreams</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#delete">delete(id, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an existing stream for the authenticated user.</p>
<p class="toc_element">
- <code><a href="#insert">insert(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p>
+ <code><a href="#insert">insert(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new stream for the authenticated user.</p>
<p class="toc_element">
- <code><a href="#list">list(part, onBehalfOfContentOwner=None, id=None, mine=None, maxResults=None, onBehalfOfContentOwnerChannel=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(part, mine=None, pageToken=None, maxResults=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, id=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieve the list of streams associated with the given channel. --</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -91,42 +94,18 @@
<p class="firstline">Updates an existing stream for the authenticated user.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="delete">delete(id, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code>
<pre>Deletes an existing stream for the authenticated user.
Args:
id: string, A parameter (required)
- onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a
-href="/youtube/v3/guides/authentication">authorized request</a>.
-<strong>Note:</strong> This parameter is intended exclusively for YouTube
-content partners.<br><br>The
-<code><strong>onBehalfOfContentOwnerChannel</strong></code> 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
-<code>onBehalfOfContentOwner</code> 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
-<code>onBehalfOfContentOwner</code> parameter specifies. Finally, the
-channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value
-specifies must be linked to the content owner that the
-<code>onBehalfOfContentOwner</code> parameter specifies.<br><br>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.
- onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube
-content partners.<br><br>The
-<code><strong>onBehalfOfContentOwner</strong></code> 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.
+ 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -135,135 +114,61 @@
</div>
<div class="method">
- <code class="details" id="insert">insert(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code>
+ <code class="details" id="insert">insert(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
<pre>Inserts a new stream for the authenticated user.
Args:
- part: string, The <code><strong>part</strong></code> 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.<br><br>The <code>part</code> properties that you can include in
-the parameter value are <code>id</code>, <code>snippet</code>,
-<code>cdn</code>, and <code>status</code>. (required) (repeated)
+ 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. (required) (repeated)
body: object, The request body.
The object takes the form of:
{ # A live stream describes a live ingestion point.
- "cdn": { # Brief description of the live stream cdn settings. # The <code>cdn</code> object defines the live stream's content delivery
- # network (CDN) settings. These settings provide details about the manner
- # in which you stream your content to YouTube.
- "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The <code>ingestionInfo</code> object contains information that YouTube
- # provides that you need to transmit your RTMP or HTTP stream to YouTube.
- "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of
- # <code>backupIngestionAddress</code> in order to stream via RTMPS. Not
- # applicable to non-RTMP streams.
+ "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
+ "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
+ "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 format.
+ "isDefaultStream": True or False,
+ "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
+ },
+ "cdn": { # Brief description of the live stream cdn settings. # The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.
+ "format": "A String", # The format of the video stream that you are sending to Youtube.
+ "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube.
+ "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
+ "backupIngestionAddress": "A 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.
+ "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
"streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
- "backupIngestionAddress": "A 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 <code>ingestionAddress</code> to this URL.
- "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to
- # YouTube. You must stream video to this URL.<br><br>
- # 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:<br><pre><strong>STREAM_URL/STREAM_NAME</strong></pre>
- "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of
- # <code>ingestionAddress</code> in order to stream via RTMPS. Not applicable
- # to non-RTMP streams.
+ "ingestionAddress": "A 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*
},
- "format": "A String", # The format of the video stream that you are sending to Youtube. <br><br>
- "frameRate": "A String", # The frame rate of the inbound video data.
- "resolution": "A String", # The resolution of the inbound video data.
"ingestionType": "A String", # The method or protocol used to transmit the video stream.
+ "resolution": "A String", # The resolution of the inbound video data.
+ "frameRate": "A String", # The frame rate of the inbound video data.
},
+ "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
"etag": "A String", # Etag of this resource.
- "contentDetails": { # Detailed settings of a stream. # The <code>content_details</code> object contains information about the
- # stream, including the closed captions ingestion URL.
- "isReusable": True or False, # 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.<br><br>
- # If you set this value to <code>false</code>, 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:
- # <ul>
- # <li>A non-reusable stream can only be bound to one broadcast.</li>
- # <li>A non-reusable stream might be deleted by an automated process
- # after the broadcast ends.</li>
- # <li>The <code><a href="/youtube/v3/live/docs/liveStreams/list">
- # liveStreams.list</a></code> method does not list non-reusable streams
- # if you call the method and set the <code>mine</code> parameter to
- # <code>true</code>. The only way to use that method to retrieve the
- # resource for a non-reusable stream is to use the <code>id</code>
- # parameter to identify the stream.</li>
- # </ul>
- "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
- },
- "status": { # Brief description of the live stream status. # The <code>status</code> object contains information about
- # live stream's status.
+ "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
"healthStatus": { # The health status of the stream.
- "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
- "status": "A String", # The status code of this stream
"configurationIssues": [ # The configurations issues on this stream
{
"type": "A String", # The kind of error happening.
"description": "A String", # The long-form description of the issue and how to resolve it.
- "reason": "A String", # The short-form reason for this issue.
"severity": "A String", # How severe this issue is to the stream.
+ "reason": "A String", # The short-form reason for this issue.
},
],
+ "status": "A String", # The status code of this stream
+ "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
},
"streamStatus": "A String",
},
- "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#liveStream"</code>.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
- "snippet": { # The <code>snippet</code> object contains basic details about the
- # stream, including its channel, title, and description.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that
- # is transmitting the stream.
- "description": "A String", # The stream's description. The value cannot be longer than 10000
- # characters.
- "publishedAt": "A String", # The date and time that the stream was created. The value is specified in
- # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "isDefaultStream": True or False,
- "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
+ "isReusable": True or False, # 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.
+ "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
},
+ "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
}
- onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube
-content partners.<br><br>The
-<code><strong>onBehalfOfContentOwner</strong></code> 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 <a
-href="/youtube/v3/guides/authentication">authorized request</a>.
-<strong>Note:</strong> This parameter is intended exclusively for YouTube
-content partners.<br><br>The
-<code><strong>onBehalfOfContentOwnerChannel</strong></code> 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
-<code>onBehalfOfContentOwner</code> 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
-<code>onBehalfOfContentOwner</code> parameter specifies. Finally, the
-channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value
-specifies must be linked to the content owner that the
-<code>onBehalfOfContentOwner</code> parameter specifies.<br><br>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.
+ 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.
+ 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -273,140 +178,63 @@
An object of the form:
{ # A live stream describes a live ingestion point.
- "cdn": { # Brief description of the live stream cdn settings. # The <code>cdn</code> object defines the live stream's content delivery
- # network (CDN) settings. These settings provide details about the manner
- # in which you stream your content to YouTube.
- "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The <code>ingestionInfo</code> object contains information that YouTube
- # provides that you need to transmit your RTMP or HTTP stream to YouTube.
- "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of
- # <code>backupIngestionAddress</code> in order to stream via RTMPS. Not
- # applicable to non-RTMP streams.
+ "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
+ "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
+ "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 format.
+ "isDefaultStream": True or False,
+ "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
+ },
+ "cdn": { # Brief description of the live stream cdn settings. # The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.
+ "format": "A String", # The format of the video stream that you are sending to Youtube.
+ "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube.
+ "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
+ "backupIngestionAddress": "A 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.
+ "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
"streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
- "backupIngestionAddress": "A 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 <code>ingestionAddress</code> to this URL.
- "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to
- # YouTube. You must stream video to this URL.<br><br>
- # 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:<br><pre><strong>STREAM_URL/STREAM_NAME</strong></pre>
- "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of
- # <code>ingestionAddress</code> in order to stream via RTMPS. Not applicable
- # to non-RTMP streams.
+ "ingestionAddress": "A 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*
},
- "format": "A String", # The format of the video stream that you are sending to Youtube. <br><br>
- "frameRate": "A String", # The frame rate of the inbound video data.
- "resolution": "A String", # The resolution of the inbound video data.
"ingestionType": "A String", # The method or protocol used to transmit the video stream.
+ "resolution": "A String", # The resolution of the inbound video data.
+ "frameRate": "A String", # The frame rate of the inbound video data.
},
+ "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
"etag": "A String", # Etag of this resource.
- "contentDetails": { # Detailed settings of a stream. # The <code>content_details</code> object contains information about the
- # stream, including the closed captions ingestion URL.
- "isReusable": True or False, # 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.<br><br>
- # If you set this value to <code>false</code>, 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:
- # <ul>
- # <li>A non-reusable stream can only be bound to one broadcast.</li>
- # <li>A non-reusable stream might be deleted by an automated process
- # after the broadcast ends.</li>
- # <li>The <code><a href="/youtube/v3/live/docs/liveStreams/list">
- # liveStreams.list</a></code> method does not list non-reusable streams
- # if you call the method and set the <code>mine</code> parameter to
- # <code>true</code>. The only way to use that method to retrieve the
- # resource for a non-reusable stream is to use the <code>id</code>
- # parameter to identify the stream.</li>
- # </ul>
- "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
- },
- "status": { # Brief description of the live stream status. # The <code>status</code> object contains information about
- # live stream's status.
+ "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
"healthStatus": { # The health status of the stream.
- "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
- "status": "A String", # The status code of this stream
"configurationIssues": [ # The configurations issues on this stream
{
"type": "A String", # The kind of error happening.
"description": "A String", # The long-form description of the issue and how to resolve it.
- "reason": "A String", # The short-form reason for this issue.
"severity": "A String", # How severe this issue is to the stream.
+ "reason": "A String", # The short-form reason for this issue.
},
],
+ "status": "A String", # The status code of this stream
+ "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
},
"streamStatus": "A String",
},
- "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#liveStream"</code>.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
- "snippet": { # The <code>snippet</code> object contains basic details about the
- # stream, including its channel, title, and description.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that
- # is transmitting the stream.
- "description": "A String", # The stream's description. The value cannot be longer than 10000
- # characters.
- "publishedAt": "A String", # The date and time that the stream was created. The value is specified in
- # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "isDefaultStream": True or False,
- "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
+ "isReusable": True or False, # 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.
+ "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
},
+ "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(part, onBehalfOfContentOwner=None, id=None, mine=None, maxResults=None, onBehalfOfContentOwnerChannel=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(part, mine=None, pageToken=None, maxResults=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, id=None, x__xgafv=None)</code>
<pre>Retrieve the list of streams associated with the given channel. --
Args:
- part: string, The <code><strong>part</strong></code> parameter specifies a
-comma-separated list of one or more <code>liveStream</code> resource
-properties that the API response will include. The <code>part</code> names
-that you can include in the parameter value are <code>id</code>,
-<code>snippet</code>, <code>cdn</code>, and <code>status</code>. (required) (repeated)
- onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube
-content partners.<br><br>The
-<code><strong>onBehalfOfContentOwner</strong></code> 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.
- id: string, Return LiveStreams with the given ids from Stubby or Apiary. (repeated)
+ part: string, 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. (required) (repeated)
mine: boolean, A parameter
- maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the
-maximum number of items that should be returned in the result set.
- onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a
-href="/youtube/v3/guides/authentication">authorized request</a>.
-<strong>Note:</strong> This parameter is intended exclusively for YouTube
-content partners.<br><br>The
-<code><strong>onBehalfOfContentOwnerChannel</strong></code> 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
-<code>onBehalfOfContentOwner</code> 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
-<code>onBehalfOfContentOwner</code> parameter specifies. Finally, the
-channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value
-specifies must be linked to the content owner that the
-<code>onBehalfOfContentOwner</code> parameter specifies.<br><br>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 <code><strong>pageToken</strong></code> parameter identifies a specific
-page in the result set that should be returned. In an API response, the
-<code>nextPageToken</code> and <code>prevPageToken</code> properties
-identify other pages that could be retrieved.
+ 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.
+ maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
+ 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.
+ id: string, Return LiveStreams with the given ids from Stubby or Apiary. (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -416,108 +244,64 @@
An object of the form:
{
- "eventId": "A String", # Serialized EventId of the request which produced this response.
- "visitorId": "A String", # The <code>visitorId</code> identifies the visitor.
+ "prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
+ "etag": "A String", # Etag of this resource.
+ "tokenPagination": { # Stub token pagination template to suppress results.
+ },
+ "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
"items": [ # A list of live streams that match the request criteria.
{ # A live stream describes a live ingestion point.
- "cdn": { # Brief description of the live stream cdn settings. # The <code>cdn</code> object defines the live stream's content delivery
- # network (CDN) settings. These settings provide details about the manner
- # in which you stream your content to YouTube.
- "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The <code>ingestionInfo</code> object contains information that YouTube
- # provides that you need to transmit your RTMP or HTTP stream to YouTube.
- "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of
- # <code>backupIngestionAddress</code> in order to stream via RTMPS. Not
- # applicable to non-RTMP streams.
+ "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
+ "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
+ "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 format.
+ "isDefaultStream": True or False,
+ "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
+ },
+ "cdn": { # Brief description of the live stream cdn settings. # The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.
+ "format": "A String", # The format of the video stream that you are sending to Youtube.
+ "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube.
+ "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
+ "backupIngestionAddress": "A 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.
+ "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
"streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
- "backupIngestionAddress": "A 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 <code>ingestionAddress</code> to this URL.
- "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to
- # YouTube. You must stream video to this URL.<br><br>
- # 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:<br><pre><strong>STREAM_URL/STREAM_NAME</strong></pre>
- "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of
- # <code>ingestionAddress</code> in order to stream via RTMPS. Not applicable
- # to non-RTMP streams.
+ "ingestionAddress": "A 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*
},
- "format": "A String", # The format of the video stream that you are sending to Youtube. <br><br>
- "frameRate": "A String", # The frame rate of the inbound video data.
- "resolution": "A String", # The resolution of the inbound video data.
"ingestionType": "A String", # The method or protocol used to transmit the video stream.
+ "resolution": "A String", # The resolution of the inbound video data.
+ "frameRate": "A String", # The frame rate of the inbound video data.
},
+ "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
"etag": "A String", # Etag of this resource.
- "contentDetails": { # Detailed settings of a stream. # The <code>content_details</code> object contains information about the
- # stream, including the closed captions ingestion URL.
- "isReusable": True or False, # 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.<br><br>
- # If you set this value to <code>false</code>, 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:
- # <ul>
- # <li>A non-reusable stream can only be bound to one broadcast.</li>
- # <li>A non-reusable stream might be deleted by an automated process
- # after the broadcast ends.</li>
- # <li>The <code><a href="/youtube/v3/live/docs/liveStreams/list">
- # liveStreams.list</a></code> method does not list non-reusable streams
- # if you call the method and set the <code>mine</code> parameter to
- # <code>true</code>. The only way to use that method to retrieve the
- # resource for a non-reusable stream is to use the <code>id</code>
- # parameter to identify the stream.</li>
- # </ul>
- "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
- },
- "status": { # Brief description of the live stream status. # The <code>status</code> object contains information about
- # live stream's status.
+ "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
"healthStatus": { # The health status of the stream.
- "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
- "status": "A String", # The status code of this stream
"configurationIssues": [ # The configurations issues on this stream
{
"type": "A String", # The kind of error happening.
"description": "A String", # The long-form description of the issue and how to resolve it.
- "reason": "A String", # The short-form reason for this issue.
"severity": "A String", # How severe this issue is to the stream.
+ "reason": "A String", # The short-form reason for this issue.
},
],
+ "status": "A String", # The status code of this stream
+ "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
},
"streamStatus": "A String",
},
- "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#liveStream"</code>.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
- "snippet": { # The <code>snippet</code> object contains basic details about the
- # stream, including its channel, title, and description.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that
- # is transmitting the stream.
- "description": "A String", # The stream's description. The value cannot be longer than 10000
- # characters.
- "publishedAt": "A String", # The date and time that the stream was created. The value is specified in
- # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "isDefaultStream": True or False,
- "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
+ "isReusable": True or False, # 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.
+ "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
},
+ "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
},
],
- "prevPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>
- # parameter to retrieve the previous page in the result set.
- "etag": "A String", # Etag of this resource.
- "tokenPagination": { # Stub token pagination template to suppress results.
- },
- "nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>
- # parameter to retrieve the next page in the result set.
- "kind": "youtube#liveStreamListResponse", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#liveStreamListResponse"</code>.
- "pageInfo": { # Paging details for lists of resources, including total number of items
- # available and number of resources returned in a single page.
+ "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
"resultsPerPage": 42, # The number of results included in the API response.
"totalResults": 42, # The total number of results in the result set.
},
+ "kind": "youtube#liveStreamListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStreamListResponse".
+ "eventId": "A String", # Serialized EventId of the request which produced this response.
+ "visitorId": "A String", # The visitorId identifies the visitor.
}</pre>
</div>
@@ -540,135 +324,57 @@
<pre>Updates an existing stream for the authenticated user.
Args:
- part: string, The <code><strong>part</strong></code> 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.<br><br>The <code>part</code> properties that you can include in
-the parameter value are <code>id</code>, <code>snippet</code>,
-<code>cdn</code>, and <code>status</code>.<br><br>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. (required) (repeated)
+ 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. (required) (repeated)
body: object, The request body.
The object takes the form of:
{ # A live stream describes a live ingestion point.
- "cdn": { # Brief description of the live stream cdn settings. # The <code>cdn</code> object defines the live stream's content delivery
- # network (CDN) settings. These settings provide details about the manner
- # in which you stream your content to YouTube.
- "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The <code>ingestionInfo</code> object contains information that YouTube
- # provides that you need to transmit your RTMP or HTTP stream to YouTube.
- "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of
- # <code>backupIngestionAddress</code> in order to stream via RTMPS. Not
- # applicable to non-RTMP streams.
+ "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
+ "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
+ "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 format.
+ "isDefaultStream": True or False,
+ "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
+ },
+ "cdn": { # Brief description of the live stream cdn settings. # The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.
+ "format": "A String", # The format of the video stream that you are sending to Youtube.
+ "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube.
+ "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
+ "backupIngestionAddress": "A 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.
+ "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
"streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
- "backupIngestionAddress": "A 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 <code>ingestionAddress</code> to this URL.
- "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to
- # YouTube. You must stream video to this URL.<br><br>
- # 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:<br><pre><strong>STREAM_URL/STREAM_NAME</strong></pre>
- "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of
- # <code>ingestionAddress</code> in order to stream via RTMPS. Not applicable
- # to non-RTMP streams.
+ "ingestionAddress": "A 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*
},
- "format": "A String", # The format of the video stream that you are sending to Youtube. <br><br>
- "frameRate": "A String", # The frame rate of the inbound video data.
- "resolution": "A String", # The resolution of the inbound video data.
"ingestionType": "A String", # The method or protocol used to transmit the video stream.
+ "resolution": "A String", # The resolution of the inbound video data.
+ "frameRate": "A String", # The frame rate of the inbound video data.
},
+ "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
"etag": "A String", # Etag of this resource.
- "contentDetails": { # Detailed settings of a stream. # The <code>content_details</code> object contains information about the
- # stream, including the closed captions ingestion URL.
- "isReusable": True or False, # 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.<br><br>
- # If you set this value to <code>false</code>, 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:
- # <ul>
- # <li>A non-reusable stream can only be bound to one broadcast.</li>
- # <li>A non-reusable stream might be deleted by an automated process
- # after the broadcast ends.</li>
- # <li>The <code><a href="/youtube/v3/live/docs/liveStreams/list">
- # liveStreams.list</a></code> method does not list non-reusable streams
- # if you call the method and set the <code>mine</code> parameter to
- # <code>true</code>. The only way to use that method to retrieve the
- # resource for a non-reusable stream is to use the <code>id</code>
- # parameter to identify the stream.</li>
- # </ul>
- "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
- },
- "status": { # Brief description of the live stream status. # The <code>status</code> object contains information about
- # live stream's status.
+ "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
"healthStatus": { # The health status of the stream.
- "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
- "status": "A String", # The status code of this stream
"configurationIssues": [ # The configurations issues on this stream
{
"type": "A String", # The kind of error happening.
"description": "A String", # The long-form description of the issue and how to resolve it.
- "reason": "A String", # The short-form reason for this issue.
"severity": "A String", # How severe this issue is to the stream.
+ "reason": "A String", # The short-form reason for this issue.
},
],
+ "status": "A String", # The status code of this stream
+ "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
},
"streamStatus": "A String",
},
- "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#liveStream"</code>.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
- "snippet": { # The <code>snippet</code> object contains basic details about the
- # stream, including its channel, title, and description.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that
- # is transmitting the stream.
- "description": "A String", # The stream's description. The value cannot be longer than 10000
- # characters.
- "publishedAt": "A String", # The date and time that the stream was created. The value is specified in
- # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "isDefaultStream": True or False,
- "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
+ "isReusable": True or False, # 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.
+ "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
},
+ "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
}
- onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a
-href="/youtube/v3/guides/authentication">authorized request</a>.
-<strong>Note:</strong> This parameter is intended exclusively for YouTube
-content partners.<br><br>The
-<code><strong>onBehalfOfContentOwnerChannel</strong></code> 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
-<code>onBehalfOfContentOwner</code> 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
-<code>onBehalfOfContentOwner</code> parameter specifies. Finally, the
-channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value
-specifies must be linked to the content owner that the
-<code>onBehalfOfContentOwner</code> parameter specifies.<br><br>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.
- onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube
-content partners.<br><br>The
-<code><strong>onBehalfOfContentOwner</strong></code> 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.
+ 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -678,88 +384,48 @@
An object of the form:
{ # A live stream describes a live ingestion point.
- "cdn": { # Brief description of the live stream cdn settings. # The <code>cdn</code> object defines the live stream's content delivery
- # network (CDN) settings. These settings provide details about the manner
- # in which you stream your content to YouTube.
- "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The <code>ingestionInfo</code> object contains information that YouTube
- # provides that you need to transmit your RTMP or HTTP stream to YouTube.
- "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of
- # <code>backupIngestionAddress</code> in order to stream via RTMPS. Not
- # applicable to non-RTMP streams.
+ "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
+ "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
+ "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 format.
+ "isDefaultStream": True or False,
+ "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
+ },
+ "cdn": { # Brief description of the live stream cdn settings. # The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.
+ "format": "A String", # The format of the video stream that you are sending to Youtube.
+ "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube.
+ "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
+ "backupIngestionAddress": "A 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.
+ "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
"streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
- "backupIngestionAddress": "A 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 <code>ingestionAddress</code> to this URL.
- "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to
- # YouTube. You must stream video to this URL.<br><br>
- # 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:<br><pre><strong>STREAM_URL/STREAM_NAME</strong></pre>
- "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of
- # <code>ingestionAddress</code> in order to stream via RTMPS. Not applicable
- # to non-RTMP streams.
+ "ingestionAddress": "A 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*
},
- "format": "A String", # The format of the video stream that you are sending to Youtube. <br><br>
- "frameRate": "A String", # The frame rate of the inbound video data.
- "resolution": "A String", # The resolution of the inbound video data.
"ingestionType": "A String", # The method or protocol used to transmit the video stream.
+ "resolution": "A String", # The resolution of the inbound video data.
+ "frameRate": "A String", # The frame rate of the inbound video data.
},
+ "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
"etag": "A String", # Etag of this resource.
- "contentDetails": { # Detailed settings of a stream. # The <code>content_details</code> object contains information about the
- # stream, including the closed captions ingestion URL.
- "isReusable": True or False, # 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.<br><br>
- # If you set this value to <code>false</code>, 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:
- # <ul>
- # <li>A non-reusable stream can only be bound to one broadcast.</li>
- # <li>A non-reusable stream might be deleted by an automated process
- # after the broadcast ends.</li>
- # <li>The <code><a href="/youtube/v3/live/docs/liveStreams/list">
- # liveStreams.list</a></code> method does not list non-reusable streams
- # if you call the method and set the <code>mine</code> parameter to
- # <code>true</code>. The only way to use that method to retrieve the
- # resource for a non-reusable stream is to use the <code>id</code>
- # parameter to identify the stream.</li>
- # </ul>
- "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
- },
- "status": { # Brief description of the live stream status. # The <code>status</code> object contains information about
- # live stream's status.
+ "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
"healthStatus": { # The health status of the stream.
- "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
- "status": "A String", # The status code of this stream
"configurationIssues": [ # The configurations issues on this stream
{
"type": "A String", # The kind of error happening.
"description": "A String", # The long-form description of the issue and how to resolve it.
- "reason": "A String", # The short-form reason for this issue.
"severity": "A String", # How severe this issue is to the stream.
+ "reason": "A String", # The short-form reason for this issue.
},
],
+ "status": "A String", # The status code of this stream
+ "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
},
"streamStatus": "A String",
},
- "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#liveStream"</code>.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
- "snippet": { # The <code>snippet</code> object contains basic details about the
- # stream, including its channel, title, and description.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that
- # is transmitting the stream.
- "description": "A String", # The stream's description. The value cannot be longer than 10000
- # characters.
- "publishedAt": "A String", # The date and time that the stream was created. The value is specified in
- # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "isDefaultStream": True or False,
- "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
+ "isReusable": True or False, # 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.
+ "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
},
+ "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
}</pre>
</div>