blob: d95157d093c35b22baccd82ec506b48c1cb85711 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kimd059ad82020-07-22 17:02:09 -070075<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.liveStreams.html">liveStreams</a></h1>
John Asmuth614db982014-04-24 15:46:26 -040076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070081 <code><a href="#delete">delete(id, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070082<p class="firstline">Deletes an existing stream for the authenticated user.</p>
John Asmuth614db982014-04-24 15:46:26 -040083<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -080084 <code><a href="#insert">insert(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070085<p class="firstline">Inserts a new stream for the authenticated user.</p>
John Asmuth614db982014-04-24 15:46:26 -040086<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -080087 <code><a href="#list">list(part, onBehalfOfContentOwner=None, mine=None, maxResults=None, id=None, pageToken=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070088<p class="firstline">Retrieve the list of streams associated with the given channel. --</p>
John Asmuth614db982014-04-24 15:46:26 -040089<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -080093 <code><a href="#update">update(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070094<p class="firstline">Updates an existing stream for the authenticated user.</p>
John Asmuth614db982014-04-24 15:46:26 -040095<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700102 <code class="details" id="delete">delete(id, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700103 <pre>Deletes an existing stream for the authenticated user.
John Asmuth614db982014-04-24 15:46:26 -0400104
105Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700106 id: string, A parameter (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700107 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700108 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request&#x27;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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400113</pre>
114</div>
115
116<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800117 <code class="details" id="insert">insert(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700118 <pre>Inserts a new stream for the authenticated user.
John Asmuth614db982014-04-24 15:46:26 -0400119
120Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700121 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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700122 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400123 The object takes the form of:
124
125{ # A live stream describes a live ingestion point.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800126 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800127 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the stream.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800128 &quot;status&quot;: { # Brief description of the live stream status. # The status object contains information about live stream&#x27;s status.
129 &quot;healthStatus&quot;: { # The health status of the stream.
130 &quot;status&quot;: &quot;A String&quot;, # The status code of this stream
131 &quot;configurationIssues&quot;: [ # The configurations issues on this stream
132 {
133 &quot;reason&quot;: &quot;A String&quot;, # The short-form reason for this issue.
134 &quot;severity&quot;: &quot;A String&quot;, # How severe this issue is to the stream.
135 &quot;type&quot;: &quot;A String&quot;, # The kind of error happening.
136 &quot;description&quot;: &quot;A String&quot;, # The long-form description of the issue and how to resolve it.
137 },
138 ],
139 &quot;lastUpdateTimeSeconds&quot;: &quot;A String&quot;, # The last time this status was updated (in seconds)
140 },
141 &quot;streamStatus&quot;: &quot;A String&quot;,
142 },
143 &quot;kind&quot;: &quot;youtube#liveStream&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#liveStream&quot;.
144 &quot;snippet&quot;: { # The snippet object contains basic details about the stream, including its channel, title, and description.
145 &quot;description&quot;: &quot;A String&quot;, # The stream&#x27;s description. The value cannot be longer than 10000 characters.
146 &quot;isDefaultStream&quot;: True or False,
147 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time that the stream was created. The value is specified in ISO 8601 format.
148 &quot;title&quot;: &quot;A String&quot;, # The stream&#x27;s title. The value must be between 1 and 128 characters long.
149 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
150 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800151 &quot;contentDetails&quot;: { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
152 &quot;isReusable&quot;: 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.
153 &quot;closedCaptionsIngestionUrl&quot;: &quot;A String&quot;, # The ingestion URL where the closed captions of this stream are sent.
154 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800155 &quot;cdn&quot;: { # Brief description of the live stream cdn settings. # The cdn object defines the live stream&#x27;s content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.
156 &quot;frameRate&quot;: &quot;A String&quot;, # The frame rate of the inbound video data.
157 &quot;resolution&quot;: &quot;A String&quot;, # The resolution of the inbound video data.
158 &quot;format&quot;: &quot;A String&quot;, # The format of the video stream that you are sending to Youtube.
159 &quot;ingestionType&quot;: &quot;A String&quot;, # The method or protocol used to transmit the video stream.
160 &quot;ingestionInfo&quot;: { # 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.
161 &quot;streamName&quot;: &quot;A String&quot;, # The HTTP or RTMP stream name that YouTube assigns to the video stream.
162 &quot;rtmpsBackupIngestionAddress&quot;: &quot;A String&quot;, # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
163 &quot;backupIngestionAddress&quot;: &quot;A String&quot;, # 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.
164 &quot;ingestionAddress&quot;: &quot;A String&quot;, # 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*
165 &quot;rtmpsIngestionAddress&quot;: &quot;A String&quot;, # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700166 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700167 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700168 }
John Asmuth614db982014-04-24 15:46:26 -0400169
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700170 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800171 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request&#x27;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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700172 x__xgafv: string, V1 error format.
173 Allowed values
174 1 - v1 error format
175 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400176
177Returns:
178 An object of the form:
179
180 { # A live stream describes a live ingestion point.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800181 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800182 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the stream.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800183 &quot;status&quot;: { # Brief description of the live stream status. # The status object contains information about live stream&#x27;s status.
184 &quot;healthStatus&quot;: { # The health status of the stream.
185 &quot;status&quot;: &quot;A String&quot;, # The status code of this stream
186 &quot;configurationIssues&quot;: [ # The configurations issues on this stream
187 {
188 &quot;reason&quot;: &quot;A String&quot;, # The short-form reason for this issue.
189 &quot;severity&quot;: &quot;A String&quot;, # How severe this issue is to the stream.
190 &quot;type&quot;: &quot;A String&quot;, # The kind of error happening.
191 &quot;description&quot;: &quot;A String&quot;, # The long-form description of the issue and how to resolve it.
192 },
193 ],
194 &quot;lastUpdateTimeSeconds&quot;: &quot;A String&quot;, # The last time this status was updated (in seconds)
195 },
196 &quot;streamStatus&quot;: &quot;A String&quot;,
197 },
198 &quot;kind&quot;: &quot;youtube#liveStream&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#liveStream&quot;.
199 &quot;snippet&quot;: { # The snippet object contains basic details about the stream, including its channel, title, and description.
200 &quot;description&quot;: &quot;A String&quot;, # The stream&#x27;s description. The value cannot be longer than 10000 characters.
201 &quot;isDefaultStream&quot;: True or False,
202 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time that the stream was created. The value is specified in ISO 8601 format.
203 &quot;title&quot;: &quot;A String&quot;, # The stream&#x27;s title. The value must be between 1 and 128 characters long.
204 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
205 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800206 &quot;contentDetails&quot;: { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
207 &quot;isReusable&quot;: 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.
208 &quot;closedCaptionsIngestionUrl&quot;: &quot;A String&quot;, # The ingestion URL where the closed captions of this stream are sent.
209 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800210 &quot;cdn&quot;: { # Brief description of the live stream cdn settings. # The cdn object defines the live stream&#x27;s content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.
211 &quot;frameRate&quot;: &quot;A String&quot;, # The frame rate of the inbound video data.
212 &quot;resolution&quot;: &quot;A String&quot;, # The resolution of the inbound video data.
213 &quot;format&quot;: &quot;A String&quot;, # The format of the video stream that you are sending to Youtube.
214 &quot;ingestionType&quot;: &quot;A String&quot;, # The method or protocol used to transmit the video stream.
215 &quot;ingestionInfo&quot;: { # 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.
216 &quot;streamName&quot;: &quot;A String&quot;, # The HTTP or RTMP stream name that YouTube assigns to the video stream.
217 &quot;rtmpsBackupIngestionAddress&quot;: &quot;A String&quot;, # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
218 &quot;backupIngestionAddress&quot;: &quot;A String&quot;, # 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.
219 &quot;ingestionAddress&quot;: &quot;A String&quot;, # 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*
220 &quot;rtmpsIngestionAddress&quot;: &quot;A String&quot;, # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700221 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700222 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700223 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400224</div>
225
226<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800227 <code class="details" id="list">list(part, onBehalfOfContentOwner=None, mine=None, maxResults=None, id=None, pageToken=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700228 <pre>Retrieve the list of streams associated with the given channel. --
John Asmuth614db982014-04-24 15:46:26 -0400229
230Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700231 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)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700232 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request&#x27;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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800233 mine: boolean, A parameter
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800234 maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800235 id: string, Return LiveStreams with the given ids from Stubby or Apiary. (repeated)
236 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.
237 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700238 x__xgafv: string, V1 error format.
239 Allowed values
240 1 - v1 error format
241 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400242
243Returns:
244 An object of the form:
245
246 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800247 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800248 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800249 &quot;kind&quot;: &quot;youtube#liveStreamListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#liveStreamListResponse&quot;.
250 &quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
251 &quot;visitorId&quot;: &quot;A String&quot;, # The visitorId identifies the visitor.
252 &quot;tokenPagination&quot;: { # Stub token pagination template to suppress results.
253 },
254 &quot;prevPageToken&quot;: &quot;A String&quot;, # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
255 &quot;pageInfo&quot;: { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
256 &quot;resultsPerPage&quot;: 42, # The number of results included in the API response.
257 &quot;totalResults&quot;: 42, # The total number of results in the result set.
258 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700259 &quot;items&quot;: [ # A list of live streams that match the request criteria.
John Asmuth614db982014-04-24 15:46:26 -0400260 { # A live stream describes a live ingestion point.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800261 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800262 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the stream.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700263 &quot;status&quot;: { # Brief description of the live stream status. # The status object contains information about live stream&#x27;s status.
264 &quot;healthStatus&quot;: { # The health status of the stream.
265 &quot;status&quot;: &quot;A String&quot;, # The status code of this stream
266 &quot;configurationIssues&quot;: [ # The configurations issues on this stream
267 {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800268 &quot;reason&quot;: &quot;A String&quot;, # The short-form reason for this issue.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800269 &quot;severity&quot;: &quot;A String&quot;, # How severe this issue is to the stream.
270 &quot;type&quot;: &quot;A String&quot;, # The kind of error happening.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700271 &quot;description&quot;: &quot;A String&quot;, # The long-form description of the issue and how to resolve it.
272 },
273 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800274 &quot;lastUpdateTimeSeconds&quot;: &quot;A String&quot;, # The last time this status was updated (in seconds)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700275 },
276 &quot;streamStatus&quot;: &quot;A String&quot;,
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700277 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800278 &quot;kind&quot;: &quot;youtube#liveStream&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#liveStream&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800279 &quot;snippet&quot;: { # The snippet object contains basic details about the stream, including its channel, title, and description.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800280 &quot;description&quot;: &quot;A String&quot;, # The stream&#x27;s description. The value cannot be longer than 10000 characters.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800281 &quot;isDefaultStream&quot;: True or False,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800282 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time that the stream was created. The value is specified in ISO 8601 format.
283 &quot;title&quot;: &quot;A String&quot;, # The stream&#x27;s title. The value must be between 1 and 128 characters long.
284 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700285 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800286 &quot;contentDetails&quot;: { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
287 &quot;isReusable&quot;: 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.
288 &quot;closedCaptionsIngestionUrl&quot;: &quot;A String&quot;, # The ingestion URL where the closed captions of this stream are sent.
289 },
290 &quot;cdn&quot;: { # Brief description of the live stream cdn settings. # The cdn object defines the live stream&#x27;s content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.
291 &quot;frameRate&quot;: &quot;A String&quot;, # The frame rate of the inbound video data.
292 &quot;resolution&quot;: &quot;A String&quot;, # The resolution of the inbound video data.
293 &quot;format&quot;: &quot;A String&quot;, # The format of the video stream that you are sending to Youtube.
294 &quot;ingestionType&quot;: &quot;A String&quot;, # The method or protocol used to transmit the video stream.
295 &quot;ingestionInfo&quot;: { # 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.
296 &quot;streamName&quot;: &quot;A String&quot;, # The HTTP or RTMP stream name that YouTube assigns to the video stream.
297 &quot;rtmpsBackupIngestionAddress&quot;: &quot;A String&quot;, # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
298 &quot;backupIngestionAddress&quot;: &quot;A String&quot;, # 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.
299 &quot;ingestionAddress&quot;: &quot;A String&quot;, # 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*
300 &quot;rtmpsIngestionAddress&quot;: &quot;A String&quot;, # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
301 },
302 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700303 },
John Asmuth614db982014-04-24 15:46:26 -0400304 ],
John Asmuth614db982014-04-24 15:46:26 -0400305 }</pre>
306</div>
307
308<div class="method">
309 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
310 <pre>Retrieves the next page of results.
311
312Args:
313 previous_request: The request for the previous page. (required)
314 previous_response: The response from the request for the previous page. (required)
315
316Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700317 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400318 page. Returns None if there are no more items in the collection.
319 </pre>
320</div>
321
322<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800323 <code class="details" id="update">update(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700324 <pre>Updates an existing stream for the authenticated user.
John Asmuth614db982014-04-24 15:46:26 -0400325
326Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700327 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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700328 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400329 The object takes the form of:
330
331{ # A live stream describes a live ingestion point.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800332 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800333 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the stream.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700334 &quot;status&quot;: { # Brief description of the live stream status. # The status object contains information about live stream&#x27;s status.
335 &quot;healthStatus&quot;: { # The health status of the stream.
336 &quot;status&quot;: &quot;A String&quot;, # The status code of this stream
337 &quot;configurationIssues&quot;: [ # The configurations issues on this stream
338 {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800339 &quot;reason&quot;: &quot;A String&quot;, # The short-form reason for this issue.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800340 &quot;severity&quot;: &quot;A String&quot;, # How severe this issue is to the stream.
341 &quot;type&quot;: &quot;A String&quot;, # The kind of error happening.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700342 &quot;description&quot;: &quot;A String&quot;, # The long-form description of the issue and how to resolve it.
343 },
344 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800345 &quot;lastUpdateTimeSeconds&quot;: &quot;A String&quot;, # The last time this status was updated (in seconds)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700346 },
347 &quot;streamStatus&quot;: &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400348 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800349 &quot;kind&quot;: &quot;youtube#liveStream&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#liveStream&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800350 &quot;snippet&quot;: { # The snippet object contains basic details about the stream, including its channel, title, and description.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800351 &quot;description&quot;: &quot;A String&quot;, # The stream&#x27;s description. The value cannot be longer than 10000 characters.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800352 &quot;isDefaultStream&quot;: True or False,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800353 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time that the stream was created. The value is specified in ISO 8601 format.
354 &quot;title&quot;: &quot;A String&quot;, # The stream&#x27;s title. The value must be between 1 and 128 characters long.
355 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700356 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800357 &quot;contentDetails&quot;: { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
358 &quot;isReusable&quot;: 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.
359 &quot;closedCaptionsIngestionUrl&quot;: &quot;A String&quot;, # The ingestion URL where the closed captions of this stream are sent.
360 },
361 &quot;cdn&quot;: { # Brief description of the live stream cdn settings. # The cdn object defines the live stream&#x27;s content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.
362 &quot;frameRate&quot;: &quot;A String&quot;, # The frame rate of the inbound video data.
363 &quot;resolution&quot;: &quot;A String&quot;, # The resolution of the inbound video data.
364 &quot;format&quot;: &quot;A String&quot;, # The format of the video stream that you are sending to Youtube.
365 &quot;ingestionType&quot;: &quot;A String&quot;, # The method or protocol used to transmit the video stream.
366 &quot;ingestionInfo&quot;: { # 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.
367 &quot;streamName&quot;: &quot;A String&quot;, # The HTTP or RTMP stream name that YouTube assigns to the video stream.
368 &quot;rtmpsBackupIngestionAddress&quot;: &quot;A String&quot;, # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
369 &quot;backupIngestionAddress&quot;: &quot;A String&quot;, # 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.
370 &quot;ingestionAddress&quot;: &quot;A String&quot;, # 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*
371 &quot;rtmpsIngestionAddress&quot;: &quot;A String&quot;, # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
372 },
373 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700374 }
John Asmuth614db982014-04-24 15:46:26 -0400375
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700376 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800377 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request&#x27;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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700378 x__xgafv: string, V1 error format.
379 Allowed values
380 1 - v1 error format
381 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400382
383Returns:
384 An object of the form:
385
386 { # A live stream describes a live ingestion point.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800387 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800388 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the stream.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800389 &quot;status&quot;: { # Brief description of the live stream status. # The status object contains information about live stream&#x27;s status.
390 &quot;healthStatus&quot;: { # The health status of the stream.
391 &quot;status&quot;: &quot;A String&quot;, # The status code of this stream
392 &quot;configurationIssues&quot;: [ # The configurations issues on this stream
393 {
394 &quot;reason&quot;: &quot;A String&quot;, # The short-form reason for this issue.
395 &quot;severity&quot;: &quot;A String&quot;, # How severe this issue is to the stream.
396 &quot;type&quot;: &quot;A String&quot;, # The kind of error happening.
397 &quot;description&quot;: &quot;A String&quot;, # The long-form description of the issue and how to resolve it.
398 },
399 ],
400 &quot;lastUpdateTimeSeconds&quot;: &quot;A String&quot;, # The last time this status was updated (in seconds)
401 },
402 &quot;streamStatus&quot;: &quot;A String&quot;,
403 },
404 &quot;kind&quot;: &quot;youtube#liveStream&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#liveStream&quot;.
405 &quot;snippet&quot;: { # The snippet object contains basic details about the stream, including its channel, title, and description.
406 &quot;description&quot;: &quot;A String&quot;, # The stream&#x27;s description. The value cannot be longer than 10000 characters.
407 &quot;isDefaultStream&quot;: True or False,
408 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time that the stream was created. The value is specified in ISO 8601 format.
409 &quot;title&quot;: &quot;A String&quot;, # The stream&#x27;s title. The value must be between 1 and 128 characters long.
410 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
411 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800412 &quot;contentDetails&quot;: { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
413 &quot;isReusable&quot;: 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.
414 &quot;closedCaptionsIngestionUrl&quot;: &quot;A String&quot;, # The ingestion URL where the closed captions of this stream are sent.
415 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800416 &quot;cdn&quot;: { # Brief description of the live stream cdn settings. # The cdn object defines the live stream&#x27;s content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.
417 &quot;frameRate&quot;: &quot;A String&quot;, # The frame rate of the inbound video data.
418 &quot;resolution&quot;: &quot;A String&quot;, # The resolution of the inbound video data.
419 &quot;format&quot;: &quot;A String&quot;, # The format of the video stream that you are sending to Youtube.
420 &quot;ingestionType&quot;: &quot;A String&quot;, # The method or protocol used to transmit the video stream.
421 &quot;ingestionInfo&quot;: { # 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.
422 &quot;streamName&quot;: &quot;A String&quot;, # The HTTP or RTMP stream name that YouTube assigns to the video stream.
423 &quot;rtmpsBackupIngestionAddress&quot;: &quot;A String&quot;, # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
424 &quot;backupIngestionAddress&quot;: &quot;A String&quot;, # 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.
425 &quot;ingestionAddress&quot;: &quot;A String&quot;, # 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*
426 &quot;rtmpsIngestionAddress&quot;: &quot;A String&quot;, # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700427 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700428 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700429 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400430</div>
431
432</body></html>