| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 75 | <h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.liveBroadcasts.html">liveBroadcasts</a></h1> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 78 | <code><a href="#bind">bind(id, part, onBehalfOfContentOwnerChannel=None, streamId=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Bind a broadcast to a stream.</p> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 80 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 81 | <code><a href="#control">control(id, part, onBehalfOfContentOwner=None, offsetTimeMs=None, displaySlate=None, walltime=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Slate and recording control of the live broadcast.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 83 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 84 | <code><a href="#delete">delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Delete a given broadcast.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 86 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 87 | <code><a href="#insert">insert(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Inserts a new stream for the authenticated user.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 89 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 90 | <code><a href="#list">list(part, pageToken=None, broadcastType=None, maxResults=None, broadcastStatus=None, mine=None, onBehalfOfContentOwnerChannel=None, id=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Retrieve the list of broadcasts associated with the given channel.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 96 | <code><a href="#transition">transition(id, broadcastStatus, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p> |
| 97 | <p class="firstline">Transition a broadcast to a given status.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 98 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 99 | <code><a href="#update">update(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p> |
| 100 | <p class="firstline">Updates an existing broadcast for the authenticated user.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 101 | <h3>Method Details</h3> |
| 102 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 103 | <code class="details" id="bind">bind(id, part, onBehalfOfContentOwnerChannel=None, streamId=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| 104 | <pre>Bind a broadcast to a stream. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 105 | |
| 106 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 107 | id: string, Broadcast to bind to the stream (required) |
| 108 | part: string, The <code><strong>part</strong></code> parameter specifies a |
| 109 | comma-separated list of one or more <code>liveBroadcast</code> resource |
| 110 | properties that the API response will include. The <code>part</code> names |
| 111 | that you can include in the parameter value are <code>id</code>, |
| 112 | <code>snippet</code>, <code>contentDetails</code>, and <code>status</code>. (required) (repeated) |
| 113 | onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| 114 | href="/youtube/v3/guides/authentication">authorized request</a>. |
| 115 | <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 116 | content partners.<br><br>The |
| 117 | <code><strong>onBehalfOfContentOwnerChannel</strong></code> parameter |
| 118 | specifies the YouTube channel ID of the channel to which a video is being |
| 119 | added. This parameter is required when a request specifies a value for the |
| 120 | <code>onBehalfOfContentOwner</code> parameter, and it can only be used in |
| 121 | conjunction with that parameter. In addition, the request must be |
| 122 | authorized using a CMS account that is linked to the content owner that the |
| 123 | <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| 124 | channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| 125 | specifies must be linked to the content owner that the |
| 126 | <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>This |
| 127 | parameter is intended for YouTube content partners that own and manage many |
| 128 | different YouTube channels. It allows content owners to authenticate once |
| 129 | and perform actions on behalf of the channel specified in the parameter |
| 130 | value, without having to provide authentication credentials for each |
| 131 | separate channel. |
| 132 | streamId: string, Stream to bind, if not set unbind the current one. |
| 133 | onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 134 | content partners.<br><br>The |
| 135 | <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| 136 | that the |
| 137 | request's authorization credentials identify a YouTube CMS user who is |
| 138 | acting on behalf of the content owner specified in the parameter value. |
| 139 | This parameter is intended for YouTube content partners that own and manage |
| 140 | many different YouTube channels. It allows content owners to authenticate |
| 141 | once and get access to all their video and channel data, without having to |
| 142 | provide authentication credentials for each individual channel. The CMS |
| 143 | account that the user authenticates with must be linked to the specified |
| 144 | YouTube content owner. |
| 145 | x__xgafv: string, V1 error format. |
| 146 | Allowed values |
| 147 | 1 - v1 error format |
| 148 | 2 - v2 error format |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 149 | |
| 150 | Returns: |
| 151 | An object of the form: |
| 152 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 153 | { # A <code><strong>liveBroadcast</strong></code> resource represents an event |
| 154 | # that will be streamed, via live video, on YouTube. |
| 155 | "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast. |
| 156 | "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values # The <code>statistics</code> object contains info about the event's current |
| 157 | # stats. These include concurrent viewers and total chat count. Statistics |
| 158 | # can change (in either direction) during the lifetime of an event. |
| 159 | # Statistics are only returned while the event is live. |
| 160 | # at the time of the request. Statistics are only returned for live broadcasts. |
| 161 | "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The |
| 162 | # property and its value will be present if the broadcast is public, has |
| 163 | # the live chat feature enabled, and has at least one message. Note that |
| 164 | # this field will not be filled after the broadcast ends. So this property |
| 165 | # would not identify the number of chat messages for an archived video of a |
| 166 | # completed live broadcast. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 167 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 168 | "etag": "A String", # Etag of this resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 169 | "snippet": { # Basic broadcast information. # The <code>snippet</code> object contains basic details about the event, |
| 170 | # including its title, description, start time, and end time. |
| 171 | "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value |
| 172 | # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 173 | # format. |
| 174 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| 175 | # is publishing the broadcast. |
| 176 | "description": "A String", # The broadcast's description. As with the <code>title</code>, you can set |
| 177 | # this field by modifying the broadcast resource or by setting the |
| 178 | # <code><a |
| 179 | # href="/youtube/v3/docs/videos#snippet.description">description</a></code> |
| 180 | # field of the corresponding video resource. |
| 181 | "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one |
| 182 | # YouTube video. You can set this field by modifying the broadcast resource |
| 183 | # or by setting the |
| 184 | # <code><a href="/youtube/v3/docs/videos#snippet.title">title</a></code> |
| 185 | # field of the corresponding video resource. |
| 186 | "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast |
| 187 | # schedule. The value is specified in |
| 188 | # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 189 | # format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 190 | "liveChatId": "A String", # The id of the live chat for this broadcast. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 191 | "isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. |
| 192 | # Internal only. |
| 193 | "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is |
| 194 | # only available once the broadcast's state is <code>complete</code>. The |
| 195 | # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 196 | # format. |
| 197 | "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value |
| 198 | # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 199 | # format. |
| 200 | "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is |
| 201 | # only available once the broadcast's state is <code>live</code>. The |
| 202 | # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 203 | # format. |
| 204 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested |
| 205 | # object in this object, the key is the name of the thumbnail image, and |
| 206 | # the value is an object that contains other information about the |
| 207 | # thumbnail. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 208 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 209 | "width": 42, # (Optional) Width of the thumbnail image. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 210 | "url": "A String", # The thumbnail image's URL. |
| 211 | "height": 42, # (Optional) Height of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 212 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 213 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 214 | "width": 42, # (Optional) Width of the thumbnail image. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 215 | "url": "A String", # The thumbnail image's URL. |
| 216 | "height": 42, # (Optional) Height of the thumbnail image. |
| 217 | }, |
| 218 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 219 | "width": 42, # (Optional) Width of the thumbnail image. |
| 220 | "url": "A String", # The thumbnail image's URL. |
| 221 | "height": 42, # (Optional) Height of the thumbnail image. |
| 222 | }, |
| 223 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 224 | "width": 42, # (Optional) Width of the thumbnail image. |
| 225 | "url": "A String", # The thumbnail image's URL. |
| 226 | "height": 42, # (Optional) Height of the thumbnail image. |
| 227 | }, |
| 228 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 229 | "width": 42, # (Optional) Width of the thumbnail image. |
| 230 | "url": "A String", # The thumbnail image's URL. |
| 231 | "height": 42, # (Optional) Height of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 232 | }, |
| 233 | }, |
| 234 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 235 | "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string |
| 236 | # <code>"youtube#liveBroadcast"</code>. |
| 237 | "contentDetails": { # Detailed settings of a broadcast. # The <code>contentDetails</code> object contains information about the |
| 238 | # event's video content, such as whether the content can be shown in an |
| 239 | # embedded video player or if it will be archived and therefore available |
| 240 | # for viewing after the event has concluded. |
| 241 | "boundStreamId": "A String", # This value uniquely identifies the |
| 242 | # <code><a href="/youtube/v3/live/docs/liveStreams">live stream</a></code> |
| 243 | # bound to the broadcast. |
| 244 | "closedCaptionsType": "A String", |
| 245 | "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin |
| 246 | # with an <a |
| 247 | # href="/youtube/v3/live/getting-started#Displaying_Slates">in-stream |
| 248 | # slate</a> when you update the broadcast's status to <code>live</code>. |
| 249 | # After updating the status, you then need to send a |
| 250 | # <code><a |
| 251 | # href="/youtube/v3/live/docs/liveCuepoints/insert">liveCuepoints.insert</a></code> |
| 252 | # request that sets the cuepoint's <code>eventState</code> to |
| 253 | # <code>end</code> to remove the in-stream slate and make your broadcast |
| 254 | # stream visible to viewers. |
| 255 | "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by |
| 256 | # <code>boundStreamId</code> was last updated. |
| 257 | "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while |
| 258 | # watching the video. DVR controls enable the viewer to control the video |
| 259 | # playback experience by pausing, rewinding, or fast forwarding content. |
| 260 | # The default value for this property is <code>true</code>.<br><br> |
| 261 | # |
| 262 | # <strong>Important:</strong> You must set the value to <code>true</code> |
| 263 | # and also set the <code>enableArchive</code> property's value to |
| 264 | # <code>true</code> if you want to make playback available immediately |
| 265 | # after the broadcast ends. |
| 266 | "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an |
| 267 | # embedded player. If you choose to archive the video (using the |
| 268 | # <code>enableArchive</code> property), this setting will also apply to |
| 269 | # the archived video. |
| 270 | "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for |
| 271 | # this broadcast. The ingestion URL of the closed captions is returned |
| 272 | # through the liveStreams API. This is mutually exclusive with using the |
| 273 | # <code>closed_captions_type</code> property, and is equivalent to setting |
| 274 | # <code>closed_captions_type</code> to CLOSED_CAPTIONS_HTTP_POST. |
| 275 | "recordFromStart": True or False, # Automatically start recording after the event goes live. |
| 276 | # The default value for this property is <code>true</code>.<br><br> |
| 277 | # |
| 278 | # <strong>Important:</strong> You must also set the <code>enableDvr</code> |
| 279 | # property's value to |
| 280 | # <code>true</code> if you want the playback to be available immediately |
| 281 | # after the broadcast ends. If you set this property's value to |
| 282 | # <code>true</code> but do not also set the <code>enableDvr</code> property |
| 283 | # to <code>true</code>, there may be a delay of around one day before the |
| 284 | # archived video will be available for playback. |
| 285 | "monitorStream": { # Settings and Info of the monitor stream # The <code>monitorStream</code> object contains information about the |
| 286 | # monitor stream, which the broadcaster can use to review the event |
| 287 | # content before the broadcast stream is shown publicly. |
| 288 | "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream. |
| 289 | "broadcastStreamDelayMs": 42, # If you have set the |
| 290 | # <code><a href="#enableMonitorStream">enableMonitorStream</a></code> |
| 291 | # property to <code>true</code>, then this property determines the |
| 292 | # length of the live broadcast delay. |
| 293 | "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the |
| 294 | # broadcast. If the monitor stream is enabled, then YouTube will |
| 295 | # broadcast the event content on a special stream intended only for |
| 296 | # the broadcaster's consumption. The broadcaster can use the stream |
| 297 | # to review the event content and also to identify the optimal times |
| 298 | # to insert cuepoints.<br><br> |
| 299 | # You need to set this value to <code>true</code> if you intend to have |
| 300 | # a broadcast delay for your event.<br><br> |
| 301 | # <strong>Note:</strong> This property cannot be updated once the |
| 302 | # broadcast is in the <code>testing</code> or <code>live</code> state. |
| 303 | }, |
| 304 | "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption |
| 305 | # for the broadcast. |
| 306 | "enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. |
| 307 | # The default value for this property is <code>false</code>.<br><br> |
| 308 | # This setting can only be used by Events. |
| 309 | "latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. |
| 310 | # LATENCY_NORMAL should match enable_low_latency=false |
| 311 | # LATENCY_LOW should match enable_low_latency=true |
| 312 | # LATENCY_ULTRA_LOW should have enable_low_latency omitted. |
| 313 | "projection": "A String", # The projection format of this broadcast. This defaults to |
| 314 | # <code>rectangular</code>. |
| 315 | "mesh": "A String", # The mesh for projecting the video if <code>projection</code> is |
| 316 | # <code>mesh</code>. The mesh value must be a UTF-8 string containing the |
| 317 | # base-64 encoding of 3D mesh data that follows the <a |
| 318 | # href="https://github.com/google/spatial-media/blob/master/docs/spherical-video-v2-rfc.md"> |
| 319 | # Spherical Video V2 RFC specification</a> for an mshp box, excluding the box |
| 320 | # size and type but including the following four reserved zero bytes for the |
| 321 | # version and flags. |
| 322 | "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. |
| 323 | "enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. |
| 324 | # The default value for this property is <code>false</code>.<br><br> |
| 325 | # This setting can only be used by Events. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 326 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 327 | "status": { # Live broadcast state. # The <code>status</code> object contains information about the event's |
| 328 | # status. |
| 329 | "selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be |
| 330 | # kids only: go/live-cw-work. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 331 | "recordingStatus": "A String", # The broadcast's recording status. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 332 | "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents |
| 333 | # exactly one YouTube video, so the privacy settings are identical to |
| 334 | # those supported for videos. In addition, you can set this field by |
| 335 | # modifying the broadcast resource or by setting the |
| 336 | # <code><a |
| 337 | # href="/youtube/v3/docs/videos#status.privacyStatus" |
| 338 | # >privacyStatus</a></code> |
| 339 | # field of the corresponding video resource. |
| 340 | "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's |
| 341 | # <code><a |
| 342 | # href="/youtube/v3/live/docs/liveBroadcasts/transition" |
| 343 | # >liveBroadcasts.transition</a></code> method. |
| 344 | "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state). |
| 345 | "madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead |
| 346 | # of the creator. This field is read only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 347 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 348 | }</pre> |
| 349 | </div> |
| 350 | |
| 351 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 352 | <code class="details" id="control">control(id, part, onBehalfOfContentOwner=None, offsetTimeMs=None, displaySlate=None, walltime=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code> |
| 353 | <pre>Slate and recording control of the live broadcast. |
| 354 | Support actions: slate on/off, recording start/stop/pause/resume. |
| 355 | Design doc: goto/yt-api-liveBroadcast-control |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 356 | |
| 357 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 358 | id: string, Broadcast to operate. (required) |
| 359 | part: string, The <code><strong>part</strong></code> parameter specifies a |
| 360 | comma-separated list of one or more <code>liveBroadcast</code> resource |
| 361 | properties that the API response will include. The <code>part</code> names |
| 362 | that you can include in the parameter value are <code>id</code>, |
| 363 | <code>snippet</code>, <code>contentDetails</code>, and <code>status</code>. (required) (repeated) |
| 364 | onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 365 | content partners.<br><br>The |
| 366 | <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| 367 | that the |
| 368 | request's authorization credentials identify a YouTube CMS user who is |
| 369 | acting on behalf of the content owner specified in the parameter value. |
| 370 | This parameter is intended for YouTube content partners that own and manage |
| 371 | many different YouTube channels. It allows content owners to authenticate |
| 372 | once and get access to all their video and channel data, without having to |
| 373 | provide authentication credentials for each individual channel. The CMS |
| 374 | account that the user authenticates with must be linked to the specified |
| 375 | YouTube content owner. |
| 376 | offsetTimeMs: string, The exact time when the actions (e.g. slate on) are executed. |
| 377 | It is an offset from the first frame of the monitor stream. |
| 378 | If not set, it means "now" or ASAP. |
| 379 | This field should not be set if the monitor stream is disabled, |
| 380 | otherwise an error will be returned. |
| 381 | displaySlate: boolean, Whether display or hide slate. |
| 382 | walltime: string, The wall clock time at which the action should be executed. |
| 383 | Only one of offset_time_ms and walltime may be set at a time. |
| 384 | onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| 385 | href="/youtube/v3/guides/authentication">authorized request</a>. |
| 386 | <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 387 | content partners.<br><br>The |
| 388 | <code><strong>onBehalfOfContentOwnerChannel</strong></code> parameter |
| 389 | specifies the YouTube channel ID of the channel to which a video is being |
| 390 | added. This parameter is required when a request specifies a value for the |
| 391 | <code>onBehalfOfContentOwner</code> parameter, and it can only be used in |
| 392 | conjunction with that parameter. In addition, the request must be |
| 393 | authorized using a CMS account that is linked to the content owner that the |
| 394 | <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| 395 | channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| 396 | specifies must be linked to the content owner that the |
| 397 | <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>This |
| 398 | parameter is intended for YouTube content partners that own and manage many |
| 399 | different YouTube channels. It allows content owners to authenticate once |
| 400 | and perform actions on behalf of the channel specified in the parameter |
| 401 | value, without having to provide authentication credentials for each |
| 402 | separate channel. |
| 403 | x__xgafv: string, V1 error format. |
| 404 | Allowed values |
| 405 | 1 - v1 error format |
| 406 | 2 - v2 error format |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 407 | |
| 408 | Returns: |
| 409 | An object of the form: |
| 410 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 411 | { # A <code><strong>liveBroadcast</strong></code> resource represents an event |
| 412 | # that will be streamed, via live video, on YouTube. |
| 413 | "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast. |
| 414 | "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values # The <code>statistics</code> object contains info about the event's current |
| 415 | # stats. These include concurrent viewers and total chat count. Statistics |
| 416 | # can change (in either direction) during the lifetime of an event. |
| 417 | # Statistics are only returned while the event is live. |
| 418 | # at the time of the request. Statistics are only returned for live broadcasts. |
| 419 | "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The |
| 420 | # property and its value will be present if the broadcast is public, has |
| 421 | # the live chat feature enabled, and has at least one message. Note that |
| 422 | # this field will not be filled after the broadcast ends. So this property |
| 423 | # would not identify the number of chat messages for an archived video of a |
| 424 | # completed live broadcast. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 425 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 426 | "etag": "A String", # Etag of this resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 427 | "snippet": { # Basic broadcast information. # The <code>snippet</code> object contains basic details about the event, |
| 428 | # including its title, description, start time, and end time. |
| 429 | "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value |
| 430 | # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 431 | # format. |
| 432 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| 433 | # is publishing the broadcast. |
| 434 | "description": "A String", # The broadcast's description. As with the <code>title</code>, you can set |
| 435 | # this field by modifying the broadcast resource or by setting the |
| 436 | # <code><a |
| 437 | # href="/youtube/v3/docs/videos#snippet.description">description</a></code> |
| 438 | # field of the corresponding video resource. |
| 439 | "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one |
| 440 | # YouTube video. You can set this field by modifying the broadcast resource |
| 441 | # or by setting the |
| 442 | # <code><a href="/youtube/v3/docs/videos#snippet.title">title</a></code> |
| 443 | # field of the corresponding video resource. |
| 444 | "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast |
| 445 | # schedule. The value is specified in |
| 446 | # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 447 | # format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 448 | "liveChatId": "A String", # The id of the live chat for this broadcast. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 449 | "isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. |
| 450 | # Internal only. |
| 451 | "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is |
| 452 | # only available once the broadcast's state is <code>complete</code>. The |
| 453 | # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 454 | # format. |
| 455 | "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value |
| 456 | # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 457 | # format. |
| 458 | "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is |
| 459 | # only available once the broadcast's state is <code>live</code>. The |
| 460 | # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 461 | # format. |
| 462 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested |
| 463 | # object in this object, the key is the name of the thumbnail image, and |
| 464 | # the value is an object that contains other information about the |
| 465 | # thumbnail. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 466 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 467 | "width": 42, # (Optional) Width of the thumbnail image. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 468 | "url": "A String", # The thumbnail image's URL. |
| 469 | "height": 42, # (Optional) Height of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 470 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 471 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 472 | "width": 42, # (Optional) Width of the thumbnail image. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 473 | "url": "A String", # The thumbnail image's URL. |
| 474 | "height": 42, # (Optional) Height of the thumbnail image. |
| 475 | }, |
| 476 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 477 | "width": 42, # (Optional) Width of the thumbnail image. |
| 478 | "url": "A String", # The thumbnail image's URL. |
| 479 | "height": 42, # (Optional) Height of the thumbnail image. |
| 480 | }, |
| 481 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 482 | "width": 42, # (Optional) Width of the thumbnail image. |
| 483 | "url": "A String", # The thumbnail image's URL. |
| 484 | "height": 42, # (Optional) Height of the thumbnail image. |
| 485 | }, |
| 486 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 487 | "width": 42, # (Optional) Width of the thumbnail image. |
| 488 | "url": "A String", # The thumbnail image's URL. |
| 489 | "height": 42, # (Optional) Height of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 490 | }, |
| 491 | }, |
| 492 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 493 | "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string |
| 494 | # <code>"youtube#liveBroadcast"</code>. |
| 495 | "contentDetails": { # Detailed settings of a broadcast. # The <code>contentDetails</code> object contains information about the |
| 496 | # event's video content, such as whether the content can be shown in an |
| 497 | # embedded video player or if it will be archived and therefore available |
| 498 | # for viewing after the event has concluded. |
| 499 | "boundStreamId": "A String", # This value uniquely identifies the |
| 500 | # <code><a href="/youtube/v3/live/docs/liveStreams">live stream</a></code> |
| 501 | # bound to the broadcast. |
| 502 | "closedCaptionsType": "A String", |
| 503 | "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin |
| 504 | # with an <a |
| 505 | # href="/youtube/v3/live/getting-started#Displaying_Slates">in-stream |
| 506 | # slate</a> when you update the broadcast's status to <code>live</code>. |
| 507 | # After updating the status, you then need to send a |
| 508 | # <code><a |
| 509 | # href="/youtube/v3/live/docs/liveCuepoints/insert">liveCuepoints.insert</a></code> |
| 510 | # request that sets the cuepoint's <code>eventState</code> to |
| 511 | # <code>end</code> to remove the in-stream slate and make your broadcast |
| 512 | # stream visible to viewers. |
| 513 | "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by |
| 514 | # <code>boundStreamId</code> was last updated. |
| 515 | "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while |
| 516 | # watching the video. DVR controls enable the viewer to control the video |
| 517 | # playback experience by pausing, rewinding, or fast forwarding content. |
| 518 | # The default value for this property is <code>true</code>.<br><br> |
| 519 | # |
| 520 | # <strong>Important:</strong> You must set the value to <code>true</code> |
| 521 | # and also set the <code>enableArchive</code> property's value to |
| 522 | # <code>true</code> if you want to make playback available immediately |
| 523 | # after the broadcast ends. |
| 524 | "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an |
| 525 | # embedded player. If you choose to archive the video (using the |
| 526 | # <code>enableArchive</code> property), this setting will also apply to |
| 527 | # the archived video. |
| 528 | "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for |
| 529 | # this broadcast. The ingestion URL of the closed captions is returned |
| 530 | # through the liveStreams API. This is mutually exclusive with using the |
| 531 | # <code>closed_captions_type</code> property, and is equivalent to setting |
| 532 | # <code>closed_captions_type</code> to CLOSED_CAPTIONS_HTTP_POST. |
| 533 | "recordFromStart": True or False, # Automatically start recording after the event goes live. |
| 534 | # The default value for this property is <code>true</code>.<br><br> |
| 535 | # |
| 536 | # <strong>Important:</strong> You must also set the <code>enableDvr</code> |
| 537 | # property's value to |
| 538 | # <code>true</code> if you want the playback to be available immediately |
| 539 | # after the broadcast ends. If you set this property's value to |
| 540 | # <code>true</code> but do not also set the <code>enableDvr</code> property |
| 541 | # to <code>true</code>, there may be a delay of around one day before the |
| 542 | # archived video will be available for playback. |
| 543 | "monitorStream": { # Settings and Info of the monitor stream # The <code>monitorStream</code> object contains information about the |
| 544 | # monitor stream, which the broadcaster can use to review the event |
| 545 | # content before the broadcast stream is shown publicly. |
| 546 | "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream. |
| 547 | "broadcastStreamDelayMs": 42, # If you have set the |
| 548 | # <code><a href="#enableMonitorStream">enableMonitorStream</a></code> |
| 549 | # property to <code>true</code>, then this property determines the |
| 550 | # length of the live broadcast delay. |
| 551 | "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the |
| 552 | # broadcast. If the monitor stream is enabled, then YouTube will |
| 553 | # broadcast the event content on a special stream intended only for |
| 554 | # the broadcaster's consumption. The broadcaster can use the stream |
| 555 | # to review the event content and also to identify the optimal times |
| 556 | # to insert cuepoints.<br><br> |
| 557 | # You need to set this value to <code>true</code> if you intend to have |
| 558 | # a broadcast delay for your event.<br><br> |
| 559 | # <strong>Note:</strong> This property cannot be updated once the |
| 560 | # broadcast is in the <code>testing</code> or <code>live</code> state. |
| 561 | }, |
| 562 | "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption |
| 563 | # for the broadcast. |
| 564 | "enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. |
| 565 | # The default value for this property is <code>false</code>.<br><br> |
| 566 | # This setting can only be used by Events. |
| 567 | "latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. |
| 568 | # LATENCY_NORMAL should match enable_low_latency=false |
| 569 | # LATENCY_LOW should match enable_low_latency=true |
| 570 | # LATENCY_ULTRA_LOW should have enable_low_latency omitted. |
| 571 | "projection": "A String", # The projection format of this broadcast. This defaults to |
| 572 | # <code>rectangular</code>. |
| 573 | "mesh": "A String", # The mesh for projecting the video if <code>projection</code> is |
| 574 | # <code>mesh</code>. The mesh value must be a UTF-8 string containing the |
| 575 | # base-64 encoding of 3D mesh data that follows the <a |
| 576 | # href="https://github.com/google/spatial-media/blob/master/docs/spherical-video-v2-rfc.md"> |
| 577 | # Spherical Video V2 RFC specification</a> for an mshp box, excluding the box |
| 578 | # size and type but including the following four reserved zero bytes for the |
| 579 | # version and flags. |
| 580 | "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. |
| 581 | "enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. |
| 582 | # The default value for this property is <code>false</code>.<br><br> |
| 583 | # This setting can only be used by Events. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 584 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 585 | "status": { # Live broadcast state. # The <code>status</code> object contains information about the event's |
| 586 | # status. |
| 587 | "selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be |
| 588 | # kids only: go/live-cw-work. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 589 | "recordingStatus": "A String", # The broadcast's recording status. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 590 | "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents |
| 591 | # exactly one YouTube video, so the privacy settings are identical to |
| 592 | # those supported for videos. In addition, you can set this field by |
| 593 | # modifying the broadcast resource or by setting the |
| 594 | # <code><a |
| 595 | # href="/youtube/v3/docs/videos#status.privacyStatus" |
| 596 | # >privacyStatus</a></code> |
| 597 | # field of the corresponding video resource. |
| 598 | "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's |
| 599 | # <code><a |
| 600 | # href="/youtube/v3/live/docs/liveBroadcasts/transition" |
| 601 | # >liveBroadcasts.transition</a></code> method. |
| 602 | "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state). |
| 603 | "madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead |
| 604 | # of the creator. This field is read only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 605 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 606 | }</pre> |
| 607 | </div> |
| 608 | |
| 609 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 610 | <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code> |
| 611 | <pre>Delete a given broadcast. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 612 | |
| 613 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 614 | id: string, Broadcast to delete. (required) |
| 615 | onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 616 | content partners.<br><br>The |
| 617 | <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| 618 | that the |
| 619 | request's authorization credentials identify a YouTube CMS user who is |
| 620 | acting on behalf of the content owner specified in the parameter value. |
| 621 | This parameter is intended for YouTube content partners that own and manage |
| 622 | many different YouTube channels. It allows content owners to authenticate |
| 623 | once and get access to all their video and channel data, without having to |
| 624 | provide authentication credentials for each individual channel. The CMS |
| 625 | account that the user authenticates with must be linked to the specified |
| 626 | YouTube content owner. |
| 627 | onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| 628 | href="/youtube/v3/guides/authentication">authorized request</a>. |
| 629 | <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 630 | content partners.<br><br>The |
| 631 | <code><strong>onBehalfOfContentOwnerChannel</strong></code> parameter |
| 632 | specifies the YouTube channel ID of the channel to which a video is being |
| 633 | added. This parameter is required when a request specifies a value for the |
| 634 | <code>onBehalfOfContentOwner</code> parameter, and it can only be used in |
| 635 | conjunction with that parameter. In addition, the request must be |
| 636 | authorized using a CMS account that is linked to the content owner that the |
| 637 | <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| 638 | channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| 639 | specifies must be linked to the content owner that the |
| 640 | <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>This |
| 641 | parameter is intended for YouTube content partners that own and manage many |
| 642 | different YouTube channels. It allows content owners to authenticate once |
| 643 | and perform actions on behalf of the channel specified in the parameter |
| 644 | value, without having to provide authentication credentials for each |
| 645 | separate channel. |
| 646 | x__xgafv: string, V1 error format. |
| 647 | Allowed values |
| 648 | 1 - v1 error format |
| 649 | 2 - v2 error format |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 650 | </pre> |
| 651 | </div> |
| 652 | |
| 653 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 654 | <code class="details" id="insert">insert(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code> |
| 655 | <pre>Inserts a new stream for the authenticated user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 656 | |
| 657 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 658 | part: string, The <code><strong>part</strong></code> parameter serves two purposes in |
| 659 | this operation. It identifies the properties that the write operation will |
| 660 | set as well as the properties that the API response will |
| 661 | include.<br><br>The <code>part</code> properties that you can include in |
| 662 | the parameter value are <code>id</code>, <code>snippet</code>, |
| 663 | <code>contentDetails</code>, and <code>status</code>. (required) (repeated) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 664 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 665 | The object takes the form of: |
| 666 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 667 | { # A <code><strong>liveBroadcast</strong></code> resource represents an event |
| 668 | # that will be streamed, via live video, on YouTube. |
| 669 | "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast. |
| 670 | "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values # The <code>statistics</code> object contains info about the event's current |
| 671 | # stats. These include concurrent viewers and total chat count. Statistics |
| 672 | # can change (in either direction) during the lifetime of an event. |
| 673 | # Statistics are only returned while the event is live. |
| 674 | # at the time of the request. Statistics are only returned for live broadcasts. |
| 675 | "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The |
| 676 | # property and its value will be present if the broadcast is public, has |
| 677 | # the live chat feature enabled, and has at least one message. Note that |
| 678 | # this field will not be filled after the broadcast ends. So this property |
| 679 | # would not identify the number of chat messages for an archived video of a |
| 680 | # completed live broadcast. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 681 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 682 | "etag": "A String", # Etag of this resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 683 | "snippet": { # Basic broadcast information. # The <code>snippet</code> object contains basic details about the event, |
| 684 | # including its title, description, start time, and end time. |
| 685 | "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value |
| 686 | # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 687 | # format. |
| 688 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| 689 | # is publishing the broadcast. |
| 690 | "description": "A String", # The broadcast's description. As with the <code>title</code>, you can set |
| 691 | # this field by modifying the broadcast resource or by setting the |
| 692 | # <code><a |
| 693 | # href="/youtube/v3/docs/videos#snippet.description">description</a></code> |
| 694 | # field of the corresponding video resource. |
| 695 | "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one |
| 696 | # YouTube video. You can set this field by modifying the broadcast resource |
| 697 | # or by setting the |
| 698 | # <code><a href="/youtube/v3/docs/videos#snippet.title">title</a></code> |
| 699 | # field of the corresponding video resource. |
| 700 | "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast |
| 701 | # schedule. The value is specified in |
| 702 | # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 703 | # format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 704 | "liveChatId": "A String", # The id of the live chat for this broadcast. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 705 | "isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. |
| 706 | # Internal only. |
| 707 | "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is |
| 708 | # only available once the broadcast's state is <code>complete</code>. The |
| 709 | # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 710 | # format. |
| 711 | "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value |
| 712 | # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 713 | # format. |
| 714 | "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is |
| 715 | # only available once the broadcast's state is <code>live</code>. The |
| 716 | # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 717 | # format. |
| 718 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested |
| 719 | # object in this object, the key is the name of the thumbnail image, and |
| 720 | # the value is an object that contains other information about the |
| 721 | # thumbnail. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 722 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 723 | "width": 42, # (Optional) Width of the thumbnail image. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 724 | "url": "A String", # The thumbnail image's URL. |
| 725 | "height": 42, # (Optional) Height of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 726 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 727 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 728 | "width": 42, # (Optional) Width of the thumbnail image. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 729 | "url": "A String", # The thumbnail image's URL. |
| 730 | "height": 42, # (Optional) Height of the thumbnail image. |
| 731 | }, |
| 732 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 733 | "width": 42, # (Optional) Width of the thumbnail image. |
| 734 | "url": "A String", # The thumbnail image's URL. |
| 735 | "height": 42, # (Optional) Height of the thumbnail image. |
| 736 | }, |
| 737 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 738 | "width": 42, # (Optional) Width of the thumbnail image. |
| 739 | "url": "A String", # The thumbnail image's URL. |
| 740 | "height": 42, # (Optional) Height of the thumbnail image. |
| 741 | }, |
| 742 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 743 | "width": 42, # (Optional) Width of the thumbnail image. |
| 744 | "url": "A String", # The thumbnail image's URL. |
| 745 | "height": 42, # (Optional) Height of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 746 | }, |
| 747 | }, |
| 748 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 749 | "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string |
| 750 | # <code>"youtube#liveBroadcast"</code>. |
| 751 | "contentDetails": { # Detailed settings of a broadcast. # The <code>contentDetails</code> object contains information about the |
| 752 | # event's video content, such as whether the content can be shown in an |
| 753 | # embedded video player or if it will be archived and therefore available |
| 754 | # for viewing after the event has concluded. |
| 755 | "boundStreamId": "A String", # This value uniquely identifies the |
| 756 | # <code><a href="/youtube/v3/live/docs/liveStreams">live stream</a></code> |
| 757 | # bound to the broadcast. |
| 758 | "closedCaptionsType": "A String", |
| 759 | "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin |
| 760 | # with an <a |
| 761 | # href="/youtube/v3/live/getting-started#Displaying_Slates">in-stream |
| 762 | # slate</a> when you update the broadcast's status to <code>live</code>. |
| 763 | # After updating the status, you then need to send a |
| 764 | # <code><a |
| 765 | # href="/youtube/v3/live/docs/liveCuepoints/insert">liveCuepoints.insert</a></code> |
| 766 | # request that sets the cuepoint's <code>eventState</code> to |
| 767 | # <code>end</code> to remove the in-stream slate and make your broadcast |
| 768 | # stream visible to viewers. |
| 769 | "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by |
| 770 | # <code>boundStreamId</code> was last updated. |
| 771 | "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while |
| 772 | # watching the video. DVR controls enable the viewer to control the video |
| 773 | # playback experience by pausing, rewinding, or fast forwarding content. |
| 774 | # The default value for this property is <code>true</code>.<br><br> |
| 775 | # |
| 776 | # <strong>Important:</strong> You must set the value to <code>true</code> |
| 777 | # and also set the <code>enableArchive</code> property's value to |
| 778 | # <code>true</code> if you want to make playback available immediately |
| 779 | # after the broadcast ends. |
| 780 | "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an |
| 781 | # embedded player. If you choose to archive the video (using the |
| 782 | # <code>enableArchive</code> property), this setting will also apply to |
| 783 | # the archived video. |
| 784 | "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for |
| 785 | # this broadcast. The ingestion URL of the closed captions is returned |
| 786 | # through the liveStreams API. This is mutually exclusive with using the |
| 787 | # <code>closed_captions_type</code> property, and is equivalent to setting |
| 788 | # <code>closed_captions_type</code> to CLOSED_CAPTIONS_HTTP_POST. |
| 789 | "recordFromStart": True or False, # Automatically start recording after the event goes live. |
| 790 | # The default value for this property is <code>true</code>.<br><br> |
| 791 | # |
| 792 | # <strong>Important:</strong> You must also set the <code>enableDvr</code> |
| 793 | # property's value to |
| 794 | # <code>true</code> if you want the playback to be available immediately |
| 795 | # after the broadcast ends. If you set this property's value to |
| 796 | # <code>true</code> but do not also set the <code>enableDvr</code> property |
| 797 | # to <code>true</code>, there may be a delay of around one day before the |
| 798 | # archived video will be available for playback. |
| 799 | "monitorStream": { # Settings and Info of the monitor stream # The <code>monitorStream</code> object contains information about the |
| 800 | # monitor stream, which the broadcaster can use to review the event |
| 801 | # content before the broadcast stream is shown publicly. |
| 802 | "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream. |
| 803 | "broadcastStreamDelayMs": 42, # If you have set the |
| 804 | # <code><a href="#enableMonitorStream">enableMonitorStream</a></code> |
| 805 | # property to <code>true</code>, then this property determines the |
| 806 | # length of the live broadcast delay. |
| 807 | "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the |
| 808 | # broadcast. If the monitor stream is enabled, then YouTube will |
| 809 | # broadcast the event content on a special stream intended only for |
| 810 | # the broadcaster's consumption. The broadcaster can use the stream |
| 811 | # to review the event content and also to identify the optimal times |
| 812 | # to insert cuepoints.<br><br> |
| 813 | # You need to set this value to <code>true</code> if you intend to have |
| 814 | # a broadcast delay for your event.<br><br> |
| 815 | # <strong>Note:</strong> This property cannot be updated once the |
| 816 | # broadcast is in the <code>testing</code> or <code>live</code> state. |
| 817 | }, |
| 818 | "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption |
| 819 | # for the broadcast. |
| 820 | "enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. |
| 821 | # The default value for this property is <code>false</code>.<br><br> |
| 822 | # This setting can only be used by Events. |
| 823 | "latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. |
| 824 | # LATENCY_NORMAL should match enable_low_latency=false |
| 825 | # LATENCY_LOW should match enable_low_latency=true |
| 826 | # LATENCY_ULTRA_LOW should have enable_low_latency omitted. |
| 827 | "projection": "A String", # The projection format of this broadcast. This defaults to |
| 828 | # <code>rectangular</code>. |
| 829 | "mesh": "A String", # The mesh for projecting the video if <code>projection</code> is |
| 830 | # <code>mesh</code>. The mesh value must be a UTF-8 string containing the |
| 831 | # base-64 encoding of 3D mesh data that follows the <a |
| 832 | # href="https://github.com/google/spatial-media/blob/master/docs/spherical-video-v2-rfc.md"> |
| 833 | # Spherical Video V2 RFC specification</a> for an mshp box, excluding the box |
| 834 | # size and type but including the following four reserved zero bytes for the |
| 835 | # version and flags. |
| 836 | "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. |
| 837 | "enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. |
| 838 | # The default value for this property is <code>false</code>.<br><br> |
| 839 | # This setting can only be used by Events. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 840 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 841 | "status": { # Live broadcast state. # The <code>status</code> object contains information about the event's |
| 842 | # status. |
| 843 | "selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be |
| 844 | # kids only: go/live-cw-work. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 845 | "recordingStatus": "A String", # The broadcast's recording status. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 846 | "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents |
| 847 | # exactly one YouTube video, so the privacy settings are identical to |
| 848 | # those supported for videos. In addition, you can set this field by |
| 849 | # modifying the broadcast resource or by setting the |
| 850 | # <code><a |
| 851 | # href="/youtube/v3/docs/videos#status.privacyStatus" |
| 852 | # >privacyStatus</a></code> |
| 853 | # field of the corresponding video resource. |
| 854 | "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's |
| 855 | # <code><a |
| 856 | # href="/youtube/v3/live/docs/liveBroadcasts/transition" |
| 857 | # >liveBroadcasts.transition</a></code> method. |
| 858 | "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state). |
| 859 | "madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead |
| 860 | # of the creator. This field is read only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 861 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 862 | } |
| 863 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 864 | onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 865 | content partners.<br><br>The |
| 866 | <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| 867 | that the |
| 868 | request's authorization credentials identify a YouTube CMS user who is |
| 869 | acting on behalf of the content owner specified in the parameter value. |
| 870 | This parameter is intended for YouTube content partners that own and manage |
| 871 | many different YouTube channels. It allows content owners to authenticate |
| 872 | once and get access to all their video and channel data, without having to |
| 873 | provide authentication credentials for each individual channel. The CMS |
| 874 | account that the user authenticates with must be linked to the specified |
| 875 | YouTube content owner. |
| 876 | onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| 877 | href="/youtube/v3/guides/authentication">authorized request</a>. |
| 878 | <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 879 | content partners.<br><br>The |
| 880 | <code><strong>onBehalfOfContentOwnerChannel</strong></code> parameter |
| 881 | specifies the YouTube channel ID of the channel to which a video is being |
| 882 | added. This parameter is required when a request specifies a value for the |
| 883 | <code>onBehalfOfContentOwner</code> parameter, and it can only be used in |
| 884 | conjunction with that parameter. In addition, the request must be |
| 885 | authorized using a CMS account that is linked to the content owner that the |
| 886 | <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| 887 | channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| 888 | specifies must be linked to the content owner that the |
| 889 | <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>This |
| 890 | parameter is intended for YouTube content partners that own and manage many |
| 891 | different YouTube channels. It allows content owners to authenticate once |
| 892 | and perform actions on behalf of the channel specified in the parameter |
| 893 | value, without having to provide authentication credentials for each |
| 894 | separate channel. |
| 895 | x__xgafv: string, V1 error format. |
| 896 | Allowed values |
| 897 | 1 - v1 error format |
| 898 | 2 - v2 error format |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 899 | |
| 900 | Returns: |
| 901 | An object of the form: |
| 902 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 903 | { # A <code><strong>liveBroadcast</strong></code> resource represents an event |
| 904 | # that will be streamed, via live video, on YouTube. |
| 905 | "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast. |
| 906 | "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values # The <code>statistics</code> object contains info about the event's current |
| 907 | # stats. These include concurrent viewers and total chat count. Statistics |
| 908 | # can change (in either direction) during the lifetime of an event. |
| 909 | # Statistics are only returned while the event is live. |
| 910 | # at the time of the request. Statistics are only returned for live broadcasts. |
| 911 | "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The |
| 912 | # property and its value will be present if the broadcast is public, has |
| 913 | # the live chat feature enabled, and has at least one message. Note that |
| 914 | # this field will not be filled after the broadcast ends. So this property |
| 915 | # would not identify the number of chat messages for an archived video of a |
| 916 | # completed live broadcast. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 917 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 918 | "etag": "A String", # Etag of this resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 919 | "snippet": { # Basic broadcast information. # The <code>snippet</code> object contains basic details about the event, |
| 920 | # including its title, description, start time, and end time. |
| 921 | "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value |
| 922 | # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 923 | # format. |
| 924 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| 925 | # is publishing the broadcast. |
| 926 | "description": "A String", # The broadcast's description. As with the <code>title</code>, you can set |
| 927 | # this field by modifying the broadcast resource or by setting the |
| 928 | # <code><a |
| 929 | # href="/youtube/v3/docs/videos#snippet.description">description</a></code> |
| 930 | # field of the corresponding video resource. |
| 931 | "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one |
| 932 | # YouTube video. You can set this field by modifying the broadcast resource |
| 933 | # or by setting the |
| 934 | # <code><a href="/youtube/v3/docs/videos#snippet.title">title</a></code> |
| 935 | # field of the corresponding video resource. |
| 936 | "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast |
| 937 | # schedule. The value is specified in |
| 938 | # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 939 | # format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 940 | "liveChatId": "A String", # The id of the live chat for this broadcast. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 941 | "isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. |
| 942 | # Internal only. |
| 943 | "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is |
| 944 | # only available once the broadcast's state is <code>complete</code>. The |
| 945 | # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 946 | # format. |
| 947 | "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value |
| 948 | # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 949 | # format. |
| 950 | "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is |
| 951 | # only available once the broadcast's state is <code>live</code>. The |
| 952 | # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 953 | # format. |
| 954 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested |
| 955 | # object in this object, the key is the name of the thumbnail image, and |
| 956 | # the value is an object that contains other information about the |
| 957 | # thumbnail. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 958 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 959 | "width": 42, # (Optional) Width of the thumbnail image. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 960 | "url": "A String", # The thumbnail image's URL. |
| 961 | "height": 42, # (Optional) Height of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 962 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 963 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 964 | "width": 42, # (Optional) Width of the thumbnail image. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 965 | "url": "A String", # The thumbnail image's URL. |
| 966 | "height": 42, # (Optional) Height of the thumbnail image. |
| 967 | }, |
| 968 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 969 | "width": 42, # (Optional) Width of the thumbnail image. |
| 970 | "url": "A String", # The thumbnail image's URL. |
| 971 | "height": 42, # (Optional) Height of the thumbnail image. |
| 972 | }, |
| 973 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 974 | "width": 42, # (Optional) Width of the thumbnail image. |
| 975 | "url": "A String", # The thumbnail image's URL. |
| 976 | "height": 42, # (Optional) Height of the thumbnail image. |
| 977 | }, |
| 978 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 979 | "width": 42, # (Optional) Width of the thumbnail image. |
| 980 | "url": "A String", # The thumbnail image's URL. |
| 981 | "height": 42, # (Optional) Height of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 982 | }, |
| 983 | }, |
| 984 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 985 | "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string |
| 986 | # <code>"youtube#liveBroadcast"</code>. |
| 987 | "contentDetails": { # Detailed settings of a broadcast. # The <code>contentDetails</code> object contains information about the |
| 988 | # event's video content, such as whether the content can be shown in an |
| 989 | # embedded video player or if it will be archived and therefore available |
| 990 | # for viewing after the event has concluded. |
| 991 | "boundStreamId": "A String", # This value uniquely identifies the |
| 992 | # <code><a href="/youtube/v3/live/docs/liveStreams">live stream</a></code> |
| 993 | # bound to the broadcast. |
| 994 | "closedCaptionsType": "A String", |
| 995 | "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin |
| 996 | # with an <a |
| 997 | # href="/youtube/v3/live/getting-started#Displaying_Slates">in-stream |
| 998 | # slate</a> when you update the broadcast's status to <code>live</code>. |
| 999 | # After updating the status, you then need to send a |
| 1000 | # <code><a |
| 1001 | # href="/youtube/v3/live/docs/liveCuepoints/insert">liveCuepoints.insert</a></code> |
| 1002 | # request that sets the cuepoint's <code>eventState</code> to |
| 1003 | # <code>end</code> to remove the in-stream slate and make your broadcast |
| 1004 | # stream visible to viewers. |
| 1005 | "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by |
| 1006 | # <code>boundStreamId</code> was last updated. |
| 1007 | "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while |
| 1008 | # watching the video. DVR controls enable the viewer to control the video |
| 1009 | # playback experience by pausing, rewinding, or fast forwarding content. |
| 1010 | # The default value for this property is <code>true</code>.<br><br> |
| 1011 | # |
| 1012 | # <strong>Important:</strong> You must set the value to <code>true</code> |
| 1013 | # and also set the <code>enableArchive</code> property's value to |
| 1014 | # <code>true</code> if you want to make playback available immediately |
| 1015 | # after the broadcast ends. |
| 1016 | "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an |
| 1017 | # embedded player. If you choose to archive the video (using the |
| 1018 | # <code>enableArchive</code> property), this setting will also apply to |
| 1019 | # the archived video. |
| 1020 | "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for |
| 1021 | # this broadcast. The ingestion URL of the closed captions is returned |
| 1022 | # through the liveStreams API. This is mutually exclusive with using the |
| 1023 | # <code>closed_captions_type</code> property, and is equivalent to setting |
| 1024 | # <code>closed_captions_type</code> to CLOSED_CAPTIONS_HTTP_POST. |
| 1025 | "recordFromStart": True or False, # Automatically start recording after the event goes live. |
| 1026 | # The default value for this property is <code>true</code>.<br><br> |
| 1027 | # |
| 1028 | # <strong>Important:</strong> You must also set the <code>enableDvr</code> |
| 1029 | # property's value to |
| 1030 | # <code>true</code> if you want the playback to be available immediately |
| 1031 | # after the broadcast ends. If you set this property's value to |
| 1032 | # <code>true</code> but do not also set the <code>enableDvr</code> property |
| 1033 | # to <code>true</code>, there may be a delay of around one day before the |
| 1034 | # archived video will be available for playback. |
| 1035 | "monitorStream": { # Settings and Info of the monitor stream # The <code>monitorStream</code> object contains information about the |
| 1036 | # monitor stream, which the broadcaster can use to review the event |
| 1037 | # content before the broadcast stream is shown publicly. |
| 1038 | "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream. |
| 1039 | "broadcastStreamDelayMs": 42, # If you have set the |
| 1040 | # <code><a href="#enableMonitorStream">enableMonitorStream</a></code> |
| 1041 | # property to <code>true</code>, then this property determines the |
| 1042 | # length of the live broadcast delay. |
| 1043 | "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the |
| 1044 | # broadcast. If the monitor stream is enabled, then YouTube will |
| 1045 | # broadcast the event content on a special stream intended only for |
| 1046 | # the broadcaster's consumption. The broadcaster can use the stream |
| 1047 | # to review the event content and also to identify the optimal times |
| 1048 | # to insert cuepoints.<br><br> |
| 1049 | # You need to set this value to <code>true</code> if you intend to have |
| 1050 | # a broadcast delay for your event.<br><br> |
| 1051 | # <strong>Note:</strong> This property cannot be updated once the |
| 1052 | # broadcast is in the <code>testing</code> or <code>live</code> state. |
| 1053 | }, |
| 1054 | "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption |
| 1055 | # for the broadcast. |
| 1056 | "enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. |
| 1057 | # The default value for this property is <code>false</code>.<br><br> |
| 1058 | # This setting can only be used by Events. |
| 1059 | "latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. |
| 1060 | # LATENCY_NORMAL should match enable_low_latency=false |
| 1061 | # LATENCY_LOW should match enable_low_latency=true |
| 1062 | # LATENCY_ULTRA_LOW should have enable_low_latency omitted. |
| 1063 | "projection": "A String", # The projection format of this broadcast. This defaults to |
| 1064 | # <code>rectangular</code>. |
| 1065 | "mesh": "A String", # The mesh for projecting the video if <code>projection</code> is |
| 1066 | # <code>mesh</code>. The mesh value must be a UTF-8 string containing the |
| 1067 | # base-64 encoding of 3D mesh data that follows the <a |
| 1068 | # href="https://github.com/google/spatial-media/blob/master/docs/spherical-video-v2-rfc.md"> |
| 1069 | # Spherical Video V2 RFC specification</a> for an mshp box, excluding the box |
| 1070 | # size and type but including the following four reserved zero bytes for the |
| 1071 | # version and flags. |
| 1072 | "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. |
| 1073 | "enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. |
| 1074 | # The default value for this property is <code>false</code>.<br><br> |
| 1075 | # This setting can only be used by Events. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1076 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1077 | "status": { # Live broadcast state. # The <code>status</code> object contains information about the event's |
| 1078 | # status. |
| 1079 | "selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be |
| 1080 | # kids only: go/live-cw-work. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1081 | "recordingStatus": "A String", # The broadcast's recording status. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1082 | "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents |
| 1083 | # exactly one YouTube video, so the privacy settings are identical to |
| 1084 | # those supported for videos. In addition, you can set this field by |
| 1085 | # modifying the broadcast resource or by setting the |
| 1086 | # <code><a |
| 1087 | # href="/youtube/v3/docs/videos#status.privacyStatus" |
| 1088 | # >privacyStatus</a></code> |
| 1089 | # field of the corresponding video resource. |
| 1090 | "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's |
| 1091 | # <code><a |
| 1092 | # href="/youtube/v3/live/docs/liveBroadcasts/transition" |
| 1093 | # >liveBroadcasts.transition</a></code> method. |
| 1094 | "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state). |
| 1095 | "madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead |
| 1096 | # of the creator. This field is read only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1097 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1098 | }</pre> |
| 1099 | </div> |
| 1100 | |
| 1101 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1102 | <code class="details" id="list">list(part, pageToken=None, broadcastType=None, maxResults=None, broadcastStatus=None, mine=None, onBehalfOfContentOwnerChannel=None, id=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| 1103 | <pre>Retrieve the list of broadcasts associated with the given channel. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1104 | |
| 1105 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1106 | part: string, The <code><strong>part</strong></code> parameter specifies a |
| 1107 | comma-separated list of one or more <code>liveBroadcast</code> resource |
| 1108 | properties that the API response will include. The <code>part</code> names |
| 1109 | that you can include in the parameter value are <code>id</code>, |
| 1110 | <code>snippet</code>, <code>contentDetails</code>, and <code>status</code>. (required) (repeated) |
| 1111 | pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific |
| 1112 | page in the result set that should be returned. In an API response, the |
| 1113 | <code>nextPageToken</code> and <code>prevPageToken</code> properties |
| 1114 | identify other pages that could be retrieved. |
| 1115 | broadcastType: string, Return only broadcasts with the selected type. |
| 1116 | maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the |
| 1117 | maximum number of items that should be returned in the result set. |
| 1118 | broadcastStatus: string, Return broadcasts with a certain status, e.g. active broadcasts. |
| 1119 | mine: boolean, A parameter |
| 1120 | onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| 1121 | href="/youtube/v3/guides/authentication">authorized request</a>. |
| 1122 | <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 1123 | content partners.<br><br>The |
| 1124 | <code><strong>onBehalfOfContentOwnerChannel</strong></code> parameter |
| 1125 | specifies the YouTube channel ID of the channel to which a video is being |
| 1126 | added. This parameter is required when a request specifies a value for the |
| 1127 | <code>onBehalfOfContentOwner</code> parameter, and it can only be used in |
| 1128 | conjunction with that parameter. In addition, the request must be |
| 1129 | authorized using a CMS account that is linked to the content owner that the |
| 1130 | <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| 1131 | channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| 1132 | specifies must be linked to the content owner that the |
| 1133 | <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>This |
| 1134 | parameter is intended for YouTube content partners that own and manage many |
| 1135 | different YouTube channels. It allows content owners to authenticate once |
| 1136 | and perform actions on behalf of the channel specified in the parameter |
| 1137 | value, without having to provide authentication credentials for each |
| 1138 | separate channel. |
| 1139 | id: string, Return broadcasts with the given ids from Stubby or Apiary. (repeated) |
| 1140 | onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 1141 | content partners.<br><br>The |
| 1142 | <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| 1143 | that the |
| 1144 | request's authorization credentials identify a YouTube CMS user who is |
| 1145 | acting on behalf of the content owner specified in the parameter value. |
| 1146 | This parameter is intended for YouTube content partners that own and manage |
| 1147 | many different YouTube channels. It allows content owners to authenticate |
| 1148 | once and get access to all their video and channel data, without having to |
| 1149 | provide authentication credentials for each individual channel. The CMS |
| 1150 | account that the user authenticates with must be linked to the specified |
| 1151 | YouTube content owner. |
| 1152 | x__xgafv: string, V1 error format. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1153 | Allowed values |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1154 | 1 - v1 error format |
| 1155 | 2 - v2 error format |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1156 | |
| 1157 | Returns: |
| 1158 | An object of the form: |
| 1159 | |
| 1160 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1161 | "eventId": "A String", # Serialized EventId of the request which produced this response. |
| 1162 | "items": [ # A list of broadcasts that match the request criteria. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1163 | { # A <code><strong>liveBroadcast</strong></code> resource represents an event |
| 1164 | # that will be streamed, via live video, on YouTube. |
| 1165 | "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast. |
| 1166 | "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values # The <code>statistics</code> object contains info about the event's current |
| 1167 | # stats. These include concurrent viewers and total chat count. Statistics |
| 1168 | # can change (in either direction) during the lifetime of an event. |
| 1169 | # Statistics are only returned while the event is live. |
| 1170 | # at the time of the request. Statistics are only returned for live broadcasts. |
| 1171 | "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The |
| 1172 | # property and its value will be present if the broadcast is public, has |
| 1173 | # the live chat feature enabled, and has at least one message. Note that |
| 1174 | # this field will not be filled after the broadcast ends. So this property |
| 1175 | # would not identify the number of chat messages for an archived video of a |
| 1176 | # completed live broadcast. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1177 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1178 | "etag": "A String", # Etag of this resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1179 | "snippet": { # Basic broadcast information. # The <code>snippet</code> object contains basic details about the event, |
| 1180 | # including its title, description, start time, and end time. |
| 1181 | "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value |
| 1182 | # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1183 | # format. |
| 1184 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| 1185 | # is publishing the broadcast. |
| 1186 | "description": "A String", # The broadcast's description. As with the <code>title</code>, you can set |
| 1187 | # this field by modifying the broadcast resource or by setting the |
| 1188 | # <code><a |
| 1189 | # href="/youtube/v3/docs/videos#snippet.description">description</a></code> |
| 1190 | # field of the corresponding video resource. |
| 1191 | "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one |
| 1192 | # YouTube video. You can set this field by modifying the broadcast resource |
| 1193 | # or by setting the |
| 1194 | # <code><a href="/youtube/v3/docs/videos#snippet.title">title</a></code> |
| 1195 | # field of the corresponding video resource. |
| 1196 | "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast |
| 1197 | # schedule. The value is specified in |
| 1198 | # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1199 | # format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1200 | "liveChatId": "A String", # The id of the live chat for this broadcast. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1201 | "isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. |
| 1202 | # Internal only. |
| 1203 | "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is |
| 1204 | # only available once the broadcast's state is <code>complete</code>. The |
| 1205 | # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1206 | # format. |
| 1207 | "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value |
| 1208 | # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1209 | # format. |
| 1210 | "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is |
| 1211 | # only available once the broadcast's state is <code>live</code>. The |
| 1212 | # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1213 | # format. |
| 1214 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested |
| 1215 | # object in this object, the key is the name of the thumbnail image, and |
| 1216 | # the value is an object that contains other information about the |
| 1217 | # thumbnail. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1218 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1219 | "width": 42, # (Optional) Width of the thumbnail image. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1220 | "url": "A String", # The thumbnail image's URL. |
| 1221 | "height": 42, # (Optional) Height of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1222 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1223 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1224 | "width": 42, # (Optional) Width of the thumbnail image. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1225 | "url": "A String", # The thumbnail image's URL. |
| 1226 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1227 | }, |
| 1228 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 1229 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1230 | "url": "A String", # The thumbnail image's URL. |
| 1231 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1232 | }, |
| 1233 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 1234 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1235 | "url": "A String", # The thumbnail image's URL. |
| 1236 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1237 | }, |
| 1238 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 1239 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1240 | "url": "A String", # The thumbnail image's URL. |
| 1241 | "height": 42, # (Optional) Height of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1242 | }, |
| 1243 | }, |
| 1244 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1245 | "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string |
| 1246 | # <code>"youtube#liveBroadcast"</code>. |
| 1247 | "contentDetails": { # Detailed settings of a broadcast. # The <code>contentDetails</code> object contains information about the |
| 1248 | # event's video content, such as whether the content can be shown in an |
| 1249 | # embedded video player or if it will be archived and therefore available |
| 1250 | # for viewing after the event has concluded. |
| 1251 | "boundStreamId": "A String", # This value uniquely identifies the |
| 1252 | # <code><a href="/youtube/v3/live/docs/liveStreams">live stream</a></code> |
| 1253 | # bound to the broadcast. |
| 1254 | "closedCaptionsType": "A String", |
| 1255 | "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin |
| 1256 | # with an <a |
| 1257 | # href="/youtube/v3/live/getting-started#Displaying_Slates">in-stream |
| 1258 | # slate</a> when you update the broadcast's status to <code>live</code>. |
| 1259 | # After updating the status, you then need to send a |
| 1260 | # <code><a |
| 1261 | # href="/youtube/v3/live/docs/liveCuepoints/insert">liveCuepoints.insert</a></code> |
| 1262 | # request that sets the cuepoint's <code>eventState</code> to |
| 1263 | # <code>end</code> to remove the in-stream slate and make your broadcast |
| 1264 | # stream visible to viewers. |
| 1265 | "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by |
| 1266 | # <code>boundStreamId</code> was last updated. |
| 1267 | "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while |
| 1268 | # watching the video. DVR controls enable the viewer to control the video |
| 1269 | # playback experience by pausing, rewinding, or fast forwarding content. |
| 1270 | # The default value for this property is <code>true</code>.<br><br> |
| 1271 | # |
| 1272 | # <strong>Important:</strong> You must set the value to <code>true</code> |
| 1273 | # and also set the <code>enableArchive</code> property's value to |
| 1274 | # <code>true</code> if you want to make playback available immediately |
| 1275 | # after the broadcast ends. |
| 1276 | "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an |
| 1277 | # embedded player. If you choose to archive the video (using the |
| 1278 | # <code>enableArchive</code> property), this setting will also apply to |
| 1279 | # the archived video. |
| 1280 | "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for |
| 1281 | # this broadcast. The ingestion URL of the closed captions is returned |
| 1282 | # through the liveStreams API. This is mutually exclusive with using the |
| 1283 | # <code>closed_captions_type</code> property, and is equivalent to setting |
| 1284 | # <code>closed_captions_type</code> to CLOSED_CAPTIONS_HTTP_POST. |
| 1285 | "recordFromStart": True or False, # Automatically start recording after the event goes live. |
| 1286 | # The default value for this property is <code>true</code>.<br><br> |
| 1287 | # |
| 1288 | # <strong>Important:</strong> You must also set the <code>enableDvr</code> |
| 1289 | # property's value to |
| 1290 | # <code>true</code> if you want the playback to be available immediately |
| 1291 | # after the broadcast ends. If you set this property's value to |
| 1292 | # <code>true</code> but do not also set the <code>enableDvr</code> property |
| 1293 | # to <code>true</code>, there may be a delay of around one day before the |
| 1294 | # archived video will be available for playback. |
| 1295 | "monitorStream": { # Settings and Info of the monitor stream # The <code>monitorStream</code> object contains information about the |
| 1296 | # monitor stream, which the broadcaster can use to review the event |
| 1297 | # content before the broadcast stream is shown publicly. |
| 1298 | "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream. |
| 1299 | "broadcastStreamDelayMs": 42, # If you have set the |
| 1300 | # <code><a href="#enableMonitorStream">enableMonitorStream</a></code> |
| 1301 | # property to <code>true</code>, then this property determines the |
| 1302 | # length of the live broadcast delay. |
| 1303 | "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the |
| 1304 | # broadcast. If the monitor stream is enabled, then YouTube will |
| 1305 | # broadcast the event content on a special stream intended only for |
| 1306 | # the broadcaster's consumption. The broadcaster can use the stream |
| 1307 | # to review the event content and also to identify the optimal times |
| 1308 | # to insert cuepoints.<br><br> |
| 1309 | # You need to set this value to <code>true</code> if you intend to have |
| 1310 | # a broadcast delay for your event.<br><br> |
| 1311 | # <strong>Note:</strong> This property cannot be updated once the |
| 1312 | # broadcast is in the <code>testing</code> or <code>live</code> state. |
| 1313 | }, |
| 1314 | "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption |
| 1315 | # for the broadcast. |
| 1316 | "enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. |
| 1317 | # The default value for this property is <code>false</code>.<br><br> |
| 1318 | # This setting can only be used by Events. |
| 1319 | "latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. |
| 1320 | # LATENCY_NORMAL should match enable_low_latency=false |
| 1321 | # LATENCY_LOW should match enable_low_latency=true |
| 1322 | # LATENCY_ULTRA_LOW should have enable_low_latency omitted. |
| 1323 | "projection": "A String", # The projection format of this broadcast. This defaults to |
| 1324 | # <code>rectangular</code>. |
| 1325 | "mesh": "A String", # The mesh for projecting the video if <code>projection</code> is |
| 1326 | # <code>mesh</code>. The mesh value must be a UTF-8 string containing the |
| 1327 | # base-64 encoding of 3D mesh data that follows the <a |
| 1328 | # href="https://github.com/google/spatial-media/blob/master/docs/spherical-video-v2-rfc.md"> |
| 1329 | # Spherical Video V2 RFC specification</a> for an mshp box, excluding the box |
| 1330 | # size and type but including the following four reserved zero bytes for the |
| 1331 | # version and flags. |
| 1332 | "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. |
| 1333 | "enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. |
| 1334 | # The default value for this property is <code>false</code>.<br><br> |
| 1335 | # This setting can only be used by Events. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1336 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1337 | "status": { # Live broadcast state. # The <code>status</code> object contains information about the event's |
| 1338 | # status. |
| 1339 | "selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be |
| 1340 | # kids only: go/live-cw-work. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1341 | "recordingStatus": "A String", # The broadcast's recording status. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1342 | "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents |
| 1343 | # exactly one YouTube video, so the privacy settings are identical to |
| 1344 | # those supported for videos. In addition, you can set this field by |
| 1345 | # modifying the broadcast resource or by setting the |
| 1346 | # <code><a |
| 1347 | # href="/youtube/v3/docs/videos#status.privacyStatus" |
| 1348 | # >privacyStatus</a></code> |
| 1349 | # field of the corresponding video resource. |
| 1350 | "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's |
| 1351 | # <code><a |
| 1352 | # href="/youtube/v3/live/docs/liveBroadcasts/transition" |
| 1353 | # >liveBroadcasts.transition</a></code> method. |
| 1354 | "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state). |
| 1355 | "madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead |
| 1356 | # of the creator. This field is read only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1357 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1358 | }, |
| 1359 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1360 | "pageInfo": { # Paging details for lists of resources, including total number of items # General pagination information. |
| 1361 | # available and number of resources returned in a single page. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1362 | "resultsPerPage": 42, # The number of results included in the API response. |
| 1363 | "totalResults": 42, # The total number of results in the result set. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1364 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1365 | "etag": "A String", # Etag of this resource. |
| 1366 | "visitorId": "A String", # The <code>visitorId</code> identifies the visitor. |
| 1367 | "prevPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code> |
| 1368 | # parameter to retrieve the previous page in the result set. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1369 | "tokenPagination": { # Stub token pagination template to suppress results. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1370 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1371 | "kind": "youtube#liveBroadcastListResponse", # Identifies what kind of resource this is. Value: the fixed string |
| 1372 | # <code>"youtube#liveBroadcastListResponse"</code>. |
| 1373 | "nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code> |
| 1374 | # parameter to retrieve the next page in the result set. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1375 | }</pre> |
| 1376 | </div> |
| 1377 | |
| 1378 | <div class="method"> |
| 1379 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1380 | <pre>Retrieves the next page of results. |
| 1381 | |
| 1382 | Args: |
| 1383 | previous_request: The request for the previous page. (required) |
| 1384 | previous_response: The response from the request for the previous page. (required) |
| 1385 | |
| 1386 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1387 | A request object that you can call 'execute()' on to request the next |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1388 | page. Returns None if there are no more items in the collection. |
| 1389 | </pre> |
| 1390 | </div> |
| 1391 | |
| 1392 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1393 | <code class="details" id="transition">transition(id, broadcastStatus, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code> |
| 1394 | <pre>Transition a broadcast to a given status. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1395 | |
| 1396 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1397 | id: string, Broadcast to transition. (required) |
| 1398 | broadcastStatus: string, The status to which the broadcast is going to transition. (required) |
| 1399 | part: string, The <code><strong>part</strong></code> parameter specifies a |
| 1400 | comma-separated list of one or more <code>liveBroadcast</code> resource |
| 1401 | properties that the API response will include. The <code>part</code> names |
| 1402 | that you can include in the parameter value are <code>id</code>, |
| 1403 | <code>snippet</code>, <code>contentDetails</code>, and <code>status</code>. (required) (repeated) |
| 1404 | onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 1405 | content partners.<br><br>The |
| 1406 | <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| 1407 | that the |
| 1408 | request's authorization credentials identify a YouTube CMS user who is |
| 1409 | acting on behalf of the content owner specified in the parameter value. |
| 1410 | This parameter is intended for YouTube content partners that own and manage |
| 1411 | many different YouTube channels. It allows content owners to authenticate |
| 1412 | once and get access to all their video and channel data, without having to |
| 1413 | provide authentication credentials for each individual channel. The CMS |
| 1414 | account that the user authenticates with must be linked to the specified |
| 1415 | YouTube content owner. |
| 1416 | onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| 1417 | href="/youtube/v3/guides/authentication">authorized request</a>. |
| 1418 | <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 1419 | content partners.<br><br>The |
| 1420 | <code><strong>onBehalfOfContentOwnerChannel</strong></code> parameter |
| 1421 | specifies the YouTube channel ID of the channel to which a video is being |
| 1422 | added. This parameter is required when a request specifies a value for the |
| 1423 | <code>onBehalfOfContentOwner</code> parameter, and it can only be used in |
| 1424 | conjunction with that parameter. In addition, the request must be |
| 1425 | authorized using a CMS account that is linked to the content owner that the |
| 1426 | <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| 1427 | channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| 1428 | specifies must be linked to the content owner that the |
| 1429 | <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>This |
| 1430 | parameter is intended for YouTube content partners that own and manage many |
| 1431 | different YouTube channels. It allows content owners to authenticate once |
| 1432 | and perform actions on behalf of the channel specified in the parameter |
| 1433 | value, without having to provide authentication credentials for each |
| 1434 | separate channel. |
| 1435 | x__xgafv: string, V1 error format. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1436 | Allowed values |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1437 | 1 - v1 error format |
| 1438 | 2 - v2 error format |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1439 | |
| 1440 | Returns: |
| 1441 | An object of the form: |
| 1442 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1443 | { # A <code><strong>liveBroadcast</strong></code> resource represents an event |
| 1444 | # that will be streamed, via live video, on YouTube. |
| 1445 | "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast. |
| 1446 | "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values # The <code>statistics</code> object contains info about the event's current |
| 1447 | # stats. These include concurrent viewers and total chat count. Statistics |
| 1448 | # can change (in either direction) during the lifetime of an event. |
| 1449 | # Statistics are only returned while the event is live. |
| 1450 | # at the time of the request. Statistics are only returned for live broadcasts. |
| 1451 | "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The |
| 1452 | # property and its value will be present if the broadcast is public, has |
| 1453 | # the live chat feature enabled, and has at least one message. Note that |
| 1454 | # this field will not be filled after the broadcast ends. So this property |
| 1455 | # would not identify the number of chat messages for an archived video of a |
| 1456 | # completed live broadcast. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1457 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1458 | "etag": "A String", # Etag of this resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1459 | "snippet": { # Basic broadcast information. # The <code>snippet</code> object contains basic details about the event, |
| 1460 | # including its title, description, start time, and end time. |
| 1461 | "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value |
| 1462 | # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1463 | # format. |
| 1464 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| 1465 | # is publishing the broadcast. |
| 1466 | "description": "A String", # The broadcast's description. As with the <code>title</code>, you can set |
| 1467 | # this field by modifying the broadcast resource or by setting the |
| 1468 | # <code><a |
| 1469 | # href="/youtube/v3/docs/videos#snippet.description">description</a></code> |
| 1470 | # field of the corresponding video resource. |
| 1471 | "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one |
| 1472 | # YouTube video. You can set this field by modifying the broadcast resource |
| 1473 | # or by setting the |
| 1474 | # <code><a href="/youtube/v3/docs/videos#snippet.title">title</a></code> |
| 1475 | # field of the corresponding video resource. |
| 1476 | "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast |
| 1477 | # schedule. The value is specified in |
| 1478 | # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1479 | # format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1480 | "liveChatId": "A String", # The id of the live chat for this broadcast. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1481 | "isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. |
| 1482 | # Internal only. |
| 1483 | "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is |
| 1484 | # only available once the broadcast's state is <code>complete</code>. The |
| 1485 | # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1486 | # format. |
| 1487 | "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value |
| 1488 | # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1489 | # format. |
| 1490 | "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is |
| 1491 | # only available once the broadcast's state is <code>live</code>. The |
| 1492 | # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1493 | # format. |
| 1494 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested |
| 1495 | # object in this object, the key is the name of the thumbnail image, and |
| 1496 | # the value is an object that contains other information about the |
| 1497 | # thumbnail. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1498 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1499 | "width": 42, # (Optional) Width of the thumbnail image. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1500 | "url": "A String", # The thumbnail image's URL. |
| 1501 | "height": 42, # (Optional) Height of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1502 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1503 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1504 | "width": 42, # (Optional) Width of the thumbnail image. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1505 | "url": "A String", # The thumbnail image's URL. |
| 1506 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1507 | }, |
| 1508 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 1509 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1510 | "url": "A String", # The thumbnail image's URL. |
| 1511 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1512 | }, |
| 1513 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 1514 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1515 | "url": "A String", # The thumbnail image's URL. |
| 1516 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1517 | }, |
| 1518 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 1519 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1520 | "url": "A String", # The thumbnail image's URL. |
| 1521 | "height": 42, # (Optional) Height of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1522 | }, |
| 1523 | }, |
| 1524 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1525 | "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string |
| 1526 | # <code>"youtube#liveBroadcast"</code>. |
| 1527 | "contentDetails": { # Detailed settings of a broadcast. # The <code>contentDetails</code> object contains information about the |
| 1528 | # event's video content, such as whether the content can be shown in an |
| 1529 | # embedded video player or if it will be archived and therefore available |
| 1530 | # for viewing after the event has concluded. |
| 1531 | "boundStreamId": "A String", # This value uniquely identifies the |
| 1532 | # <code><a href="/youtube/v3/live/docs/liveStreams">live stream</a></code> |
| 1533 | # bound to the broadcast. |
| 1534 | "closedCaptionsType": "A String", |
| 1535 | "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin |
| 1536 | # with an <a |
| 1537 | # href="/youtube/v3/live/getting-started#Displaying_Slates">in-stream |
| 1538 | # slate</a> when you update the broadcast's status to <code>live</code>. |
| 1539 | # After updating the status, you then need to send a |
| 1540 | # <code><a |
| 1541 | # href="/youtube/v3/live/docs/liveCuepoints/insert">liveCuepoints.insert</a></code> |
| 1542 | # request that sets the cuepoint's <code>eventState</code> to |
| 1543 | # <code>end</code> to remove the in-stream slate and make your broadcast |
| 1544 | # stream visible to viewers. |
| 1545 | "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by |
| 1546 | # <code>boundStreamId</code> was last updated. |
| 1547 | "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while |
| 1548 | # watching the video. DVR controls enable the viewer to control the video |
| 1549 | # playback experience by pausing, rewinding, or fast forwarding content. |
| 1550 | # The default value for this property is <code>true</code>.<br><br> |
| 1551 | # |
| 1552 | # <strong>Important:</strong> You must set the value to <code>true</code> |
| 1553 | # and also set the <code>enableArchive</code> property's value to |
| 1554 | # <code>true</code> if you want to make playback available immediately |
| 1555 | # after the broadcast ends. |
| 1556 | "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an |
| 1557 | # embedded player. If you choose to archive the video (using the |
| 1558 | # <code>enableArchive</code> property), this setting will also apply to |
| 1559 | # the archived video. |
| 1560 | "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for |
| 1561 | # this broadcast. The ingestion URL of the closed captions is returned |
| 1562 | # through the liveStreams API. This is mutually exclusive with using the |
| 1563 | # <code>closed_captions_type</code> property, and is equivalent to setting |
| 1564 | # <code>closed_captions_type</code> to CLOSED_CAPTIONS_HTTP_POST. |
| 1565 | "recordFromStart": True or False, # Automatically start recording after the event goes live. |
| 1566 | # The default value for this property is <code>true</code>.<br><br> |
| 1567 | # |
| 1568 | # <strong>Important:</strong> You must also set the <code>enableDvr</code> |
| 1569 | # property's value to |
| 1570 | # <code>true</code> if you want the playback to be available immediately |
| 1571 | # after the broadcast ends. If you set this property's value to |
| 1572 | # <code>true</code> but do not also set the <code>enableDvr</code> property |
| 1573 | # to <code>true</code>, there may be a delay of around one day before the |
| 1574 | # archived video will be available for playback. |
| 1575 | "monitorStream": { # Settings and Info of the monitor stream # The <code>monitorStream</code> object contains information about the |
| 1576 | # monitor stream, which the broadcaster can use to review the event |
| 1577 | # content before the broadcast stream is shown publicly. |
| 1578 | "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream. |
| 1579 | "broadcastStreamDelayMs": 42, # If you have set the |
| 1580 | # <code><a href="#enableMonitorStream">enableMonitorStream</a></code> |
| 1581 | # property to <code>true</code>, then this property determines the |
| 1582 | # length of the live broadcast delay. |
| 1583 | "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the |
| 1584 | # broadcast. If the monitor stream is enabled, then YouTube will |
| 1585 | # broadcast the event content on a special stream intended only for |
| 1586 | # the broadcaster's consumption. The broadcaster can use the stream |
| 1587 | # to review the event content and also to identify the optimal times |
| 1588 | # to insert cuepoints.<br><br> |
| 1589 | # You need to set this value to <code>true</code> if you intend to have |
| 1590 | # a broadcast delay for your event.<br><br> |
| 1591 | # <strong>Note:</strong> This property cannot be updated once the |
| 1592 | # broadcast is in the <code>testing</code> or <code>live</code> state. |
| 1593 | }, |
| 1594 | "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption |
| 1595 | # for the broadcast. |
| 1596 | "enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. |
| 1597 | # The default value for this property is <code>false</code>.<br><br> |
| 1598 | # This setting can only be used by Events. |
| 1599 | "latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. |
| 1600 | # LATENCY_NORMAL should match enable_low_latency=false |
| 1601 | # LATENCY_LOW should match enable_low_latency=true |
| 1602 | # LATENCY_ULTRA_LOW should have enable_low_latency omitted. |
| 1603 | "projection": "A String", # The projection format of this broadcast. This defaults to |
| 1604 | # <code>rectangular</code>. |
| 1605 | "mesh": "A String", # The mesh for projecting the video if <code>projection</code> is |
| 1606 | # <code>mesh</code>. The mesh value must be a UTF-8 string containing the |
| 1607 | # base-64 encoding of 3D mesh data that follows the <a |
| 1608 | # href="https://github.com/google/spatial-media/blob/master/docs/spherical-video-v2-rfc.md"> |
| 1609 | # Spherical Video V2 RFC specification</a> for an mshp box, excluding the box |
| 1610 | # size and type but including the following four reserved zero bytes for the |
| 1611 | # version and flags. |
| 1612 | "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. |
| 1613 | "enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. |
| 1614 | # The default value for this property is <code>false</code>.<br><br> |
| 1615 | # This setting can only be used by Events. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1616 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1617 | "status": { # Live broadcast state. # The <code>status</code> object contains information about the event's |
| 1618 | # status. |
| 1619 | "selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be |
| 1620 | # kids only: go/live-cw-work. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1621 | "recordingStatus": "A String", # The broadcast's recording status. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1622 | "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents |
| 1623 | # exactly one YouTube video, so the privacy settings are identical to |
| 1624 | # those supported for videos. In addition, you can set this field by |
| 1625 | # modifying the broadcast resource or by setting the |
| 1626 | # <code><a |
| 1627 | # href="/youtube/v3/docs/videos#status.privacyStatus" |
| 1628 | # >privacyStatus</a></code> |
| 1629 | # field of the corresponding video resource. |
| 1630 | "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's |
| 1631 | # <code><a |
| 1632 | # href="/youtube/v3/live/docs/liveBroadcasts/transition" |
| 1633 | # >liveBroadcasts.transition</a></code> method. |
| 1634 | "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state). |
| 1635 | "madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead |
| 1636 | # of the creator. This field is read only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1637 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1638 | }</pre> |
| 1639 | </div> |
| 1640 | |
| 1641 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1642 | <code class="details" id="update">update(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code> |
| 1643 | <pre>Updates an existing broadcast for the authenticated user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1644 | |
| 1645 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1646 | part: string, The <code><strong>part</strong></code> parameter serves two purposes in |
| 1647 | this operation. It identifies the properties that the write operation will |
| 1648 | set as well as the properties that the API response will |
| 1649 | include.<br><br>The <code>part</code> properties that you can include in |
| 1650 | the parameter value are <code>id</code>, <code>snippet</code>, |
| 1651 | <code>contentDetails</code>, and <code>status</code>.<br><br>Note that this |
| 1652 | method will override the existing values for all of the mutable properties |
| 1653 | that are contained in any parts that the parameter value specifies. For |
| 1654 | example, a |
| 1655 | broadcast's privacy status is defined in the <code>status</code> part. As |
| 1656 | such, if your request is updating a private or unlisted broadcast, and the |
| 1657 | request's <code>part</code> parameter value includes the |
| 1658 | <code>status</code> part, the broadcast's privacy setting will be updated |
| 1659 | to whatever value the request body specifies. If the request body does not |
| 1660 | specify a value, the existing privacy setting will be removed and the |
| 1661 | broadcast will revert to the default privacy setting. (required) (repeated) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1662 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1663 | The object takes the form of: |
| 1664 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1665 | { # A <code><strong>liveBroadcast</strong></code> resource represents an event |
| 1666 | # that will be streamed, via live video, on YouTube. |
| 1667 | "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast. |
| 1668 | "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values # The <code>statistics</code> object contains info about the event's current |
| 1669 | # stats. These include concurrent viewers and total chat count. Statistics |
| 1670 | # can change (in either direction) during the lifetime of an event. |
| 1671 | # Statistics are only returned while the event is live. |
| 1672 | # at the time of the request. Statistics are only returned for live broadcasts. |
| 1673 | "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The |
| 1674 | # property and its value will be present if the broadcast is public, has |
| 1675 | # the live chat feature enabled, and has at least one message. Note that |
| 1676 | # this field will not be filled after the broadcast ends. So this property |
| 1677 | # would not identify the number of chat messages for an archived video of a |
| 1678 | # completed live broadcast. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1679 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1680 | "etag": "A String", # Etag of this resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1681 | "snippet": { # Basic broadcast information. # The <code>snippet</code> object contains basic details about the event, |
| 1682 | # including its title, description, start time, and end time. |
| 1683 | "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value |
| 1684 | # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1685 | # format. |
| 1686 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| 1687 | # is publishing the broadcast. |
| 1688 | "description": "A String", # The broadcast's description. As with the <code>title</code>, you can set |
| 1689 | # this field by modifying the broadcast resource or by setting the |
| 1690 | # <code><a |
| 1691 | # href="/youtube/v3/docs/videos#snippet.description">description</a></code> |
| 1692 | # field of the corresponding video resource. |
| 1693 | "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one |
| 1694 | # YouTube video. You can set this field by modifying the broadcast resource |
| 1695 | # or by setting the |
| 1696 | # <code><a href="/youtube/v3/docs/videos#snippet.title">title</a></code> |
| 1697 | # field of the corresponding video resource. |
| 1698 | "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast |
| 1699 | # schedule. The value is specified in |
| 1700 | # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1701 | # format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1702 | "liveChatId": "A String", # The id of the live chat for this broadcast. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1703 | "isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. |
| 1704 | # Internal only. |
| 1705 | "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is |
| 1706 | # only available once the broadcast's state is <code>complete</code>. The |
| 1707 | # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1708 | # format. |
| 1709 | "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value |
| 1710 | # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1711 | # format. |
| 1712 | "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is |
| 1713 | # only available once the broadcast's state is <code>live</code>. The |
| 1714 | # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1715 | # format. |
| 1716 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested |
| 1717 | # object in this object, the key is the name of the thumbnail image, and |
| 1718 | # the value is an object that contains other information about the |
| 1719 | # thumbnail. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1720 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1721 | "width": 42, # (Optional) Width of the thumbnail image. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1722 | "url": "A String", # The thumbnail image's URL. |
| 1723 | "height": 42, # (Optional) Height of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1724 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1725 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1726 | "width": 42, # (Optional) Width of the thumbnail image. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1727 | "url": "A String", # The thumbnail image's URL. |
| 1728 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1729 | }, |
| 1730 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 1731 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1732 | "url": "A String", # The thumbnail image's URL. |
| 1733 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1734 | }, |
| 1735 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 1736 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1737 | "url": "A String", # The thumbnail image's URL. |
| 1738 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1739 | }, |
| 1740 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 1741 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1742 | "url": "A String", # The thumbnail image's URL. |
| 1743 | "height": 42, # (Optional) Height of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1744 | }, |
| 1745 | }, |
| 1746 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1747 | "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string |
| 1748 | # <code>"youtube#liveBroadcast"</code>. |
| 1749 | "contentDetails": { # Detailed settings of a broadcast. # The <code>contentDetails</code> object contains information about the |
| 1750 | # event's video content, such as whether the content can be shown in an |
| 1751 | # embedded video player or if it will be archived and therefore available |
| 1752 | # for viewing after the event has concluded. |
| 1753 | "boundStreamId": "A String", # This value uniquely identifies the |
| 1754 | # <code><a href="/youtube/v3/live/docs/liveStreams">live stream</a></code> |
| 1755 | # bound to the broadcast. |
| 1756 | "closedCaptionsType": "A String", |
| 1757 | "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin |
| 1758 | # with an <a |
| 1759 | # href="/youtube/v3/live/getting-started#Displaying_Slates">in-stream |
| 1760 | # slate</a> when you update the broadcast's status to <code>live</code>. |
| 1761 | # After updating the status, you then need to send a |
| 1762 | # <code><a |
| 1763 | # href="/youtube/v3/live/docs/liveCuepoints/insert">liveCuepoints.insert</a></code> |
| 1764 | # request that sets the cuepoint's <code>eventState</code> to |
| 1765 | # <code>end</code> to remove the in-stream slate and make your broadcast |
| 1766 | # stream visible to viewers. |
| 1767 | "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by |
| 1768 | # <code>boundStreamId</code> was last updated. |
| 1769 | "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while |
| 1770 | # watching the video. DVR controls enable the viewer to control the video |
| 1771 | # playback experience by pausing, rewinding, or fast forwarding content. |
| 1772 | # The default value for this property is <code>true</code>.<br><br> |
| 1773 | # |
| 1774 | # <strong>Important:</strong> You must set the value to <code>true</code> |
| 1775 | # and also set the <code>enableArchive</code> property's value to |
| 1776 | # <code>true</code> if you want to make playback available immediately |
| 1777 | # after the broadcast ends. |
| 1778 | "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an |
| 1779 | # embedded player. If you choose to archive the video (using the |
| 1780 | # <code>enableArchive</code> property), this setting will also apply to |
| 1781 | # the archived video. |
| 1782 | "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for |
| 1783 | # this broadcast. The ingestion URL of the closed captions is returned |
| 1784 | # through the liveStreams API. This is mutually exclusive with using the |
| 1785 | # <code>closed_captions_type</code> property, and is equivalent to setting |
| 1786 | # <code>closed_captions_type</code> to CLOSED_CAPTIONS_HTTP_POST. |
| 1787 | "recordFromStart": True or False, # Automatically start recording after the event goes live. |
| 1788 | # The default value for this property is <code>true</code>.<br><br> |
| 1789 | # |
| 1790 | # <strong>Important:</strong> You must also set the <code>enableDvr</code> |
| 1791 | # property's value to |
| 1792 | # <code>true</code> if you want the playback to be available immediately |
| 1793 | # after the broadcast ends. If you set this property's value to |
| 1794 | # <code>true</code> but do not also set the <code>enableDvr</code> property |
| 1795 | # to <code>true</code>, there may be a delay of around one day before the |
| 1796 | # archived video will be available for playback. |
| 1797 | "monitorStream": { # Settings and Info of the monitor stream # The <code>monitorStream</code> object contains information about the |
| 1798 | # monitor stream, which the broadcaster can use to review the event |
| 1799 | # content before the broadcast stream is shown publicly. |
| 1800 | "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream. |
| 1801 | "broadcastStreamDelayMs": 42, # If you have set the |
| 1802 | # <code><a href="#enableMonitorStream">enableMonitorStream</a></code> |
| 1803 | # property to <code>true</code>, then this property determines the |
| 1804 | # length of the live broadcast delay. |
| 1805 | "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the |
| 1806 | # broadcast. If the monitor stream is enabled, then YouTube will |
| 1807 | # broadcast the event content on a special stream intended only for |
| 1808 | # the broadcaster's consumption. The broadcaster can use the stream |
| 1809 | # to review the event content and also to identify the optimal times |
| 1810 | # to insert cuepoints.<br><br> |
| 1811 | # You need to set this value to <code>true</code> if you intend to have |
| 1812 | # a broadcast delay for your event.<br><br> |
| 1813 | # <strong>Note:</strong> This property cannot be updated once the |
| 1814 | # broadcast is in the <code>testing</code> or <code>live</code> state. |
| 1815 | }, |
| 1816 | "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption |
| 1817 | # for the broadcast. |
| 1818 | "enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. |
| 1819 | # The default value for this property is <code>false</code>.<br><br> |
| 1820 | # This setting can only be used by Events. |
| 1821 | "latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. |
| 1822 | # LATENCY_NORMAL should match enable_low_latency=false |
| 1823 | # LATENCY_LOW should match enable_low_latency=true |
| 1824 | # LATENCY_ULTRA_LOW should have enable_low_latency omitted. |
| 1825 | "projection": "A String", # The projection format of this broadcast. This defaults to |
| 1826 | # <code>rectangular</code>. |
| 1827 | "mesh": "A String", # The mesh for projecting the video if <code>projection</code> is |
| 1828 | # <code>mesh</code>. The mesh value must be a UTF-8 string containing the |
| 1829 | # base-64 encoding of 3D mesh data that follows the <a |
| 1830 | # href="https://github.com/google/spatial-media/blob/master/docs/spherical-video-v2-rfc.md"> |
| 1831 | # Spherical Video V2 RFC specification</a> for an mshp box, excluding the box |
| 1832 | # size and type but including the following four reserved zero bytes for the |
| 1833 | # version and flags. |
| 1834 | "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. |
| 1835 | "enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. |
| 1836 | # The default value for this property is <code>false</code>.<br><br> |
| 1837 | # This setting can only be used by Events. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1838 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1839 | "status": { # Live broadcast state. # The <code>status</code> object contains information about the event's |
| 1840 | # status. |
| 1841 | "selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be |
| 1842 | # kids only: go/live-cw-work. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1843 | "recordingStatus": "A String", # The broadcast's recording status. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1844 | "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents |
| 1845 | # exactly one YouTube video, so the privacy settings are identical to |
| 1846 | # those supported for videos. In addition, you can set this field by |
| 1847 | # modifying the broadcast resource or by setting the |
| 1848 | # <code><a |
| 1849 | # href="/youtube/v3/docs/videos#status.privacyStatus" |
| 1850 | # >privacyStatus</a></code> |
| 1851 | # field of the corresponding video resource. |
| 1852 | "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's |
| 1853 | # <code><a |
| 1854 | # href="/youtube/v3/live/docs/liveBroadcasts/transition" |
| 1855 | # >liveBroadcasts.transition</a></code> method. |
| 1856 | "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state). |
| 1857 | "madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead |
| 1858 | # of the creator. This field is read only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1859 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1860 | } |
| 1861 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1862 | onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 1863 | content partners.<br><br>The |
| 1864 | <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| 1865 | that the |
| 1866 | request's authorization credentials identify a YouTube CMS user who is |
| 1867 | acting on behalf of the content owner specified in the parameter value. |
| 1868 | This parameter is intended for YouTube content partners that own and manage |
| 1869 | many different YouTube channels. It allows content owners to authenticate |
| 1870 | once and get access to all their video and channel data, without having to |
| 1871 | provide authentication credentials for each individual channel. The CMS |
| 1872 | account that the user authenticates with must be linked to the specified |
| 1873 | YouTube content owner. |
| 1874 | onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| 1875 | href="/youtube/v3/guides/authentication">authorized request</a>. |
| 1876 | <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 1877 | content partners.<br><br>The |
| 1878 | <code><strong>onBehalfOfContentOwnerChannel</strong></code> parameter |
| 1879 | specifies the YouTube channel ID of the channel to which a video is being |
| 1880 | added. This parameter is required when a request specifies a value for the |
| 1881 | <code>onBehalfOfContentOwner</code> parameter, and it can only be used in |
| 1882 | conjunction with that parameter. In addition, the request must be |
| 1883 | authorized using a CMS account that is linked to the content owner that the |
| 1884 | <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| 1885 | channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| 1886 | specifies must be linked to the content owner that the |
| 1887 | <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>This |
| 1888 | parameter is intended for YouTube content partners that own and manage many |
| 1889 | different YouTube channels. It allows content owners to authenticate once |
| 1890 | and perform actions on behalf of the channel specified in the parameter |
| 1891 | value, without having to provide authentication credentials for each |
| 1892 | separate channel. |
| 1893 | x__xgafv: string, V1 error format. |
| 1894 | Allowed values |
| 1895 | 1 - v1 error format |
| 1896 | 2 - v2 error format |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1897 | |
| 1898 | Returns: |
| 1899 | An object of the form: |
| 1900 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1901 | { # A <code><strong>liveBroadcast</strong></code> resource represents an event |
| 1902 | # that will be streamed, via live video, on YouTube. |
| 1903 | "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast. |
| 1904 | "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values # The <code>statistics</code> object contains info about the event's current |
| 1905 | # stats. These include concurrent viewers and total chat count. Statistics |
| 1906 | # can change (in either direction) during the lifetime of an event. |
| 1907 | # Statistics are only returned while the event is live. |
| 1908 | # at the time of the request. Statistics are only returned for live broadcasts. |
| 1909 | "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The |
| 1910 | # property and its value will be present if the broadcast is public, has |
| 1911 | # the live chat feature enabled, and has at least one message. Note that |
| 1912 | # this field will not be filled after the broadcast ends. So this property |
| 1913 | # would not identify the number of chat messages for an archived video of a |
| 1914 | # completed live broadcast. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1915 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1916 | "etag": "A String", # Etag of this resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1917 | "snippet": { # Basic broadcast information. # The <code>snippet</code> object contains basic details about the event, |
| 1918 | # including its title, description, start time, and end time. |
| 1919 | "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value |
| 1920 | # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1921 | # format. |
| 1922 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| 1923 | # is publishing the broadcast. |
| 1924 | "description": "A String", # The broadcast's description. As with the <code>title</code>, you can set |
| 1925 | # this field by modifying the broadcast resource or by setting the |
| 1926 | # <code><a |
| 1927 | # href="/youtube/v3/docs/videos#snippet.description">description</a></code> |
| 1928 | # field of the corresponding video resource. |
| 1929 | "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one |
| 1930 | # YouTube video. You can set this field by modifying the broadcast resource |
| 1931 | # or by setting the |
| 1932 | # <code><a href="/youtube/v3/docs/videos#snippet.title">title</a></code> |
| 1933 | # field of the corresponding video resource. |
| 1934 | "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast |
| 1935 | # schedule. The value is specified in |
| 1936 | # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1937 | # format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1938 | "liveChatId": "A String", # The id of the live chat for this broadcast. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1939 | "isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. |
| 1940 | # Internal only. |
| 1941 | "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is |
| 1942 | # only available once the broadcast's state is <code>complete</code>. The |
| 1943 | # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1944 | # format. |
| 1945 | "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value |
| 1946 | # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1947 | # format. |
| 1948 | "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is |
| 1949 | # only available once the broadcast's state is <code>live</code>. The |
| 1950 | # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1951 | # format. |
| 1952 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested |
| 1953 | # object in this object, the key is the name of the thumbnail image, and |
| 1954 | # the value is an object that contains other information about the |
| 1955 | # thumbnail. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1956 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1957 | "width": 42, # (Optional) Width of the thumbnail image. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1958 | "url": "A String", # The thumbnail image's URL. |
| 1959 | "height": 42, # (Optional) Height of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1960 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1961 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1962 | "width": 42, # (Optional) Width of the thumbnail image. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1963 | "url": "A String", # The thumbnail image's URL. |
| 1964 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1965 | }, |
| 1966 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 1967 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1968 | "url": "A String", # The thumbnail image's URL. |
| 1969 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1970 | }, |
| 1971 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 1972 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1973 | "url": "A String", # The thumbnail image's URL. |
| 1974 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1975 | }, |
| 1976 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 1977 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1978 | "url": "A String", # The thumbnail image's URL. |
| 1979 | "height": 42, # (Optional) Height of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1980 | }, |
| 1981 | }, |
| 1982 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1983 | "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string |
| 1984 | # <code>"youtube#liveBroadcast"</code>. |
| 1985 | "contentDetails": { # Detailed settings of a broadcast. # The <code>contentDetails</code> object contains information about the |
| 1986 | # event's video content, such as whether the content can be shown in an |
| 1987 | # embedded video player or if it will be archived and therefore available |
| 1988 | # for viewing after the event has concluded. |
| 1989 | "boundStreamId": "A String", # This value uniquely identifies the |
| 1990 | # <code><a href="/youtube/v3/live/docs/liveStreams">live stream</a></code> |
| 1991 | # bound to the broadcast. |
| 1992 | "closedCaptionsType": "A String", |
| 1993 | "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin |
| 1994 | # with an <a |
| 1995 | # href="/youtube/v3/live/getting-started#Displaying_Slates">in-stream |
| 1996 | # slate</a> when you update the broadcast's status to <code>live</code>. |
| 1997 | # After updating the status, you then need to send a |
| 1998 | # <code><a |
| 1999 | # href="/youtube/v3/live/docs/liveCuepoints/insert">liveCuepoints.insert</a></code> |
| 2000 | # request that sets the cuepoint's <code>eventState</code> to |
| 2001 | # <code>end</code> to remove the in-stream slate and make your broadcast |
| 2002 | # stream visible to viewers. |
| 2003 | "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by |
| 2004 | # <code>boundStreamId</code> was last updated. |
| 2005 | "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while |
| 2006 | # watching the video. DVR controls enable the viewer to control the video |
| 2007 | # playback experience by pausing, rewinding, or fast forwarding content. |
| 2008 | # The default value for this property is <code>true</code>.<br><br> |
| 2009 | # |
| 2010 | # <strong>Important:</strong> You must set the value to <code>true</code> |
| 2011 | # and also set the <code>enableArchive</code> property's value to |
| 2012 | # <code>true</code> if you want to make playback available immediately |
| 2013 | # after the broadcast ends. |
| 2014 | "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an |
| 2015 | # embedded player. If you choose to archive the video (using the |
| 2016 | # <code>enableArchive</code> property), this setting will also apply to |
| 2017 | # the archived video. |
| 2018 | "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for |
| 2019 | # this broadcast. The ingestion URL of the closed captions is returned |
| 2020 | # through the liveStreams API. This is mutually exclusive with using the |
| 2021 | # <code>closed_captions_type</code> property, and is equivalent to setting |
| 2022 | # <code>closed_captions_type</code> to CLOSED_CAPTIONS_HTTP_POST. |
| 2023 | "recordFromStart": True or False, # Automatically start recording after the event goes live. |
| 2024 | # The default value for this property is <code>true</code>.<br><br> |
| 2025 | # |
| 2026 | # <strong>Important:</strong> You must also set the <code>enableDvr</code> |
| 2027 | # property's value to |
| 2028 | # <code>true</code> if you want the playback to be available immediately |
| 2029 | # after the broadcast ends. If you set this property's value to |
| 2030 | # <code>true</code> but do not also set the <code>enableDvr</code> property |
| 2031 | # to <code>true</code>, there may be a delay of around one day before the |
| 2032 | # archived video will be available for playback. |
| 2033 | "monitorStream": { # Settings and Info of the monitor stream # The <code>monitorStream</code> object contains information about the |
| 2034 | # monitor stream, which the broadcaster can use to review the event |
| 2035 | # content before the broadcast stream is shown publicly. |
| 2036 | "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream. |
| 2037 | "broadcastStreamDelayMs": 42, # If you have set the |
| 2038 | # <code><a href="#enableMonitorStream">enableMonitorStream</a></code> |
| 2039 | # property to <code>true</code>, then this property determines the |
| 2040 | # length of the live broadcast delay. |
| 2041 | "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the |
| 2042 | # broadcast. If the monitor stream is enabled, then YouTube will |
| 2043 | # broadcast the event content on a special stream intended only for |
| 2044 | # the broadcaster's consumption. The broadcaster can use the stream |
| 2045 | # to review the event content and also to identify the optimal times |
| 2046 | # to insert cuepoints.<br><br> |
| 2047 | # You need to set this value to <code>true</code> if you intend to have |
| 2048 | # a broadcast delay for your event.<br><br> |
| 2049 | # <strong>Note:</strong> This property cannot be updated once the |
| 2050 | # broadcast is in the <code>testing</code> or <code>live</code> state. |
| 2051 | }, |
| 2052 | "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption |
| 2053 | # for the broadcast. |
| 2054 | "enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. |
| 2055 | # The default value for this property is <code>false</code>.<br><br> |
| 2056 | # This setting can only be used by Events. |
| 2057 | "latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. |
| 2058 | # LATENCY_NORMAL should match enable_low_latency=false |
| 2059 | # LATENCY_LOW should match enable_low_latency=true |
| 2060 | # LATENCY_ULTRA_LOW should have enable_low_latency omitted. |
| 2061 | "projection": "A String", # The projection format of this broadcast. This defaults to |
| 2062 | # <code>rectangular</code>. |
| 2063 | "mesh": "A String", # The mesh for projecting the video if <code>projection</code> is |
| 2064 | # <code>mesh</code>. The mesh value must be a UTF-8 string containing the |
| 2065 | # base-64 encoding of 3D mesh data that follows the <a |
| 2066 | # href="https://github.com/google/spatial-media/blob/master/docs/spherical-video-v2-rfc.md"> |
| 2067 | # Spherical Video V2 RFC specification</a> for an mshp box, excluding the box |
| 2068 | # size and type but including the following four reserved zero bytes for the |
| 2069 | # version and flags. |
| 2070 | "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. |
| 2071 | "enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. |
| 2072 | # The default value for this property is <code>false</code>.<br><br> |
| 2073 | # This setting can only be used by Events. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2074 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2075 | "status": { # Live broadcast state. # The <code>status</code> object contains information about the event's |
| 2076 | # status. |
| 2077 | "selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be |
| 2078 | # kids only: go/live-cw-work. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2079 | "recordingStatus": "A String", # The broadcast's recording status. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2080 | "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents |
| 2081 | # exactly one YouTube video, so the privacy settings are identical to |
| 2082 | # those supported for videos. In addition, you can set this field by |
| 2083 | # modifying the broadcast resource or by setting the |
| 2084 | # <code><a |
| 2085 | # href="/youtube/v3/docs/videos#status.privacyStatus" |
| 2086 | # >privacyStatus</a></code> |
| 2087 | # field of the corresponding video resource. |
| 2088 | "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's |
| 2089 | # <code><a |
| 2090 | # href="/youtube/v3/live/docs/liveBroadcasts/transition" |
| 2091 | # >liveBroadcasts.transition</a></code> method. |
| 2092 | "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state). |
| 2093 | "madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead |
| 2094 | # of the creator. This field is read only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2095 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2096 | }</pre> |
| 2097 | </div> |
| 2098 | |
| 2099 | </body></html> |