docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/youtube_v3.liveStreams.html b/docs/dyn/youtube_v3.liveStreams.html
index 7bc8df9..0f35d09 100644
--- a/docs/dyn/youtube_v3.liveStreams.html
+++ b/docs/dyn/youtube_v3.liveStreams.html
@@ -81,10 +81,10 @@
<code><a href="#delete">delete(id, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=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, onBehalfOfContentOwnerChannel=None, mine=None, id=None, onBehalfOfContentOwner=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(part, mine=None, id=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, pageToken=None, maxResults=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>
@@ -114,7 +114,7 @@
</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:
@@ -123,52 +123,52 @@
The object takes the form of:
{ # A live stream describes a live ingestion point.
- "snippet": { # The snippet 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.
- "isDefaultStream": True or False,
- "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 format.
- "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "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.
+ "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
+ "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.
+ "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*
+ "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
+ },
+ "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.
+ "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".
+ "etag": "A String", # Etag of this resource.
"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.
"status": "A String", # The status code of this stream
+ "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
"configurationIssues": [ # The configurations issues on this stream
{
- "reason": "A String", # The short-form reason for this issue.
"type": "A String", # The kind of error happening.
"severity": "A String", # How severe this issue is to the stream.
+ "reason": "A String", # The short-form reason for this issue.
"description": "A String", # The long-form description of the issue and how to resolve it.
},
],
- "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
},
"streamStatus": "A String",
},
- "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
- "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
- "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.
+ "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
+ "isDefaultStream": True or False,
+ "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 ISO 8601 format.
+ "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
},
- "etag": "A String", # Etag of this resource.
- "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
- "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.
- "frameRate": "A String", # The frame rate of the inbound video data.
- "format": "A String", # The format of the video stream that you are sending to Youtube.
- "ingestionType": "A String", # The method or protocol used to transmit the video stream.
- "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.
- "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
- "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress 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.
- "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*
- "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
- },
- "resolution": "A String", # The resolution of the inbound video data.
- },
- "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
}
- 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.
+ 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
@@ -178,63 +178,63 @@
An object of the form:
{ # A live stream describes a live ingestion point.
- "snippet": { # The snippet 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.
- "isDefaultStream": True or False,
- "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 format.
- "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "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.
+ "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
+ "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.
+ "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*
+ "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
+ },
+ "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.
+ "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".
+ "etag": "A String", # Etag of this resource.
"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.
"status": "A String", # The status code of this stream
+ "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
"configurationIssues": [ # The configurations issues on this stream
{
- "reason": "A String", # The short-form reason for this issue.
"type": "A String", # The kind of error happening.
"severity": "A String", # How severe this issue is to the stream.
+ "reason": "A String", # The short-form reason for this issue.
"description": "A String", # The long-form description of the issue and how to resolve it.
},
],
- "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
},
"streamStatus": "A String",
},
- "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
- "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
- "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.
+ "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
+ "isDefaultStream": True or False,
+ "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 ISO 8601 format.
+ "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
},
- "etag": "A String", # Etag of this resource.
- "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
- "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.
- "frameRate": "A String", # The frame rate of the inbound video data.
- "format": "A String", # The format of the video stream that you are sending to Youtube.
- "ingestionType": "A String", # The method or protocol used to transmit the video stream.
- "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.
- "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
- "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress 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.
- "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*
- "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
- },
- "resolution": "A String", # The resolution of the inbound video data.
- },
- "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(part, onBehalfOfContentOwnerChannel=None, mine=None, id=None, onBehalfOfContentOwner=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(part, mine=None, id=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, pageToken=None, maxResults=None, x__xgafv=None)</code>
<pre>Retrieve the list of streams associated with the given channel. --
Args:
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)
- 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.
mine: boolean, A parameter
id: string, Return LiveStreams with the given ids from Stubby or Apiary. (repeated)
+ 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.
- maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -248,60 +248,60 @@
"totalResults": 42, # The total number of results in the result set.
"resultsPerPage": 42, # The number of results included in the API response.
},
- "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.
- "eventId": "A String", # Serialized EventId of the request which produced this response.
- "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.
- "tokenPagination": { # Stub token pagination template to suppress results.
- },
"visitorId": "A String", # The visitorId identifies the visitor.
- "etag": "A String", # Etag of this resource.
+ "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.
- "snippet": { # The snippet 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.
- "isDefaultStream": True or False,
- "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 format.
- "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "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.
+ "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
+ "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.
+ "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*
+ "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
+ },
+ "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.
+ "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".
+ "etag": "A String", # Etag of this resource.
"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.
"status": "A String", # The status code of this stream
+ "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
"configurationIssues": [ # The configurations issues on this stream
{
- "reason": "A String", # The short-form reason for this issue.
"type": "A String", # The kind of error happening.
"severity": "A String", # How severe this issue is to the stream.
+ "reason": "A String", # The short-form reason for this issue.
"description": "A String", # The long-form description of the issue and how to resolve it.
},
],
- "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
},
"streamStatus": "A String",
},
- "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
- "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
- "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.
+ "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
+ "isDefaultStream": True or False,
+ "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 ISO 8601 format.
+ "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
},
- "etag": "A String", # Etag of this resource.
- "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
- "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.
- "frameRate": "A String", # The frame rate of the inbound video data.
- "format": "A String", # The format of the video stream that you are sending to Youtube.
- "ingestionType": "A String", # The method or protocol used to transmit the video stream.
- "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.
- "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
- "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress 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.
- "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*
- "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
- },
- "resolution": "A String", # The resolution of the inbound video data.
- },
- "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
},
],
+ "eventId": "A String", # Serialized EventId of the request which produced this response.
+ "etag": "A String", # Etag of this resource.
+ "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.
"kind": "youtube#liveStreamListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStreamListResponse".
+ "tokenPagination": { # Stub token pagination template to suppress results.
+ },
}</pre>
</div>
@@ -329,48 +329,48 @@
The object takes the form of:
{ # A live stream describes a live ingestion point.
- "snippet": { # The snippet 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.
- "isDefaultStream": True or False,
- "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 format.
- "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "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.
+ "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
+ "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.
+ "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*
+ "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
+ },
+ "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.
+ "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".
+ "etag": "A String", # Etag of this resource.
"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.
"status": "A String", # The status code of this stream
+ "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
"configurationIssues": [ # The configurations issues on this stream
{
- "reason": "A String", # The short-form reason for this issue.
"type": "A String", # The kind of error happening.
"severity": "A String", # How severe this issue is to the stream.
+ "reason": "A String", # The short-form reason for this issue.
"description": "A String", # The long-form description of the issue and how to resolve it.
},
],
- "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
},
"streamStatus": "A String",
},
- "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
- "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
- "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.
+ "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
+ "isDefaultStream": True or False,
+ "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 ISO 8601 format.
+ "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
},
- "etag": "A String", # Etag of this resource.
- "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
- "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.
- "frameRate": "A String", # The frame rate of the inbound video data.
- "format": "A String", # The format of the video stream that you are sending to Youtube.
- "ingestionType": "A String", # The method or protocol used to transmit the video stream.
- "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.
- "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
- "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress 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.
- "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*
- "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
- },
- "resolution": "A String", # The resolution of the inbound video data.
- },
- "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
}
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.
@@ -384,48 +384,48 @@
An object of the form:
{ # A live stream describes a live ingestion point.
- "snippet": { # The snippet 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.
- "isDefaultStream": True or False,
- "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 format.
- "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "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.
+ "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
+ "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.
+ "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*
+ "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
+ },
+ "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.
+ "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".
+ "etag": "A String", # Etag of this resource.
"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.
"status": "A String", # The status code of this stream
+ "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
"configurationIssues": [ # The configurations issues on this stream
{
- "reason": "A String", # The short-form reason for this issue.
"type": "A String", # The kind of error happening.
"severity": "A String", # How severe this issue is to the stream.
+ "reason": "A String", # The short-form reason for this issue.
"description": "A String", # The long-form description of the issue and how to resolve it.
},
],
- "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)
},
"streamStatus": "A String",
},
- "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
- "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
- "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.
+ "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
+ "isDefaultStream": True or False,
+ "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 ISO 8601 format.
+ "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
+ "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
},
- "etag": "A String", # Etag of this resource.
- "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
- "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.
- "frameRate": "A String", # The frame rate of the inbound video data.
- "format": "A String", # The format of the video stream that you are sending to Youtube.
- "ingestionType": "A String", # The method or protocol used to transmit the video stream.
- "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.
- "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
- "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress 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.
- "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*
- "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
- },
- "resolution": "A String", # The resolution of the inbound video data.
- },
- "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
}</pre>
</div>