blob: 245f0faadf5ce293aa5fbb995338335a9dd89487 [file] [log] [blame]
Joe Gregoriob8006ce2013-03-07 10:33:19 -05001<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)</a></code></p>
Joe Gregorio37802c32013-08-06 12:24:05 -040079<p class="firstline">Deletes a video stream.</p>
Joe Gregoriob8006ce2013-03-07 10:33:19 -050080<p class="toc_element">
Joe Gregorio37802c32013-08-06 12:24:05 -040081 <code><a href="#insert">insert(part=None, body)</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>
Joe Gregoriob8006ce2013-03-07 10:33:19 -050083<p class="toc_element">
Joe Gregorio37802c32013-08-06 12:24:05 -040084 <code><a href="#list">list(part, pageToken=None, mine=None, maxResults=None, id=None)</a></code></p>
85<p class="firstline">Returns a list of video streams that match the API request parameters.</p>
Joe Gregoriob8006ce2013-03-07 10:33:19 -050086<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)</a></code></p>
Joe Gregorio37802c32013-08-06 12:24:05 -040091<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>
Joe Gregoriob8006ce2013-03-07 10:33:19 -050092<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(id)</code>
Joe Gregorio37802c32013-08-06 12:24:05 -040095 <pre>Deletes a video stream.
Joe Gregoriob8006ce2013-03-07 10:33:19 -050096
97Args:
98 id: string, The id parameter specifies the YouTube live stream ID for the resource that is being deleted. (required)
99</pre>
100</div>
101
102<div class="method">
Joe Gregorio37802c32013-08-06 12:24:05 -0400103 <code class="details" id="insert">insert(part=None, body)</code>
104 <pre>Creates a video stream. The stream enables you to send your video to YouTube, which can then broadcast the video to your audience.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500105
106Args:
Joe Gregorio37802c32013-08-06 12:24:05 -0400107 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.
108
109The part properties that you can include in the parameter value are id, snippet, cdn, and status. (required)
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500110 body: object, The request body. (required)
111 The object takes the form of:
112
113{ # A live stream describes a live ingestion point.
Joe Gregorio37802c32013-08-06 12:24:05 -0400114 "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
115 "streamStatus": "A String",
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500116 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400117 "kind": "youtube#liveStream", # The kind, fixed to "youtube#liveStream".
118 "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
119 "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
120 },
121 "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.
122 "ingestionType": "A String", # The method or protocol used to transmit the video stream.
123 "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.
124 "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.
125 "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
126 "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.
127 #
128 # 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:
129 #
130 # STREAM_URL/STREAM_NAME
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500131 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400132 "format": "A String", # The format of the video stream that you are sending to Youtube.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500133 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400134 "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
135 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
136 "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
137 "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.
138 "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500139 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400140 "etag": "A String", # Etag of this resource.
141 "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500142 }
143
144
145Returns:
146 An object of the form:
147
148 { # A live stream describes a live ingestion point.
Joe Gregorio37802c32013-08-06 12:24:05 -0400149 "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
150 "streamStatus": "A String",
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500151 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400152 "kind": "youtube#liveStream", # The kind, fixed to "youtube#liveStream".
153 "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
154 "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
155 },
156 "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.
157 "ingestionType": "A String", # The method or protocol used to transmit the video stream.
158 "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.
159 "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.
160 "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
161 "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.
162 #
163 # 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:
164 #
165 # STREAM_URL/STREAM_NAME
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500166 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400167 "format": "A String", # The format of the video stream that you are sending to Youtube.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500168 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400169 "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
170 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
171 "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
172 "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.
173 "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500174 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400175 "etag": "A String", # Etag of this resource.
176 "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500177 }</pre>
178</div>
179
180<div class="method">
Joe Gregorio37802c32013-08-06 12:24:05 -0400181 <code class="details" id="list">list(part, pageToken=None, mine=None, maxResults=None, id=None)</code>
182 <pre>Returns a list of video streams that match the API request parameters.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500183
184Args:
Joe Gregorio37802c32013-08-06 12:24:05 -0400185 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)
186 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.
187 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.
188 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.
189 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.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500190
191Returns:
192 An object of the form:
193
194 { # List of live streams.
Joe Gregorio37802c32013-08-06 12:24:05 -0400195 "eventId": "A String", # Serialized EventId of the request which produced this response.
196 "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.
197 "kind": "youtube#liveStreamList", # The type of the API response. For this operation, the value will be youtube#liveStreamList.
198 "visitorId": "A String", # The visitorId identifies the visitor.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500199 "items": [ # A list of live streams that match the request criteria.
200 { # A live stream describes a live ingestion point.
Joe Gregorio37802c32013-08-06 12:24:05 -0400201 "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
202 "streamStatus": "A String",
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500203 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400204 "kind": "youtube#liveStream", # The kind, fixed to "youtube#liveStream".
205 "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
206 "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
207 },
208 "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.
209 "ingestionType": "A String", # The method or protocol used to transmit the video stream.
210 "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.
211 "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.
212 "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
213 "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.
214 #
215 # 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:
216 #
217 # STREAM_URL/STREAM_NAME
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500218 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400219 "format": "A String", # The format of the video stream that you are sending to Youtube.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500220 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400221 "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
222 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
223 "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
224 "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.
225 "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500226 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400227 "etag": "A String", # Etag of this resource.
228 "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500229 },
230 ],
Joe Gregorio37802c32013-08-06 12:24:05 -0400231 "etag": "A String", # The ETag of the response.
232 "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.
233 "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # The pageInfo object encapsulates paging information for the result set.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500234 "totalResults": 42, # The total number of results in the result set.
235 "resultsPerPage": 42, # The number of results included in the API response.
236 },
237 }</pre>
238</div>
239
240<div class="method">
241 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
242 <pre>Retrieves the next page of results.
243
244Args:
245 previous_request: The request for the previous page. (required)
246 previous_response: The response from the request for the previous page. (required)
247
248Returns:
249 A request object that you can call 'execute()' on to request the next
250 page. Returns None if there are no more items in the collection.
251 </pre>
252</div>
253
254<div class="method">
255 <code class="details" id="update">update(part=None, body)</code>
Joe Gregorio37802c32013-08-06 12:24:05 -0400256 <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.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500257
258Args:
259 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.
260
Joe Gregorio37802c32013-08-06 12:24:05 -0400261The part properties that you can include in the parameter value are id, snippet, cdn, and status.
262
263Note 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)
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500264 body: object, The request body. (required)
265 The object takes the form of:
266
267{ # A live stream describes a live ingestion point.
Joe Gregorio37802c32013-08-06 12:24:05 -0400268 "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
269 "streamStatus": "A String",
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500270 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400271 "kind": "youtube#liveStream", # The kind, fixed to "youtube#liveStream".
272 "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
273 "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
274 },
275 "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.
276 "ingestionType": "A String", # The method or protocol used to transmit the video stream.
277 "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.
278 "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.
279 "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
280 "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.
281 #
282 # 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:
283 #
284 # STREAM_URL/STREAM_NAME
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500285 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400286 "format": "A String", # The format of the video stream that you are sending to Youtube.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500287 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400288 "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
289 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
290 "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
291 "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.
292 "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500293 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400294 "etag": "A String", # Etag of this resource.
295 "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500296 }
297
298
299Returns:
300 An object of the form:
301
302 { # A live stream describes a live ingestion point.
Joe Gregorio37802c32013-08-06 12:24:05 -0400303 "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
304 "streamStatus": "A String",
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500305 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400306 "kind": "youtube#liveStream", # The kind, fixed to "youtube#liveStream".
307 "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
308 "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
309 },
310 "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.
311 "ingestionType": "A String", # The method or protocol used to transmit the video stream.
312 "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.
313 "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.
314 "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
315 "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.
316 #
317 # 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:
318 #
319 # STREAM_URL/STREAM_NAME
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500320 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400321 "format": "A String", # The format of the video stream that you are sending to Youtube.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500322 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400323 "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
324 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
325 "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
326 "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.
327 "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500328 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400329 "etag": "A String", # Etag of this resource.
330 "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500331 }</pre>
332</div>
333
334</body></html>