1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.liveBroadcasts.html">liveBroadcasts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#bind">bind(id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, streamId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Bind a broadcast to a stream.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a given broadcast.</p>
<p class="toc_element">
<code><a href="#insert">insert(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new stream for the authenticated user.</p>
<p class="toc_element">
<code><a href="#insertCuepoint">insertCuepoint(body=None, id=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, part=None, x__xgafv=None)</a></code></p>
<p class="firstline">Insert cuepoints in a broadcast</p>
<p class="toc_element">
<code><a href="#list">list(part, broadcastStatus=None, broadcastType=None, id=None, maxResults=None, mine=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieve the list of broadcasts associated with the given channel.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#transition">transition(broadcastStatus, id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p>
<p class="firstline">Transition a broadcast to a given status.</p>
<p class="toc_element">
<code><a href="#update">update(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing broadcast for the authenticated user.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="bind">bind(id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, streamId=None, x__xgafv=None)</code>
<pre>Bind a broadcast to a stream.
Args:
id: string, Broadcast to bind to the stream (required)
part: string, The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status. (required) (repeated)
onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *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.
onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
streamId: string, Stream to bind, if not set unbind the current one.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A *liveBroadcast* resource represents an event that will be streamed, via live video, on YouTube.
"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
"boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.
"closedCaptionsType": "A String",
"enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.
"enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.
"enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
"enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. *Important:* You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.
"enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
"enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
"latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.
"mesh": "A String", # The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags.
"monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.
"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
"enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. *Note:* This property cannot be updated once the broadcast is in the testing or live state.
},
"projection": "A String", # The projection format of this broadcast. This defaults to rectangular.
"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. *Important:* You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.
"startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
"stereoLayout": "A String", # The 3D stereo layout of this broadcast. This defaults to mono.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
"monetizationDetails": { # Monetization settings of a broadcast. # The monetizationDetails object contains information about the event's monetization details.
"cuepointSchedule": { # Schedule to insert cuepoints into a broadcast by ads automator.
"enabled": True or False, # This field is semantically required. If it is set false or not set, other fields in this message will be ignored.
"pauseAdsUntil": "A String", # If set, automatic cuepoint insertion is paused until this timestamp ("No Ad Zone"). The value is specified in ISO 8601 format.
"repeatIntervalSecs": 42, # Interval frequency in seconds that api uses to insert cuepoints automatically.
"scheduleStrategy": "A String", # The strategy to use when scheduling cuepoints.
},
},
"snippet": { # Basic broadcast information. # The snippet object contains basic details about the event, including its title, description, start time, and end time.
"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete.
"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live.
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
"description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
"isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. Internal only.
"liveChatId": "A String", # The id of the live chat for this broadcast.
"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule.
"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end.
"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start.
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
},
"title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
},
"statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
"concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
},
"status": { # Live broadcast state. # The status object contains information about the event's status.
"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
"madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only.
"privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
"recordingStatus": "A String", # The broadcast's recording status.
"selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work.
},
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code>
<pre>Delete a given broadcast.
Args:
id: string, Broadcast to delete. (required)
onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *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.
onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code>
<pre>Inserts a new stream for the authenticated user.
Args:
part: string, The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, contentDetails, and status. (required) (repeated)
body: object, The request body.
The object takes the form of:
{ # A *liveBroadcast* resource represents an event that will be streamed, via live video, on YouTube.
"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
"boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.
"closedCaptionsType": "A String",
"enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.
"enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.
"enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
"enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. *Important:* You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.
"enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
"enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
"latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.
"mesh": "A String", # The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags.
"monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.
"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
"enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. *Note:* This property cannot be updated once the broadcast is in the testing or live state.
},
"projection": "A String", # The projection format of this broadcast. This defaults to rectangular.
"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. *Important:* You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.
"startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
"stereoLayout": "A String", # The 3D stereo layout of this broadcast. This defaults to mono.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
"monetizationDetails": { # Monetization settings of a broadcast. # The monetizationDetails object contains information about the event's monetization details.
"cuepointSchedule": { # Schedule to insert cuepoints into a broadcast by ads automator.
"enabled": True or False, # This field is semantically required. If it is set false or not set, other fields in this message will be ignored.
"pauseAdsUntil": "A String", # If set, automatic cuepoint insertion is paused until this timestamp ("No Ad Zone"). The value is specified in ISO 8601 format.
"repeatIntervalSecs": 42, # Interval frequency in seconds that api uses to insert cuepoints automatically.
"scheduleStrategy": "A String", # The strategy to use when scheduling cuepoints.
},
},
"snippet": { # Basic broadcast information. # The snippet object contains basic details about the event, including its title, description, start time, and end time.
"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete.
"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live.
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
"description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
"isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. Internal only.
"liveChatId": "A String", # The id of the live chat for this broadcast.
"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule.
"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end.
"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start.
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
},
"title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
},
"statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
"concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
},
"status": { # Live broadcast state. # The status object contains information about the event's status.
"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
"madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only.
"privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
"recordingStatus": "A String", # The broadcast's recording status.
"selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work.
},
}
onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *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.
onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A *liveBroadcast* resource represents an event that will be streamed, via live video, on YouTube.
"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
"boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.
"closedCaptionsType": "A String",
"enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.
"enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.
"enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
"enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. *Important:* You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.
"enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
"enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
"latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.
"mesh": "A String", # The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags.
"monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.
"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
"enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. *Note:* This property cannot be updated once the broadcast is in the testing or live state.
},
"projection": "A String", # The projection format of this broadcast. This defaults to rectangular.
"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. *Important:* You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.
"startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
"stereoLayout": "A String", # The 3D stereo layout of this broadcast. This defaults to mono.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
"monetizationDetails": { # Monetization settings of a broadcast. # The monetizationDetails object contains information about the event's monetization details.
"cuepointSchedule": { # Schedule to insert cuepoints into a broadcast by ads automator.
"enabled": True or False, # This field is semantically required. If it is set false or not set, other fields in this message will be ignored.
"pauseAdsUntil": "A String", # If set, automatic cuepoint insertion is paused until this timestamp ("No Ad Zone"). The value is specified in ISO 8601 format.
"repeatIntervalSecs": 42, # Interval frequency in seconds that api uses to insert cuepoints automatically.
"scheduleStrategy": "A String", # The strategy to use when scheduling cuepoints.
},
},
"snippet": { # Basic broadcast information. # The snippet object contains basic details about the event, including its title, description, start time, and end time.
"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete.
"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live.
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
"description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
"isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. Internal only.
"liveChatId": "A String", # The id of the live chat for this broadcast.
"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule.
"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end.
"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start.
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
},
"title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
},
"statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
"concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
},
"status": { # Live broadcast state. # The status object contains information about the event's status.
"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
"madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only.
"privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
"recordingStatus": "A String", # The broadcast's recording status.
"selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work.
},
}</pre>
</div>
<div class="method">
<code class="details" id="insertCuepoint">insertCuepoint(body=None, id=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, part=None, x__xgafv=None)</code>
<pre>Insert cuepoints in a broadcast
Args:
body: object, The request body.
The object takes the form of:
{ # Note that there may be a 5-second end-point resolution issue. For instance, if a cuepoint comes in for 22:03:27, we may stuff the cuepoint into 22:03:25 or 22:03:30, depending. This is an artifact of HLS.
"cueType": "A String",
"durationSecs": 42, # The duration of this cuepoint.
"etag": "A String",
"id": "A String", # The identifier for cuepoint resource.
"insertionOffsetTimeMs": "A String", # The time when the cuepoint should be inserted by offset to the broadcast actual start time.
"walltimeMs": "A String", # The wall clock time at which the cuepoint should be inserted. Only one of insertion_offset_time_ms and walltime_ms may be set at a time.
}
id: string, Broadcast to insert ads to, or equivalently `external_video_id` for internal use.
onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *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.
onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
part: string, The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status. (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Note that there may be a 5-second end-point resolution issue. For instance, if a cuepoint comes in for 22:03:27, we may stuff the cuepoint into 22:03:25 or 22:03:30, depending. This is an artifact of HLS.
"cueType": "A String",
"durationSecs": 42, # The duration of this cuepoint.
"etag": "A String",
"id": "A String", # The identifier for cuepoint resource.
"insertionOffsetTimeMs": "A String", # The time when the cuepoint should be inserted by offset to the broadcast actual start time.
"walltimeMs": "A String", # The wall clock time at which the cuepoint should be inserted. Only one of insertion_offset_time_ms and walltime_ms may be set at a time.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(part, broadcastStatus=None, broadcastType=None, id=None, maxResults=None, mine=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, pageToken=None, x__xgafv=None)</code>
<pre>Retrieve the list of broadcasts associated with the given channel.
Args:
part: string, The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, status and statistics. (required) (repeated)
broadcastStatus: string, Return broadcasts with a certain status, e.g. active broadcasts.
Allowed values
broadcastStatusFilterUnspecified -
all - Return all broadcasts.
active - Return current live broadcasts.
upcoming - Return broadcasts that have not yet started.
completed - Return broadcasts that have already ended.
broadcastType: string, Return only broadcasts with the selected type.
Allowed values
broadcastTypeFilterUnspecified -
all - Return all broadcasts.
event - Return only scheduled event broadcasts.
persistent - Return only persistent broadcasts.
id: string, Return broadcasts with the given ids from Stubby or Apiary. (repeated)
maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
mine: boolean, A parameter
onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *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.
onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"etag": "A String", # Etag of this resource.
"eventId": "A String", # Serialized EventId of the request which produced this response.
"items": [ # A list of broadcasts that match the request criteria.
{ # A *liveBroadcast* resource represents an event that will be streamed, via live video, on YouTube.
"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
"boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.
"closedCaptionsType": "A String",
"enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.
"enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.
"enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
"enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. *Important:* You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.
"enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
"enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
"latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.
"mesh": "A String", # The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags.
"monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.
"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
"enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. *Note:* This property cannot be updated once the broadcast is in the testing or live state.
},
"projection": "A String", # The projection format of this broadcast. This defaults to rectangular.
"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. *Important:* You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.
"startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
"stereoLayout": "A String", # The 3D stereo layout of this broadcast. This defaults to mono.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
"monetizationDetails": { # Monetization settings of a broadcast. # The monetizationDetails object contains information about the event's monetization details.
"cuepointSchedule": { # Schedule to insert cuepoints into a broadcast by ads automator.
"enabled": True or False, # This field is semantically required. If it is set false or not set, other fields in this message will be ignored.
"pauseAdsUntil": "A String", # If set, automatic cuepoint insertion is paused until this timestamp ("No Ad Zone"). The value is specified in ISO 8601 format.
"repeatIntervalSecs": 42, # Interval frequency in seconds that api uses to insert cuepoints automatically.
"scheduleStrategy": "A String", # The strategy to use when scheduling cuepoints.
},
},
"snippet": { # Basic broadcast information. # The snippet object contains basic details about the event, including its title, description, start time, and end time.
"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete.
"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live.
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
"description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
"isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. Internal only.
"liveChatId": "A String", # The id of the live chat for this broadcast.
"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule.
"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end.
"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start.
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
},
"title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
},
"statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
"concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
},
"status": { # Live broadcast state. # The status object contains information about the event's status.
"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
"madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only.
"privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
"recordingStatus": "A String", # The broadcast's recording status.
"selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work.
},
},
],
"kind": "youtube#liveBroadcastListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcastListResponse".
"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.
"pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # General pagination information.
"resultsPerPage": 42, # The number of results included in the API response.
"totalResults": 42, # The total number of results in the result set.
},
"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.
"tokenPagination": { # Stub token pagination template to suppress results.
},
"visitorId": "A String", # The visitorId identifies the visitor.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="transition">transition(broadcastStatus, id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code>
<pre>Transition a broadcast to a given status.
Args:
broadcastStatus: string, The status to which the broadcast is going to transition. (required)
Allowed values
statusUnspecified -
testing - Start testing the broadcast. YouTube transmits video to the broadcast's monitor stream. Note that you can only transition a broadcast to the testing state if its contentDetails.monitorStream.enableMonitorStream property is set to true.",
live - Return only persistent broadcasts.
complete - The broadcast is over. YouTube stops transmitting video.
id: string, Broadcast to transition. (required)
part: string, The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status. (required) (repeated)
onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *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.
onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A *liveBroadcast* resource represents an event that will be streamed, via live video, on YouTube.
"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
"boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.
"closedCaptionsType": "A String",
"enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.
"enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.
"enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
"enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. *Important:* You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.
"enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
"enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
"latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.
"mesh": "A String", # The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags.
"monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.
"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
"enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. *Note:* This property cannot be updated once the broadcast is in the testing or live state.
},
"projection": "A String", # The projection format of this broadcast. This defaults to rectangular.
"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. *Important:* You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.
"startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
"stereoLayout": "A String", # The 3D stereo layout of this broadcast. This defaults to mono.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
"monetizationDetails": { # Monetization settings of a broadcast. # The monetizationDetails object contains information about the event's monetization details.
"cuepointSchedule": { # Schedule to insert cuepoints into a broadcast by ads automator.
"enabled": True or False, # This field is semantically required. If it is set false or not set, other fields in this message will be ignored.
"pauseAdsUntil": "A String", # If set, automatic cuepoint insertion is paused until this timestamp ("No Ad Zone"). The value is specified in ISO 8601 format.
"repeatIntervalSecs": 42, # Interval frequency in seconds that api uses to insert cuepoints automatically.
"scheduleStrategy": "A String", # The strategy to use when scheduling cuepoints.
},
},
"snippet": { # Basic broadcast information. # The snippet object contains basic details about the event, including its title, description, start time, and end time.
"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete.
"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live.
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
"description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
"isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. Internal only.
"liveChatId": "A String", # The id of the live chat for this broadcast.
"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule.
"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end.
"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start.
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
},
"title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
},
"statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
"concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
},
"status": { # Live broadcast state. # The status object contains information about the event's status.
"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
"madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only.
"privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
"recordingStatus": "A String", # The broadcast's recording status.
"selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work.
},
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code>
<pre>Updates an existing broadcast for the authenticated user.
Args:
part: string, The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, contentDetails, and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a broadcast's privacy status is defined in the status part. As such, if your request is updating a private or unlisted broadcast, and the request's part parameter value includes the status part, the broadcast's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the broadcast will revert to the default privacy setting. (required) (repeated)
body: object, The request body.
The object takes the form of:
{ # A *liveBroadcast* resource represents an event that will be streamed, via live video, on YouTube.
"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
"boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.
"closedCaptionsType": "A String",
"enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.
"enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.
"enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
"enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. *Important:* You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.
"enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
"enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
"latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.
"mesh": "A String", # The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags.
"monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.
"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
"enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. *Note:* This property cannot be updated once the broadcast is in the testing or live state.
},
"projection": "A String", # The projection format of this broadcast. This defaults to rectangular.
"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. *Important:* You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.
"startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
"stereoLayout": "A String", # The 3D stereo layout of this broadcast. This defaults to mono.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
"monetizationDetails": { # Monetization settings of a broadcast. # The monetizationDetails object contains information about the event's monetization details.
"cuepointSchedule": { # Schedule to insert cuepoints into a broadcast by ads automator.
"enabled": True or False, # This field is semantically required. If it is set false or not set, other fields in this message will be ignored.
"pauseAdsUntil": "A String", # If set, automatic cuepoint insertion is paused until this timestamp ("No Ad Zone"). The value is specified in ISO 8601 format.
"repeatIntervalSecs": 42, # Interval frequency in seconds that api uses to insert cuepoints automatically.
"scheduleStrategy": "A String", # The strategy to use when scheduling cuepoints.
},
},
"snippet": { # Basic broadcast information. # The snippet object contains basic details about the event, including its title, description, start time, and end time.
"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete.
"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live.
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
"description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
"isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. Internal only.
"liveChatId": "A String", # The id of the live chat for this broadcast.
"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule.
"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end.
"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start.
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
},
"title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
},
"statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
"concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
},
"status": { # Live broadcast state. # The status object contains information about the event's status.
"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
"madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only.
"privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
"recordingStatus": "A String", # The broadcast's recording status.
"selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work.
},
}
onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *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.
onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A *liveBroadcast* resource represents an event that will be streamed, via live video, on YouTube.
"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
"boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.
"closedCaptionsType": "A String",
"enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.
"enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.
"enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
"enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. *Important:* You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.
"enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
"enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
"latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.
"mesh": "A String", # The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags.
"monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.
"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
"enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. *Note:* This property cannot be updated once the broadcast is in the testing or live state.
},
"projection": "A String", # The projection format of this broadcast. This defaults to rectangular.
"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. *Important:* You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.
"startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
"stereoLayout": "A String", # The 3D stereo layout of this broadcast. This defaults to mono.
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
"monetizationDetails": { # Monetization settings of a broadcast. # The monetizationDetails object contains information about the event's monetization details.
"cuepointSchedule": { # Schedule to insert cuepoints into a broadcast by ads automator.
"enabled": True or False, # This field is semantically required. If it is set false or not set, other fields in this message will be ignored.
"pauseAdsUntil": "A String", # If set, automatic cuepoint insertion is paused until this timestamp ("No Ad Zone"). The value is specified in ISO 8601 format.
"repeatIntervalSecs": 42, # Interval frequency in seconds that api uses to insert cuepoints automatically.
"scheduleStrategy": "A String", # The strategy to use when scheduling cuepoints.
},
},
"snippet": { # Basic broadcast information. # The snippet object contains basic details about the event, including its title, description, start time, and end time.
"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete.
"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live.
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
"description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
"isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. Internal only.
"liveChatId": "A String", # The id of the live chat for this broadcast.
"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule.
"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end.
"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start.
"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
},
"title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
},
"statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
"concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
},
"status": { # Live broadcast state. # The status object contains information about the event's status.
"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
"madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only.
"privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
"recordingStatus": "A String", # The broadcast's recording status.
"selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work.
},
}</pre>
</div>
</body></html>
|