Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8006ce8d1b6be0cd51415e008bd89177e56888b / . / docs / dyn / youtube_v3.liveStreams.html
blob: d41af60b39231fa74652562377e4a74877aa2901 [file] [log] [blame]
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500[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)</a></code></p>
79<p class="firstline">Delete a live stream.</p>
80<p class="toc_element">
81 <code><a href="#insert">insert(part, body)</a></code></p>
82<p class="firstline">Insert a YouTube live stream.</p>
83<p class="toc_element">
84 <code><a href="#list">list(part, onBehalfOf=None, pageToken=None, maxResults=None, mine=None, id=None)</a></code></p>
85<p class="firstline">Browse the YouTube live stream collection.</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)</a></code></p>
91<p class="firstline">Update a YouTube live stream.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(id)</code>
95 <pre>Delete a live stream.
96
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">
103 <code class="details" id="insert">insert(part, body)</code>
104 <pre>Insert a YouTube live stream.
105
106Args:
107 part: string, Live stream parts to include in the returned response. Valid values are: id, snippet, cdn, status. (required)
108 body: object, The request body. (required)
109 The object takes the form of:
110
111{ # A live stream describes a live ingestion point.
112 "status": { # Brief description of the live stream status. # Status of the live stream.
113 "streamStatus": "A String", # The status of the stream.
114 },
115 "kind": "youtube#liveStream", # The type of this API resource.
116 "cdn": { # Brief description of the live stream cdn settings. # Cdn settings of the live stream.
117 "ingestionType": "A String", # The live stream ingestion type. Allowed values: rtmp, http, multicast.
118 "ingestionInfo": { # Brief description of the live stream cdn settings. # Encapsulates information for ingesting an RTMP or an HTTP stream.
119 "backupIngestionAddress": "A String", # The backup address of the inbound data.
120 "streamName": "A String", # Ingestion stream name.
121 "ingestionAddress": "A String", # The address of the inbound data.
122 },
123 "multicastIngestionInfo": { # Brief description of the live stream cdn settings. # Encapsulates information for ingesting a multicast stream.
124 "multicastAddress": "A String", # The IP address of the multicast data.
125 },
126 "format": "A String", # The format of the inbound data. Allowed values: 240p, 360p, 480p, 720p, 1080p, webm_360p, multicast_qcif, multicast_240p, multicast_360p, multicast_480p, multicast_720p, multicast_1080p.
127 },
128 "snippet": { # Basic details about a live stream, including title and description. # Basic details about the live stream.
129 "channelId": "A String", # Channel publishing the live stream.
130 "description": "A String", # Description of the live stream.
131 "publishedAt": "A String", # Date and time the live stream was published at.
132 "title": "A String", # Title of the live stream.
133 },
134 "etag": "A String", # The eTag of the stream.
135 "id": "A String", # The unique id of the stream.
136 }
137
138
139Returns:
140 An object of the form:
141
142 { # A live stream describes a live ingestion point.
143 "status": { # Brief description of the live stream status. # Status of the live stream.
144 "streamStatus": "A String", # The status of the stream.
145 },
146 "kind": "youtube#liveStream", # The type of this API resource.
147 "cdn": { # Brief description of the live stream cdn settings. # Cdn settings of the live stream.
148 "ingestionType": "A String", # The live stream ingestion type. Allowed values: rtmp, http, multicast.
149 "ingestionInfo": { # Brief description of the live stream cdn settings. # Encapsulates information for ingesting an RTMP or an HTTP stream.
150 "backupIngestionAddress": "A String", # The backup address of the inbound data.
151 "streamName": "A String", # Ingestion stream name.
152 "ingestionAddress": "A String", # The address of the inbound data.
153 },
154 "multicastIngestionInfo": { # Brief description of the live stream cdn settings. # Encapsulates information for ingesting a multicast stream.
155 "multicastAddress": "A String", # The IP address of the multicast data.
156 },
157 "format": "A String", # The format of the inbound data. Allowed values: 240p, 360p, 480p, 720p, 1080p, webm_360p, multicast_qcif, multicast_240p, multicast_360p, multicast_480p, multicast_720p, multicast_1080p.
158 },
159 "snippet": { # Basic details about a live stream, including title and description. # Basic details about the live stream.
160 "channelId": "A String", # Channel publishing the live stream.
161 "description": "A String", # Description of the live stream.
162 "publishedAt": "A String", # Date and time the live stream was published at.
163 "title": "A String", # Title of the live stream.
164 },
165 "etag": "A String", # The eTag of the stream.
166 "id": "A String", # The unique id of the stream.
167 }</pre>
168</div>
169
170<div class="method">
171 <code class="details" id="list">list(part, onBehalfOf=None, pageToken=None, maxResults=None, mine=None, id=None)</code>
172 <pre>Browse the YouTube live stream collection.
173
174Args:
175 part: string, Live stream parts to include in the returned response. Valid values are: id, snippet, cdn, status. (required)
176 onBehalfOf: string, ID of the Google+ Page for the channel that the request is to be on behalf of
177 pageToken: string, Token for the page selection.
178 maxResults: integer, Maximum number of results to return
179 mine: boolean, Filter to only live streams owned by authenticated user.
180 id: string, IDs of the live streams to be returned.
181
182Returns:
183 An object of the form:
184
185 { # List of live streams.
186 "nextPageToken": "A String", # The token that can be used as the value of the {@code pageInfo} parameter to retrieve the next page in the result set.
187 "kind": "youtube#liveStreamList", # The type of this API resource.
188 "items": [ # A list of live streams that match the request criteria.
189 { # A live stream describes a live ingestion point.
190 "status": { # Brief description of the live stream status. # Status of the live stream.
191 "streamStatus": "A String", # The status of the stream.
192 },
193 "kind": "youtube#liveStream", # The type of this API resource.
194 "cdn": { # Brief description of the live stream cdn settings. # Cdn settings of the live stream.
195 "ingestionType": "A String", # The live stream ingestion type. Allowed values: rtmp, http, multicast.
196 "ingestionInfo": { # Brief description of the live stream cdn settings. # Encapsulates information for ingesting an RTMP or an HTTP stream.
197 "backupIngestionAddress": "A String", # The backup address of the inbound data.
198 "streamName": "A String", # Ingestion stream name.
199 "ingestionAddress": "A String", # The address of the inbound data.
200 },
201 "multicastIngestionInfo": { # Brief description of the live stream cdn settings. # Encapsulates information for ingesting a multicast stream.
202 "multicastAddress": "A String", # The IP address of the multicast data.
203 },
204 "format": "A String", # The format of the inbound data. Allowed values: 240p, 360p, 480p, 720p, 1080p, webm_360p, multicast_qcif, multicast_240p, multicast_360p, multicast_480p, multicast_720p, multicast_1080p.
205 },
206 "snippet": { # Basic details about a live stream, including title and description. # Basic details about the live stream.
207 "channelId": "A String", # Channel publishing the live stream.
208 "description": "A String", # Description of the live stream.
209 "publishedAt": "A String", # Date and time the live stream was published at.
210 "title": "A String", # Title of the live stream.
211 },
212 "etag": "A String", # The eTag of the stream.
213 "id": "A String", # The unique id of the stream.
214 },
215 ],
216 "etag": "A String", # The eTag of the chart.
217 "prevPageToken": "A String", # The token that can be used as the value of the {@code pageInfo} parameter to retrieve the previous page in the result set.
218 "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # The {@code pageInfo} object encapsulates paging information for the result set.
219 "totalResults": 42, # The total number of results in the result set.
220 "resultsPerPage": 42, # The number of results included in the API response.
221 },
222 }</pre>
223</div>
224
225<div class="method">
226 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
227 <pre>Retrieves the next page of results.
228
229Args:
230 previous_request: The request for the previous page. (required)
231 previous_response: The response from the request for the previous page. (required)
232
233Returns:
234 A request object that you can call 'execute()' on to request the next
235 page. Returns None if there are no more items in the collection.
236 </pre>
237</div>
238
239<div class="method">
240 <code class="details" id="update">update(part=None, body)</code>
241 <pre>Update a YouTube live stream.
242
243Args:
244 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.
245
246The part names that you can include in the parameter value are id, snippet, cdn, status. (required)
247 body: object, The request body. (required)
248 The object takes the form of:
249
250{ # A live stream describes a live ingestion point.
251 "status": { # Brief description of the live stream status. # Status of the live stream.
252 "streamStatus": "A String", # The status of the stream.
253 },
254 "kind": "youtube#liveStream", # The type of this API resource.
255 "cdn": { # Brief description of the live stream cdn settings. # Cdn settings of the live stream.
256 "ingestionType": "A String", # The live stream ingestion type. Allowed values: rtmp, http, multicast.
257 "ingestionInfo": { # Brief description of the live stream cdn settings. # Encapsulates information for ingesting an RTMP or an HTTP stream.
258 "backupIngestionAddress": "A String", # The backup address of the inbound data.
259 "streamName": "A String", # Ingestion stream name.
260 "ingestionAddress": "A String", # The address of the inbound data.
261 },
262 "multicastIngestionInfo": { # Brief description of the live stream cdn settings. # Encapsulates information for ingesting a multicast stream.
263 "multicastAddress": "A String", # The IP address of the multicast data.
264 },
265 "format": "A String", # The format of the inbound data. Allowed values: 240p, 360p, 480p, 720p, 1080p, webm_360p, multicast_qcif, multicast_240p, multicast_360p, multicast_480p, multicast_720p, multicast_1080p.
266 },
267 "snippet": { # Basic details about a live stream, including title and description. # Basic details about the live stream.
268 "channelId": "A String", # Channel publishing the live stream.
269 "description": "A String", # Description of the live stream.
270 "publishedAt": "A String", # Date and time the live stream was published at.
271 "title": "A String", # Title of the live stream.
272 },
273 "etag": "A String", # The eTag of the stream.
274 "id": "A String", # The unique id of the stream.
275 }
276
277
278Returns:
279 An object of the form:
280
281 { # A live stream describes a live ingestion point.
282 "status": { # Brief description of the live stream status. # Status of the live stream.
283 "streamStatus": "A String", # The status of the stream.
284 },
285 "kind": "youtube#liveStream", # The type of this API resource.
286 "cdn": { # Brief description of the live stream cdn settings. # Cdn settings of the live stream.
287 "ingestionType": "A String", # The live stream ingestion type. Allowed values: rtmp, http, multicast.
288 "ingestionInfo": { # Brief description of the live stream cdn settings. # Encapsulates information for ingesting an RTMP or an HTTP stream.
289 "backupIngestionAddress": "A String", # The backup address of the inbound data.
290 "streamName": "A String", # Ingestion stream name.
291 "ingestionAddress": "A String", # The address of the inbound data.
292 },
293 "multicastIngestionInfo": { # Brief description of the live stream cdn settings. # Encapsulates information for ingesting a multicast stream.
294 "multicastAddress": "A String", # The IP address of the multicast data.
295 },
296 "format": "A String", # The format of the inbound data. Allowed values: 240p, 360p, 480p, 720p, 1080p, webm_360p, multicast_qcif, multicast_240p, multicast_360p, multicast_480p, multicast_720p, multicast_1080p.
297 },
298 "snippet": { # Basic details about a live stream, including title and description. # Basic details about the live stream.
299 "channelId": "A String", # Channel publishing the live stream.
300 "description": "A String", # Description of the live stream.
301 "publishedAt": "A String", # Date and time the live stream was published at.
302 "title": "A String", # Title of the live stream.
303 },
304 "etag": "A String", # The eTag of the stream.
305 "id": "A String", # The unique id of the stream.
306 }</pre>
307</div>
308
309</body></html>