Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d60d1e7de700af0037eab545b5d8ab1fcb014775 / . / docs / dyn / youtube_v3.liveBroadcasts.html
blob: b7957f232c579028b65542482d78f30fab2d3b29 [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.liveBroadcasts.html">liveBroadcasts</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#bind">bind(id, part, streamId=None)</a></code></p>
79<p class="firstline">Bind a YouTube live broadcast to a stream.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(id)</a></code></p>
82<p class="firstline">Delete a YouTube live broadcast.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(part, body)</a></code></p>
85<p class="firstline">Insert a YouTube live broadcast.</p>
86<p class="toc_element">
87 <code><a href="#list">list(part, broadcastStatus=None, onBehalfOf=None, pageToken=None, maxResults=None, mine=None, id=None)</a></code></p>
88<p class="firstline">Browse the YouTube broadcast collection.</p>
89<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">
93 <code><a href="#transition">transition(broadcastStatus, id, part)</a></code></p>
94<p class="firstline">Change the broadcasting status of a YouTube live broadcast and start all the processes associated with it.</p>
95<p class="toc_element">
96 <code><a href="#update">update(part=None, body)</a></code></p>
97<p class="firstline">Update a YouTube live broadcast.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="bind">bind(id, part, streamId=None)</code>
101 <pre>Bind a YouTube live broadcast to a stream.
102
103Args:
104 id: string, ID of the broadcast to which the stream will be bound (required)
105 part: string, Live broadcast parts to be returned in the response. Valid values are: id, snippet, status, slateSettings, contentDetails. (required)
106 streamId: string, ID of the stream to bind to the broadcast
107
108Returns:
109 An object of the form:
110
111 { # A live broadcast describes live event configuration.
112 "status": { # The status of a live broadcast. # The status of the live broadcast.
113 "privacyStatus": "A String", # Privacy settings of the live broadcast. Allowed values: private, unlisted, public.
114 "lifeCycleStatus": "A String", # Life status of the live broadcast.
115 },
116 "kind": "youtube#liveBroadcast", # The type of this API resource.
117 "contentDetails": { # Slate settings of a broadcast. # The content details of the live broadcast.
118 "enableArchive": True or False, # Whether the live event will be archived or not.
119 "boundStreamId": "A String", # The id of the stream bound to the broadcast.
120 "startWithSlateCuepoint": True or False, # Automatically start with a slate cuepoint.
121 "enableEmbed": True or False, # Whether to allow the broadcast to be played in an embedded player.
122 "enableContentEncryption": True or False, # Whether to enable or disable content encryption.
123 "enableDvr": True or False, # Whether the dvr (digital video recording) is enabled or not.
124 "monitorStream": { # Information about the monitor stream which helps the broadcaster to review the event content before shown to the public.
125 "broadcastStreamDelayMs": 42, # If enableMonitorStream is true, the public broadcast will be delayed by this value.
126 "embedHtml": "A String", # The html code of the embedded player for the monitor stream.
127 "enableMonitorStream": True or False, # Whether to enable the monitor stream for the broadcast.
128 },
129 },
130 "slateSettings": { # Slate settings of a broadcast. # The slate settings of the live broadcast.
131 "slates": { # Broadcast slates.
132 "a_key": { # Locale code indicating in which region should the slate be displayed.
133 "backgroundUrl": "A String", # Url of the background image.
134 "textLines": [ # Multi-line message showing in the slate.
135 "A String",
136 ],
137 },
138 },
139 "enableSlates": True or False, # Whether slate is enabled or not.
140 },
141 "snippet": { # Basic details about a live broadcast, including title, description and thumbnails. # Basic details about the live broadcast.
142 "actualEndTime": "A String", # Date and time the broadcast is actual to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
143 "description": "A String", # Description of the broadcast.
144 "title": "A String", # Title of the broadcast.
145 "channelId": "A String", # Channel publishing the broadcast.
146 "publishedAt": "A String", # Date and time the broadcast was published at. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
147 "scheduledStartTime": "A String", # Date and time the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
148 "actualStartTime": "A String", # Date and time the broadcast is actual to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
149 "scheduledEndTime": "A String", # Date and time the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
150 "thumbnails": { # Video thumbnails.
151 "a_key": { # A thumbnail is an image representing a YouTube resource. # A map of thumbnails by their name.
152 "url": "A String", # The thumbnail image's URL.
153 "width": 42, # (Optional) Width of the thumbnail image.
154 "height": 42, # (Optional) Height of the thumbnail image.
155 },
156 },
157 },
158 "etag": "A String", # The eTag of the broadcast.
159 "id": "A String", # The unique id of the broadcast.
160 }</pre>
161</div>
162
163<div class="method">
164 <code class="details" id="delete">delete(id)</code>
165 <pre>Delete a YouTube live broadcast.
166
167Args:
168 id: string, The id parameter specifies the YouTube live broadcast ID for the resource that is being deleted. (required)
169</pre>
170</div>
171
172<div class="method">
173 <code class="details" id="insert">insert(part, body)</code>
174 <pre>Insert a YouTube live broadcast.
175
176Args:
177 part: string, Live broadcast parts to be set for the broadcast as well as included in the returned response. Valid values are: snippet, status, slateSettings, contentDetails. (required)
178 body: object, The request body. (required)
179 The object takes the form of:
180
181{ # A live broadcast describes live event configuration.
182 "status": { # The status of a live broadcast. # The status of the live broadcast.
183 "privacyStatus": "A String", # Privacy settings of the live broadcast. Allowed values: private, unlisted, public.
184 "lifeCycleStatus": "A String", # Life status of the live broadcast.
185 },
186 "kind": "youtube#liveBroadcast", # The type of this API resource.
187 "contentDetails": { # Slate settings of a broadcast. # The content details of the live broadcast.
188 "enableArchive": True or False, # Whether the live event will be archived or not.
189 "boundStreamId": "A String", # The id of the stream bound to the broadcast.
190 "startWithSlateCuepoint": True or False, # Automatically start with a slate cuepoint.
191 "enableEmbed": True or False, # Whether to allow the broadcast to be played in an embedded player.
192 "enableContentEncryption": True or False, # Whether to enable or disable content encryption.
193 "enableDvr": True or False, # Whether the dvr (digital video recording) is enabled or not.
194 "monitorStream": { # Information about the monitor stream which helps the broadcaster to review the event content before shown to the public.
195 "broadcastStreamDelayMs": 42, # If enableMonitorStream is true, the public broadcast will be delayed by this value.
196 "embedHtml": "A String", # The html code of the embedded player for the monitor stream.
197 "enableMonitorStream": True or False, # Whether to enable the monitor stream for the broadcast.
198 },
199 },
200 "slateSettings": { # Slate settings of a broadcast. # The slate settings of the live broadcast.
201 "slates": { # Broadcast slates.
202 "a_key": { # Locale code indicating in which region should the slate be displayed.
203 "backgroundUrl": "A String", # Url of the background image.
204 "textLines": [ # Multi-line message showing in the slate.
205 "A String",
206 ],
207 },
208 },
209 "enableSlates": True or False, # Whether slate is enabled or not.
210 },
211 "snippet": { # Basic details about a live broadcast, including title, description and thumbnails. # Basic details about the live broadcast.
212 "actualEndTime": "A String", # Date and time the broadcast is actual to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
213 "description": "A String", # Description of the broadcast.
214 "title": "A String", # Title of the broadcast.
215 "channelId": "A String", # Channel publishing the broadcast.
216 "publishedAt": "A String", # Date and time the broadcast was published at. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
217 "scheduledStartTime": "A String", # Date and time the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
218 "actualStartTime": "A String", # Date and time the broadcast is actual to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
219 "scheduledEndTime": "A String", # Date and time the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
220 "thumbnails": { # Video thumbnails.
221 "a_key": { # A thumbnail is an image representing a YouTube resource. # A map of thumbnails by their name.
222 "url": "A String", # The thumbnail image's URL.
223 "width": 42, # (Optional) Width of the thumbnail image.
224 "height": 42, # (Optional) Height of the thumbnail image.
225 },
226 },
227 },
228 "etag": "A String", # The eTag of the broadcast.
229 "id": "A String", # The unique id of the broadcast.
230 }
231
232
233Returns:
234 An object of the form:
235
236 { # A live broadcast describes live event configuration.
237 "status": { # The status of a live broadcast. # The status of the live broadcast.
238 "privacyStatus": "A String", # Privacy settings of the live broadcast. Allowed values: private, unlisted, public.
239 "lifeCycleStatus": "A String", # Life status of the live broadcast.
240 },
241 "kind": "youtube#liveBroadcast", # The type of this API resource.
242 "contentDetails": { # Slate settings of a broadcast. # The content details of the live broadcast.
243 "enableArchive": True or False, # Whether the live event will be archived or not.
244 "boundStreamId": "A String", # The id of the stream bound to the broadcast.
245 "startWithSlateCuepoint": True or False, # Automatically start with a slate cuepoint.
246 "enableEmbed": True or False, # Whether to allow the broadcast to be played in an embedded player.
247 "enableContentEncryption": True or False, # Whether to enable or disable content encryption.
248 "enableDvr": True or False, # Whether the dvr (digital video recording) is enabled or not.
249 "monitorStream": { # Information about the monitor stream which helps the broadcaster to review the event content before shown to the public.
250 "broadcastStreamDelayMs": 42, # If enableMonitorStream is true, the public broadcast will be delayed by this value.
251 "embedHtml": "A String", # The html code of the embedded player for the monitor stream.
252 "enableMonitorStream": True or False, # Whether to enable the monitor stream for the broadcast.
253 },
254 },
255 "slateSettings": { # Slate settings of a broadcast. # The slate settings of the live broadcast.
256 "slates": { # Broadcast slates.
257 "a_key": { # Locale code indicating in which region should the slate be displayed.
258 "backgroundUrl": "A String", # Url of the background image.
259 "textLines": [ # Multi-line message showing in the slate.
260 "A String",
261 ],
262 },
263 },
264 "enableSlates": True or False, # Whether slate is enabled or not.
265 },
266 "snippet": { # Basic details about a live broadcast, including title, description and thumbnails. # Basic details about the live broadcast.
267 "actualEndTime": "A String", # Date and time the broadcast is actual to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
268 "description": "A String", # Description of the broadcast.
269 "title": "A String", # Title of the broadcast.
270 "channelId": "A String", # Channel publishing the broadcast.
271 "publishedAt": "A String", # Date and time the broadcast was published at. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
272 "scheduledStartTime": "A String", # Date and time the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
273 "actualStartTime": "A String", # Date and time the broadcast is actual to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
274 "scheduledEndTime": "A String", # Date and time the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
275 "thumbnails": { # Video thumbnails.
276 "a_key": { # A thumbnail is an image representing a YouTube resource. # A map of thumbnails by their name.
277 "url": "A String", # The thumbnail image's URL.
278 "width": 42, # (Optional) Width of the thumbnail image.
279 "height": 42, # (Optional) Height of the thumbnail image.
280 },
281 },
282 },
283 "etag": "A String", # The eTag of the broadcast.
284 "id": "A String", # The unique id of the broadcast.
285 }</pre>
286</div>
287
288<div class="method">
289 <code class="details" id="list">list(part, broadcastStatus=None, onBehalfOf=None, pageToken=None, maxResults=None, mine=None, id=None)</code>
290 <pre>Browse the YouTube broadcast collection.
291
292Args:
293 part: string, Live broadcast parts to include in the returned response. Valid values are: id, snippet, status, slateSettings, contentDetails. (required)
294 broadcastStatus: string, Filter to only return broadcasts with the given status by the authenticated user.
295 Allowed values
296 active - Return active broadcasts.
297 all - Return all the broadcasts.
298 completed - Return previously completed broadcasts.
299 upcoming - Return upcoming broadcasts.
300 onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
301 pageToken: string, Token for the page selection.
302 maxResults: integer, Maximum number of results to return
303 mine: boolean, Filter to only return broadcasts owned by authenticated user.
304 id: string, IDs of the live broadcasts to be returned.
305
306Returns:
307 An object of the form:
308
309 { # JSON template for list of broadcasts.
310 "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.
311 "kind": "youtube#liveBroadcastList", # The type of this API resource.
312 "items": [ # A list of broadcasts that match the request criteria.
313 { # A live broadcast describes live event configuration.
314 "status": { # The status of a live broadcast. # The status of the live broadcast.
315 "privacyStatus": "A String", # Privacy settings of the live broadcast. Allowed values: private, unlisted, public.
316 "lifeCycleStatus": "A String", # Life status of the live broadcast.
317 },
318 "kind": "youtube#liveBroadcast", # The type of this API resource.
319 "contentDetails": { # Slate settings of a broadcast. # The content details of the live broadcast.
320 "enableArchive": True or False, # Whether the live event will be archived or not.
321 "boundStreamId": "A String", # The id of the stream bound to the broadcast.
322 "startWithSlateCuepoint": True or False, # Automatically start with a slate cuepoint.
323 "enableEmbed": True or False, # Whether to allow the broadcast to be played in an embedded player.
324 "enableContentEncryption": True or False, # Whether to enable or disable content encryption.
325 "enableDvr": True or False, # Whether the dvr (digital video recording) is enabled or not.
326 "monitorStream": { # Information about the monitor stream which helps the broadcaster to review the event content before shown to the public.
327 "broadcastStreamDelayMs": 42, # If enableMonitorStream is true, the public broadcast will be delayed by this value.
328 "embedHtml": "A String", # The html code of the embedded player for the monitor stream.
329 "enableMonitorStream": True or False, # Whether to enable the monitor stream for the broadcast.
330 },
331 },
332 "slateSettings": { # Slate settings of a broadcast. # The slate settings of the live broadcast.
333 "slates": { # Broadcast slates.
334 "a_key": { # Locale code indicating in which region should the slate be displayed.
335 "backgroundUrl": "A String", # Url of the background image.
336 "textLines": [ # Multi-line message showing in the slate.
337 "A String",
338 ],
339 },
340 },
341 "enableSlates": True or False, # Whether slate is enabled or not.
342 },
343 "snippet": { # Basic details about a live broadcast, including title, description and thumbnails. # Basic details about the live broadcast.
344 "actualEndTime": "A String", # Date and time the broadcast is actual to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
345 "description": "A String", # Description of the broadcast.
346 "title": "A String", # Title of the broadcast.
347 "channelId": "A String", # Channel publishing the broadcast.
348 "publishedAt": "A String", # Date and time the broadcast was published at. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
349 "scheduledStartTime": "A String", # Date and time the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
350 "actualStartTime": "A String", # Date and time the broadcast is actual to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
351 "scheduledEndTime": "A String", # Date and time the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
352 "thumbnails": { # Video thumbnails.
353 "a_key": { # A thumbnail is an image representing a YouTube resource. # A map of thumbnails by their name.
354 "url": "A String", # The thumbnail image's URL.
355 "width": 42, # (Optional) Width of the thumbnail image.
356 "height": 42, # (Optional) Height of the thumbnail image.
357 },
358 },
359 },
360 "etag": "A String", # The eTag of the broadcast.
361 "id": "A String", # The unique id of the broadcast.
362 },
363 ],
364 "etag": "A String", # The eTag of the chart.
365 "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.
366 "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.
367 "totalResults": 42, # The total number of results in the result set.
368 "resultsPerPage": 42, # The number of results included in the API response.
369 },
370 }</pre>
371</div>
372
373<div class="method">
374 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
375 <pre>Retrieves the next page of results.
376
377Args:
378 previous_request: The request for the previous page. (required)
379 previous_response: The response from the request for the previous page. (required)
380
381Returns:
382 A request object that you can call 'execute()' on to request the next
383 page. Returns None if there are no more items in the collection.
384 </pre>
385</div>
386
387<div class="method">
388 <code class="details" id="transition">transition(broadcastStatus, id, part)</code>
389 <pre>Change the broadcasting status of a YouTube live broadcast and start all the processes associated with it.
390
391Args:
392 broadcastStatus: string, Desired broadcast status. (required)
393 Allowed values
394 complete - Stop broadcasting.
395 live - Start broadcasting.
396 testing - Start broadcast testing.
397 id: string, ID of the broadcast to change status (required)
398 part: string, Live broadcast parts to be returned in the response. Valid values are: id, snippet, status, slateSettings, contentDetails. (required)
399
400Returns:
401 An object of the form:
402
403 { # A live broadcast describes live event configuration.
404 "status": { # The status of a live broadcast. # The status of the live broadcast.
405 "privacyStatus": "A String", # Privacy settings of the live broadcast. Allowed values: private, unlisted, public.
406 "lifeCycleStatus": "A String", # Life status of the live broadcast.
407 },
408 "kind": "youtube#liveBroadcast", # The type of this API resource.
409 "contentDetails": { # Slate settings of a broadcast. # The content details of the live broadcast.
410 "enableArchive": True or False, # Whether the live event will be archived or not.
411 "boundStreamId": "A String", # The id of the stream bound to the broadcast.
412 "startWithSlateCuepoint": True or False, # Automatically start with a slate cuepoint.
413 "enableEmbed": True or False, # Whether to allow the broadcast to be played in an embedded player.
414 "enableContentEncryption": True or False, # Whether to enable or disable content encryption.
415 "enableDvr": True or False, # Whether the dvr (digital video recording) is enabled or not.
416 "monitorStream": { # Information about the monitor stream which helps the broadcaster to review the event content before shown to the public.
417 "broadcastStreamDelayMs": 42, # If enableMonitorStream is true, the public broadcast will be delayed by this value.
418 "embedHtml": "A String", # The html code of the embedded player for the monitor stream.
419 "enableMonitorStream": True or False, # Whether to enable the monitor stream for the broadcast.
420 },
421 },
422 "slateSettings": { # Slate settings of a broadcast. # The slate settings of the live broadcast.
423 "slates": { # Broadcast slates.
424 "a_key": { # Locale code indicating in which region should the slate be displayed.
425 "backgroundUrl": "A String", # Url of the background image.
426 "textLines": [ # Multi-line message showing in the slate.
427 "A String",
428 ],
429 },
430 },
431 "enableSlates": True or False, # Whether slate is enabled or not.
432 },
433 "snippet": { # Basic details about a live broadcast, including title, description and thumbnails. # Basic details about the live broadcast.
434 "actualEndTime": "A String", # Date and time the broadcast is actual to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
435 "description": "A String", # Description of the broadcast.
436 "title": "A String", # Title of the broadcast.
437 "channelId": "A String", # Channel publishing the broadcast.
438 "publishedAt": "A String", # Date and time the broadcast was published at. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
439 "scheduledStartTime": "A String", # Date and time the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
440 "actualStartTime": "A String", # Date and time the broadcast is actual to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
441 "scheduledEndTime": "A String", # Date and time the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
442 "thumbnails": { # Video thumbnails.
443 "a_key": { # A thumbnail is an image representing a YouTube resource. # A map of thumbnails by their name.
444 "url": "A String", # The thumbnail image's URL.
445 "width": 42, # (Optional) Width of the thumbnail image.
446 "height": 42, # (Optional) Height of the thumbnail image.
447 },
448 },
449 },
450 "etag": "A String", # The eTag of the broadcast.
451 "id": "A String", # The unique id of the broadcast.
452 }</pre>
453</div>
454
455<div class="method">
456 <code class="details" id="update">update(part=None, body)</code>
457 <pre>Update a YouTube live broadcast.
458
459Args:
460 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.
461
462The part names that you can include in the parameter value are id, snippet, status, slateSettings, contentDetails. (required)
463 body: object, The request body. (required)
464 The object takes the form of:
465
466{ # A live broadcast describes live event configuration.
467 "status": { # The status of a live broadcast. # The status of the live broadcast.
468 "privacyStatus": "A String", # Privacy settings of the live broadcast. Allowed values: private, unlisted, public.
469 "lifeCycleStatus": "A String", # Life status of the live broadcast.
470 },
471 "kind": "youtube#liveBroadcast", # The type of this API resource.
472 "contentDetails": { # Slate settings of a broadcast. # The content details of the live broadcast.
473 "enableArchive": True or False, # Whether the live event will be archived or not.
474 "boundStreamId": "A String", # The id of the stream bound to the broadcast.
475 "startWithSlateCuepoint": True or False, # Automatically start with a slate cuepoint.
476 "enableEmbed": True or False, # Whether to allow the broadcast to be played in an embedded player.
477 "enableContentEncryption": True or False, # Whether to enable or disable content encryption.
478 "enableDvr": True or False, # Whether the dvr (digital video recording) is enabled or not.
479 "monitorStream": { # Information about the monitor stream which helps the broadcaster to review the event content before shown to the public.
480 "broadcastStreamDelayMs": 42, # If enableMonitorStream is true, the public broadcast will be delayed by this value.
481 "embedHtml": "A String", # The html code of the embedded player for the monitor stream.
482 "enableMonitorStream": True or False, # Whether to enable the monitor stream for the broadcast.
483 },
484 },
485 "slateSettings": { # Slate settings of a broadcast. # The slate settings of the live broadcast.
486 "slates": { # Broadcast slates.
487 "a_key": { # Locale code indicating in which region should the slate be displayed.
488 "backgroundUrl": "A String", # Url of the background image.
489 "textLines": [ # Multi-line message showing in the slate.
490 "A String",
491 ],
492 },
493 },
494 "enableSlates": True or False, # Whether slate is enabled or not.
495 },
496 "snippet": { # Basic details about a live broadcast, including title, description and thumbnails. # Basic details about the live broadcast.
497 "actualEndTime": "A String", # Date and time the broadcast is actual to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
498 "description": "A String", # Description of the broadcast.
499 "title": "A String", # Title of the broadcast.
500 "channelId": "A String", # Channel publishing the broadcast.
501 "publishedAt": "A String", # Date and time the broadcast was published at. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
502 "scheduledStartTime": "A String", # Date and time the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
503 "actualStartTime": "A String", # Date and time the broadcast is actual to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
504 "scheduledEndTime": "A String", # Date and time the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
505 "thumbnails": { # Video thumbnails.
506 "a_key": { # A thumbnail is an image representing a YouTube resource. # A map of thumbnails by their name.
507 "url": "A String", # The thumbnail image's URL.
508 "width": 42, # (Optional) Width of the thumbnail image.
509 "height": 42, # (Optional) Height of the thumbnail image.
510 },
511 },
512 },
513 "etag": "A String", # The eTag of the broadcast.
514 "id": "A String", # The unique id of the broadcast.
515 }
516
517
518Returns:
519 An object of the form:
520
521 { # A live broadcast describes live event configuration.
522 "status": { # The status of a live broadcast. # The status of the live broadcast.
523 "privacyStatus": "A String", # Privacy settings of the live broadcast. Allowed values: private, unlisted, public.
524 "lifeCycleStatus": "A String", # Life status of the live broadcast.
525 },
526 "kind": "youtube#liveBroadcast", # The type of this API resource.
527 "contentDetails": { # Slate settings of a broadcast. # The content details of the live broadcast.
528 "enableArchive": True or False, # Whether the live event will be archived or not.
529 "boundStreamId": "A String", # The id of the stream bound to the broadcast.
530 "startWithSlateCuepoint": True or False, # Automatically start with a slate cuepoint.
531 "enableEmbed": True or False, # Whether to allow the broadcast to be played in an embedded player.
532 "enableContentEncryption": True or False, # Whether to enable or disable content encryption.
533 "enableDvr": True or False, # Whether the dvr (digital video recording) is enabled or not.
534 "monitorStream": { # Information about the monitor stream which helps the broadcaster to review the event content before shown to the public.
535 "broadcastStreamDelayMs": 42, # If enableMonitorStream is true, the public broadcast will be delayed by this value.
536 "embedHtml": "A String", # The html code of the embedded player for the monitor stream.
537 "enableMonitorStream": True or False, # Whether to enable the monitor stream for the broadcast.
538 },
539 },
540 "slateSettings": { # Slate settings of a broadcast. # The slate settings of the live broadcast.
541 "slates": { # Broadcast slates.
542 "a_key": { # Locale code indicating in which region should the slate be displayed.
543 "backgroundUrl": "A String", # Url of the background image.
544 "textLines": [ # Multi-line message showing in the slate.
545 "A String",
546 ],
547 },
548 },
549 "enableSlates": True or False, # Whether slate is enabled or not.
550 },
551 "snippet": { # Basic details about a live broadcast, including title, description and thumbnails. # Basic details about the live broadcast.
552 "actualEndTime": "A String", # Date and time the broadcast is actual to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
553 "description": "A String", # Description of the broadcast.
554 "title": "A String", # Title of the broadcast.
555 "channelId": "A String", # Channel publishing the broadcast.
556 "publishedAt": "A String", # Date and time the broadcast was published at. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
557 "scheduledStartTime": "A String", # Date and time the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
558 "actualStartTime": "A String", # Date and time the broadcast is actual to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
559 "scheduledEndTime": "A String", # Date and time the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
560 "thumbnails": { # Video thumbnails.
561 "a_key": { # A thumbnail is an image representing a YouTube resource. # A map of thumbnails by their name.
562 "url": "A String", # The thumbnail image's URL.
563 "width": 42, # (Optional) Width of the thumbnail image.
564 "height": 42, # (Optional) Height of the thumbnail image.
565 },
566 },
567 },
568 "etag": "A String", # The eTag of the broadcast.
569 "id": "A String", # The unique id of the broadcast.
570 }</pre>
571</div>
572
573</body></html>