Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / youtube_v3.liveStreams.html
blob: faeb3fd1a76f46a3d022d8ac989b8b881786fe06 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame^]1<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
75<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.liveStreams.html">liveStreams</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</a></code></p>
79<p class="firstline">Deletes a video stream.</p>
80<p class="toc_element">
81 <code><a href="#insert">insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</a></code></p>
82<p class="firstline">Creates a video stream. The stream enables you to send your video to YouTube, which can then broadcast the video to your audience.</p>
83<p class="toc_element">
84 <code><a href="#list">list(part, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, maxResults=None, mine=None, id=None)</a></code></p>
85<p class="firstline">Returns a list of video streams that match the API request parameters.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
90 <code><a href="#update">update(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</a></code></p>
91<p class="firstline">Updates a video stream. If the properties that you want to change cannot be updated, then you need to create a new stream with the proper settings.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
95 <pre>Deletes a video stream.
96
97Args:
98 id: string, The id parameter specifies the YouTube live stream ID for the resource that is being deleted. (required)
99 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
100
101The 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.
102 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
103
104The 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.
105
106This 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.
107</pre>
108</div>
109
110<div class="method">
111 <code class="details" id="insert">insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
112 <pre>Creates a video stream. The stream enables you to send your video to YouTube, which can then broadcast the video to your audience.
113
114Args:
115 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.
116
117The part properties that you can include in the parameter value are id, snippet, cdn, and status. (required)
118 body: object, The request body. (required)
119 The object takes the form of:
120
121{ # A live stream describes a live ingestion point.
122 "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
123 "streamStatus": "A String",
124 },
125 "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
126 "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
127 "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
128 },
129 "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.
130 "ingestionType": "A String", # The method or protocol used to transmit the video stream.
131 "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.
132 "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.
133 "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
134 "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.
135 #
136 # 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:
137 #
138 # STREAM_URL/STREAM_NAME
139 },
140 "format": "A String", # The format of the video stream that you are sending to Youtube.
141 },
142 "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
143 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
144 "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
145 "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
146 "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
147 },
148 "etag": "A String", # Etag of this resource.
149 "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
150 }
151
152 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
153
154The 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.
155 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
156
157The 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.
158
159This 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.
160
161Returns:
162 An object of the form:
163
164 { # A live stream describes a live ingestion point.
165 "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
166 "streamStatus": "A String",
167 },
168 "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
169 "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
170 "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
171 },
172 "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.
173 "ingestionType": "A String", # The method or protocol used to transmit the video stream.
174 "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.
175 "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.
176 "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
177 "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.
178 #
179 # 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:
180 #
181 # STREAM_URL/STREAM_NAME
182 },
183 "format": "A String", # The format of the video stream that you are sending to Youtube.
184 },
185 "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
186 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
187 "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
188 "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
189 "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
190 },
191 "etag": "A String", # Etag of this resource.
192 "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
193 }</pre>
194</div>
195
196<div class="method">
197 <code class="details" id="list">list(part, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, maxResults=None, mine=None, id=None)</code>
198 <pre>Returns a list of video streams that match the API request parameters.
199
200Args:
201 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)
202 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
203
204The 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.
205 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.
206 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
207
208The 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.
209
210This 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.
211 maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set. Acceptable values are 0 to 50, inclusive. The default value is 5.
212 mine: boolean, The mine parameter can be used to instruct the API to only return streams owned by the authenticated user. Set the parameter value to true to only retrieve your own streams.
213 id: string, The id parameter specifies a comma-separated list of YouTube stream IDs that identify the streams being retrieved. In a liveStream resource, the id property specifies the stream's ID.
214
215Returns:
216 An object of the form:
217
218 {
219 "eventId": "A String", # Serialized EventId of the request which produced this response.
220 "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.
221 "kind": "youtube#liveStreamListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStreamListResponse".
222 "visitorId": "A String", # The visitorId identifies the visitor.
223 "items": [ # A list of live streams that match the request criteria.
224 { # A live stream describes a live ingestion point.
225 "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
226 "streamStatus": "A String",
227 },
228 "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
229 "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
230 "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
231 },
232 "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.
233 "ingestionType": "A String", # The method or protocol used to transmit the video stream.
234 "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.
235 "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.
236 "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
237 "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.
238 #
239 # 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:
240 #
241 # STREAM_URL/STREAM_NAME
242 },
243 "format": "A String", # The format of the video stream that you are sending to Youtube.
244 },
245 "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
246 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
247 "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
248 "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
249 "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
250 },
251 "etag": "A String", # Etag of this resource.
252 "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
253 },
254 ],
255 "tokenPagination": { # Stub token pagination template to suppress results.
256 },
257 "etag": "A String", # Etag of this resource.
258 "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.
259 "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
260 "totalResults": 42, # The total number of results in the result set.
261 "resultsPerPage": 42, # The number of results included in the API response.
262 },
263 }</pre>
264</div>
265
266<div class="method">
267 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
268 <pre>Retrieves the next page of results.
269
270Args:
271 previous_request: The request for the previous page. (required)
272 previous_response: The response from the request for the previous page. (required)
273
274Returns:
275 A request object that you can call 'execute()' on to request the next
276 page. Returns None if there are no more items in the collection.
277 </pre>
278</div>
279
280<div class="method">
281 <code class="details" id="update">update(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
282 <pre>Updates a video stream. If the properties that you want to change cannot be updated, then you need to create a new stream with the proper settings.
283
284Args:
285 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.
286
287The part properties that you can include in the parameter value are id, snippet, cdn, and status.
288
289Note 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)
290 body: object, The request body. (required)
291 The object takes the form of:
292
293{ # A live stream describes a live ingestion point.
294 "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
295 "streamStatus": "A String",
296 },
297 "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
298 "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
299 "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
300 },
301 "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.
302 "ingestionType": "A String", # The method or protocol used to transmit the video stream.
303 "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.
304 "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.
305 "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
306 "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.
307 #
308 # 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:
309 #
310 # STREAM_URL/STREAM_NAME
311 },
312 "format": "A String", # The format of the video stream that you are sending to Youtube.
313 },
314 "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
315 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
316 "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
317 "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
318 "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
319 },
320 "etag": "A String", # Etag of this resource.
321 "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
322 }
323
324 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
325
326The 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.
327 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
328
329The 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.
330
331This 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.
332
333Returns:
334 An object of the form:
335
336 { # A live stream describes a live ingestion point.
337 "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
338 "streamStatus": "A String",
339 },
340 "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".
341 "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
342 "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
343 },
344 "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.
345 "ingestionType": "A String", # The method or protocol used to transmit the video stream.
346 "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.
347 "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.
348 "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
349 "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.
350 #
351 # 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:
352 #
353 # STREAM_URL/STREAM_NAME
354 },
355 "format": "A String", # The format of the video stream that you are sending to Youtube.
356 },
357 "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
358 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
359 "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
360 "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
361 "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
362 },
363 "etag": "A String", # Etag of this resource.
364 "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
365 }</pre>
366</div>
367
368</body></html>