| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.liveBroadcasts.html">liveBroadcasts</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#bind">bind(id, part, onBehalfOfContentOwnerChannel=None, streamId=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Bind a broadcast to a stream.</p> |
| <p class="toc_element"> |
| <code><a href="#control">control(id, part, onBehalfOfContentOwner=None, offsetTimeMs=None, displaySlate=None, walltime=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Slate and recording control of the live broadcast.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Delete a given broadcast.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Inserts a new stream for the authenticated user.</p> |
| <p class="toc_element"> |
| <code><a href="#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> |
| <p class="firstline">Retrieve the list of broadcasts associated with the given channel.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#transition">transition(id, broadcastStatus, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Transition a broadcast to a given status.</p> |
| <p class="toc_element"> |
| <code><a href="#update">update(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates an existing broadcast for the authenticated user.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="bind">bind(id, part, onBehalfOfContentOwnerChannel=None, streamId=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| <pre>Bind a broadcast to a stream. |
| |
| Args: |
| id: string, Broadcast to bind to the stream (required) |
| part: string, The <code><strong>part</strong></code> parameter specifies a |
| comma-separated list of one or more <code>liveBroadcast</code> resource |
| properties that the API response will include. The <code>part</code> names |
| that you can include in the parameter value are <code>id</code>, |
| <code>snippet</code>, <code>contentDetails</code>, and <code>status</code>. (required) (repeated) |
| onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| href="/youtube/v3/guides/authentication">authorized request</a>. |
| <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwnerChannel</strong></code> parameter |
| specifies the YouTube channel ID of the channel to which a video is being |
| added. This parameter is required when a request specifies a value for the |
| <code>onBehalfOfContentOwner</code> parameter, and it can only be used in |
| conjunction with that parameter. In addition, the request must be |
| authorized using a CMS account that is linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| specifies must be linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>This |
| parameter is intended for YouTube content partners that own and manage many |
| different YouTube channels. It allows content owners to authenticate once |
| and perform actions on behalf of the channel specified in the parameter |
| value, without having to provide authentication credentials for each |
| separate channel. |
| streamId: string, Stream to bind, if not set unbind the current one. |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| that the |
| request's authorization credentials identify a YouTube CMS user who is |
| acting on behalf of the content owner specified in the parameter value. |
| This parameter is intended for YouTube content partners that own and manage |
| many different YouTube channels. It allows content owners to authenticate |
| once and get access to all their video and channel data, without having to |
| provide authentication credentials for each individual channel. The CMS |
| account that the user authenticates with must be linked to the specified |
| YouTube content owner. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A <code><strong>liveBroadcast</strong></code> resource represents an event |
| # that will be streamed, via live video, on YouTube. |
| "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast. |
| "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 |
| # stats. These include concurrent viewers and total chat count. Statistics |
| # can change (in either direction) during the lifetime of an event. |
| # Statistics are only returned while the event is live. |
| # at the time of the request. Statistics are only returned for live broadcasts. |
| "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The |
| # property and its value will be present if the broadcast is public, has |
| # the live chat feature enabled, and has at least one message. Note that |
| # this field will not be filled after the broadcast ends. So this property |
| # would not identify the number of chat messages for an archived video of a |
| # completed live broadcast. |
| }, |
| "etag": "A String", # Etag of this resource. |
| "snippet": { # Basic broadcast information. # The <code>snippet</code> object contains basic details about the event, |
| # including its title, description, start time, and end time. |
| "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value |
| # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # is publishing the broadcast. |
| "description": "A String", # The broadcast's description. As with the <code>title</code>, you can set |
| # this field by modifying the broadcast resource or by setting the |
| # <code><a |
| # href="/youtube/v3/docs/videos#snippet.description">description</a></code> |
| # field of the corresponding video resource. |
| "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one |
| # YouTube video. You can set this field by modifying the broadcast resource |
| # or by setting the |
| # <code><a href="/youtube/v3/docs/videos#snippet.title">title</a></code> |
| # field of the corresponding video resource. |
| "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast |
| # schedule. The value is specified in |
| # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "liveChatId": "A String", # The id of the live chat for this broadcast. |
| "isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. |
| # Internal only. |
| "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is |
| # only available once the broadcast's state is <code>complete</code>. The |
| # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value |
| # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is |
| # only available once the broadcast's state is <code>live</code>. The |
| # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested |
| # object in this object, the key is the name of the thumbnail image, and |
| # the value is an object that contains other information about the |
| # thumbnail. |
| "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| }, |
| }, |
| "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#liveBroadcast"</code>. |
| "contentDetails": { # Detailed settings of a broadcast. # The <code>contentDetails</code> object contains information about the |
| # event's video content, such as whether the content can be shown in an |
| # embedded video player or if it will be archived and therefore available |
| # for viewing after the event has concluded. |
| "boundStreamId": "A String", # This value uniquely identifies the |
| # <code><a href="/youtube/v3/live/docs/liveStreams">live stream</a></code> |
| # bound to the broadcast. |
| "closedCaptionsType": "A String", |
| "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin |
| # with an <a |
| # href="/youtube/v3/live/getting-started#Displaying_Slates">in-stream |
| # slate</a> when you update the broadcast's status to <code>live</code>. |
| # After updating the status, you then need to send a |
| # <code><a |
| # href="/youtube/v3/live/docs/liveCuepoints/insert">liveCuepoints.insert</a></code> |
| # request that sets the cuepoint's <code>eventState</code> to |
| # <code>end</code> to remove the in-stream slate and make your broadcast |
| # stream visible to viewers. |
| "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by |
| # <code>boundStreamId</code> was last updated. |
| "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while |
| # watching the video. DVR controls enable the viewer to control the video |
| # playback experience by pausing, rewinding, or fast forwarding content. |
| # The default value for this property is <code>true</code>.<br><br> |
| # |
| # <strong>Important:</strong> You must set the value to <code>true</code> |
| # and also set the <code>enableArchive</code> property's value to |
| # <code>true</code> if you want to make playback available immediately |
| # after the broadcast ends. |
| "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an |
| # embedded player. If you choose to archive the video (using the |
| # <code>enableArchive</code> property), this setting will also apply to |
| # the archived video. |
| "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for |
| # this broadcast. The ingestion URL of the closed captions is returned |
| # through the liveStreams API. This is mutually exclusive with using the |
| # <code>closed_captions_type</code> property, and is equivalent to setting |
| # <code>closed_captions_type</code> to CLOSED_CAPTIONS_HTTP_POST. |
| "recordFromStart": True or False, # Automatically start recording after the event goes live. |
| # The default value for this property is <code>true</code>.<br><br> |
| # |
| # <strong>Important:</strong> You must also set the <code>enableDvr</code> |
| # property's value to |
| # <code>true</code> if you want the playback to be available immediately |
| # after the broadcast ends. If you set this property's value to |
| # <code>true</code> but do not also set the <code>enableDvr</code> property |
| # to <code>true</code>, there may be a delay of around one day before the |
| # archived video will be available for playback. |
| "monitorStream": { # Settings and Info of the monitor stream # The <code>monitorStream</code> object contains information about the |
| # monitor stream, which the broadcaster can use to review the event |
| # content before the broadcast stream is shown publicly. |
| "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream. |
| "broadcastStreamDelayMs": 42, # If you have set the |
| # <code><a href="#enableMonitorStream">enableMonitorStream</a></code> |
| # property to <code>true</code>, then this property determines the |
| # length of the live broadcast delay. |
| "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the |
| # broadcast. If the monitor stream is enabled, then YouTube will |
| # broadcast the event content on a special stream intended only for |
| # the broadcaster's consumption. The broadcaster can use the stream |
| # to review the event content and also to identify the optimal times |
| # to insert cuepoints.<br><br> |
| # You need to set this value to <code>true</code> if you intend to have |
| # a broadcast delay for your event.<br><br> |
| # <strong>Note:</strong> This property cannot be updated once the |
| # broadcast is in the <code>testing</code> or <code>live</code> state. |
| }, |
| "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption |
| # for the broadcast. |
| "enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. |
| # The default value for this property is <code>false</code>.<br><br> |
| # This setting can only be used by Events. |
| "latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. |
| # LATENCY_NORMAL should match enable_low_latency=false |
| # LATENCY_LOW should match enable_low_latency=true |
| # LATENCY_ULTRA_LOW should have enable_low_latency omitted. |
| "projection": "A String", # The projection format of this broadcast. This defaults to |
| # <code>rectangular</code>. |
| "mesh": "A String", # The mesh for projecting the video if <code>projection</code> is |
| # <code>mesh</code>. The mesh value must be a UTF-8 string containing the |
| # base-64 encoding of 3D mesh data that follows the <a |
| # href="https://github.com/google/spatial-media/blob/master/docs/spherical-video-v2-rfc.md"> |
| # Spherical Video V2 RFC specification</a> for an mshp box, excluding the box |
| # size and type but including the following four reserved zero bytes for the |
| # version and flags. |
| "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. |
| "enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. |
| # The default value for this property is <code>false</code>.<br><br> |
| # This setting can only be used by Events. |
| }, |
| "status": { # Live broadcast state. # The <code>status</code> object contains information about the event's |
| # status. |
| "selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be |
| # kids only: go/live-cw-work. |
| "recordingStatus": "A String", # The broadcast's recording status. |
| "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents |
| # exactly one YouTube video, so the privacy settings are identical to |
| # those supported for videos. In addition, you can set this field by |
| # modifying the broadcast resource or by setting the |
| # <code><a |
| # href="/youtube/v3/docs/videos#status.privacyStatus" |
| # >privacyStatus</a></code> |
| # field of the corresponding video resource. |
| "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's |
| # <code><a |
| # href="/youtube/v3/live/docs/liveBroadcasts/transition" |
| # >liveBroadcasts.transition</a></code> method. |
| "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state). |
| "madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead |
| # of the creator. This field is read only. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="control">control(id, part, onBehalfOfContentOwner=None, offsetTimeMs=None, displaySlate=None, walltime=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code> |
| <pre>Slate and recording control of the live broadcast. |
| Support actions: slate on/off, recording start/stop/pause/resume. |
| Design doc: goto/yt-api-liveBroadcast-control |
| |
| Args: |
| id: string, Broadcast to operate. (required) |
| part: string, The <code><strong>part</strong></code> parameter specifies a |
| comma-separated list of one or more <code>liveBroadcast</code> resource |
| properties that the API response will include. The <code>part</code> names |
| that you can include in the parameter value are <code>id</code>, |
| <code>snippet</code>, <code>contentDetails</code>, and <code>status</code>. (required) (repeated) |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| that the |
| request's authorization credentials identify a YouTube CMS user who is |
| acting on behalf of the content owner specified in the parameter value. |
| This parameter is intended for YouTube content partners that own and manage |
| many different YouTube channels. It allows content owners to authenticate |
| once and get access to all their video and channel data, without having to |
| provide authentication credentials for each individual channel. The CMS |
| account that the user authenticates with must be linked to the specified |
| YouTube content owner. |
| offsetTimeMs: string, The exact time when the actions (e.g. slate on) are executed. |
| It is an offset from the first frame of the monitor stream. |
| If not set, it means "now" or ASAP. |
| This field should not be set if the monitor stream is disabled, |
| otherwise an error will be returned. |
| displaySlate: boolean, Whether display or hide slate. |
| walltime: string, The wall clock time at which the action should be executed. |
| Only one of offset_time_ms and walltime may be set at a time. |
| onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| href="/youtube/v3/guides/authentication">authorized request</a>. |
| <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwnerChannel</strong></code> parameter |
| specifies the YouTube channel ID of the channel to which a video is being |
| added. This parameter is required when a request specifies a value for the |
| <code>onBehalfOfContentOwner</code> parameter, and it can only be used in |
| conjunction with that parameter. In addition, the request must be |
| authorized using a CMS account that is linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| specifies must be linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>This |
| parameter is intended for YouTube content partners that own and manage many |
| different YouTube channels. It allows content owners to authenticate once |
| and perform actions on behalf of the channel specified in the parameter |
| value, without having to provide authentication credentials for each |
| separate channel. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A <code><strong>liveBroadcast</strong></code> resource represents an event |
| # that will be streamed, via live video, on YouTube. |
| "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast. |
| "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 |
| # stats. These include concurrent viewers and total chat count. Statistics |
| # can change (in either direction) during the lifetime of an event. |
| # Statistics are only returned while the event is live. |
| # at the time of the request. Statistics are only returned for live broadcasts. |
| "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The |
| # property and its value will be present if the broadcast is public, has |
| # the live chat feature enabled, and has at least one message. Note that |
| # this field will not be filled after the broadcast ends. So this property |
| # would not identify the number of chat messages for an archived video of a |
| # completed live broadcast. |
| }, |
| "etag": "A String", # Etag of this resource. |
| "snippet": { # Basic broadcast information. # The <code>snippet</code> object contains basic details about the event, |
| # including its title, description, start time, and end time. |
| "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value |
| # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # is publishing the broadcast. |
| "description": "A String", # The broadcast's description. As with the <code>title</code>, you can set |
| # this field by modifying the broadcast resource or by setting the |
| # <code><a |
| # href="/youtube/v3/docs/videos#snippet.description">description</a></code> |
| # field of the corresponding video resource. |
| "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one |
| # YouTube video. You can set this field by modifying the broadcast resource |
| # or by setting the |
| # <code><a href="/youtube/v3/docs/videos#snippet.title">title</a></code> |
| # field of the corresponding video resource. |
| "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast |
| # schedule. The value is specified in |
| # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "liveChatId": "A String", # The id of the live chat for this broadcast. |
| "isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. |
| # Internal only. |
| "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is |
| # only available once the broadcast's state is <code>complete</code>. The |
| # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value |
| # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is |
| # only available once the broadcast's state is <code>live</code>. The |
| # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested |
| # object in this object, the key is the name of the thumbnail image, and |
| # the value is an object that contains other information about the |
| # thumbnail. |
| "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| }, |
| }, |
| "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#liveBroadcast"</code>. |
| "contentDetails": { # Detailed settings of a broadcast. # The <code>contentDetails</code> object contains information about the |
| # event's video content, such as whether the content can be shown in an |
| # embedded video player or if it will be archived and therefore available |
| # for viewing after the event has concluded. |
| "boundStreamId": "A String", # This value uniquely identifies the |
| # <code><a href="/youtube/v3/live/docs/liveStreams">live stream</a></code> |
| # bound to the broadcast. |
| "closedCaptionsType": "A String", |
| "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin |
| # with an <a |
| # href="/youtube/v3/live/getting-started#Displaying_Slates">in-stream |
| # slate</a> when you update the broadcast's status to <code>live</code>. |
| # After updating the status, you then need to send a |
| # <code><a |
| # href="/youtube/v3/live/docs/liveCuepoints/insert">liveCuepoints.insert</a></code> |
| # request that sets the cuepoint's <code>eventState</code> to |
| # <code>end</code> to remove the in-stream slate and make your broadcast |
| # stream visible to viewers. |
| "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by |
| # <code>boundStreamId</code> was last updated. |
| "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while |
| # watching the video. DVR controls enable the viewer to control the video |
| # playback experience by pausing, rewinding, or fast forwarding content. |
| # The default value for this property is <code>true</code>.<br><br> |
| # |
| # <strong>Important:</strong> You must set the value to <code>true</code> |
| # and also set the <code>enableArchive</code> property's value to |
| # <code>true</code> if you want to make playback available immediately |
| # after the broadcast ends. |
| "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an |
| # embedded player. If you choose to archive the video (using the |
| # <code>enableArchive</code> property), this setting will also apply to |
| # the archived video. |
| "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for |
| # this broadcast. The ingestion URL of the closed captions is returned |
| # through the liveStreams API. This is mutually exclusive with using the |
| # <code>closed_captions_type</code> property, and is equivalent to setting |
| # <code>closed_captions_type</code> to CLOSED_CAPTIONS_HTTP_POST. |
| "recordFromStart": True or False, # Automatically start recording after the event goes live. |
| # The default value for this property is <code>true</code>.<br><br> |
| # |
| # <strong>Important:</strong> You must also set the <code>enableDvr</code> |
| # property's value to |
| # <code>true</code> if you want the playback to be available immediately |
| # after the broadcast ends. If you set this property's value to |
| # <code>true</code> but do not also set the <code>enableDvr</code> property |
| # to <code>true</code>, there may be a delay of around one day before the |
| # archived video will be available for playback. |
| "monitorStream": { # Settings and Info of the monitor stream # The <code>monitorStream</code> object contains information about the |
| # monitor stream, which the broadcaster can use to review the event |
| # content before the broadcast stream is shown publicly. |
| "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream. |
| "broadcastStreamDelayMs": 42, # If you have set the |
| # <code><a href="#enableMonitorStream">enableMonitorStream</a></code> |
| # property to <code>true</code>, then this property determines the |
| # length of the live broadcast delay. |
| "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the |
| # broadcast. If the monitor stream is enabled, then YouTube will |
| # broadcast the event content on a special stream intended only for |
| # the broadcaster's consumption. The broadcaster can use the stream |
| # to review the event content and also to identify the optimal times |
| # to insert cuepoints.<br><br> |
| # You need to set this value to <code>true</code> if you intend to have |
| # a broadcast delay for your event.<br><br> |
| # <strong>Note:</strong> This property cannot be updated once the |
| # broadcast is in the <code>testing</code> or <code>live</code> state. |
| }, |
| "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption |
| # for the broadcast. |
| "enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. |
| # The default value for this property is <code>false</code>.<br><br> |
| # This setting can only be used by Events. |
| "latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. |
| # LATENCY_NORMAL should match enable_low_latency=false |
| # LATENCY_LOW should match enable_low_latency=true |
| # LATENCY_ULTRA_LOW should have enable_low_latency omitted. |
| "projection": "A String", # The projection format of this broadcast. This defaults to |
| # <code>rectangular</code>. |
| "mesh": "A String", # The mesh for projecting the video if <code>projection</code> is |
| # <code>mesh</code>. The mesh value must be a UTF-8 string containing the |
| # base-64 encoding of 3D mesh data that follows the <a |
| # href="https://github.com/google/spatial-media/blob/master/docs/spherical-video-v2-rfc.md"> |
| # Spherical Video V2 RFC specification</a> for an mshp box, excluding the box |
| # size and type but including the following four reserved zero bytes for the |
| # version and flags. |
| "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. |
| "enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. |
| # The default value for this property is <code>false</code>.<br><br> |
| # This setting can only be used by Events. |
| }, |
| "status": { # Live broadcast state. # The <code>status</code> object contains information about the event's |
| # status. |
| "selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be |
| # kids only: go/live-cw-work. |
| "recordingStatus": "A String", # The broadcast's recording status. |
| "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents |
| # exactly one YouTube video, so the privacy settings are identical to |
| # those supported for videos. In addition, you can set this field by |
| # modifying the broadcast resource or by setting the |
| # <code><a |
| # href="/youtube/v3/docs/videos#status.privacyStatus" |
| # >privacyStatus</a></code> |
| # field of the corresponding video resource. |
| "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's |
| # <code><a |
| # href="/youtube/v3/live/docs/liveBroadcasts/transition" |
| # >liveBroadcasts.transition</a></code> method. |
| "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state). |
| "madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead |
| # of the creator. This field is read only. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code> |
| <pre>Delete a given broadcast. |
| |
| Args: |
| id: string, Broadcast to delete. (required) |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| that the |
| request's authorization credentials identify a YouTube CMS user who is |
| acting on behalf of the content owner specified in the parameter value. |
| This parameter is intended for YouTube content partners that own and manage |
| many different YouTube channels. It allows content owners to authenticate |
| once and get access to all their video and channel data, without having to |
| provide authentication credentials for each individual channel. The CMS |
| account that the user authenticates with must be linked to the specified |
| YouTube content owner. |
| onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| href="/youtube/v3/guides/authentication">authorized request</a>. |
| <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwnerChannel</strong></code> parameter |
| specifies the YouTube channel ID of the channel to which a video is being |
| added. This parameter is required when a request specifies a value for the |
| <code>onBehalfOfContentOwner</code> parameter, and it can only be used in |
| conjunction with that parameter. In addition, the request must be |
| authorized using a CMS account that is linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| specifies must be linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>This |
| parameter is intended for YouTube content partners that own and manage many |
| different YouTube channels. It allows content owners to authenticate once |
| and perform actions on behalf of the channel specified in the parameter |
| value, without having to provide authentication credentials for each |
| separate channel. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code> |
| <pre>Inserts a new stream for the authenticated user. |
| |
| Args: |
| part: string, The <code><strong>part</strong></code> parameter serves two purposes in |
| this operation. It identifies the properties that the write operation will |
| set as well as the properties that the API response will |
| include.<br><br>The <code>part</code> properties that you can include in |
| the parameter value are <code>id</code>, <code>snippet</code>, |
| <code>contentDetails</code>, and <code>status</code>. (required) (repeated) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A <code><strong>liveBroadcast</strong></code> resource represents an event |
| # that will be streamed, via live video, on YouTube. |
| "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast. |
| "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 |
| # stats. These include concurrent viewers and total chat count. Statistics |
| # can change (in either direction) during the lifetime of an event. |
| # Statistics are only returned while the event is live. |
| # at the time of the request. Statistics are only returned for live broadcasts. |
| "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The |
| # property and its value will be present if the broadcast is public, has |
| # the live chat feature enabled, and has at least one message. Note that |
| # this field will not be filled after the broadcast ends. So this property |
| # would not identify the number of chat messages for an archived video of a |
| # completed live broadcast. |
| }, |
| "etag": "A String", # Etag of this resource. |
| "snippet": { # Basic broadcast information. # The <code>snippet</code> object contains basic details about the event, |
| # including its title, description, start time, and end time. |
| "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value |
| # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # is publishing the broadcast. |
| "description": "A String", # The broadcast's description. As with the <code>title</code>, you can set |
| # this field by modifying the broadcast resource or by setting the |
| # <code><a |
| # href="/youtube/v3/docs/videos#snippet.description">description</a></code> |
| # field of the corresponding video resource. |
| "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one |
| # YouTube video. You can set this field by modifying the broadcast resource |
| # or by setting the |
| # <code><a href="/youtube/v3/docs/videos#snippet.title">title</a></code> |
| # field of the corresponding video resource. |
| "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast |
| # schedule. The value is specified in |
| # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "liveChatId": "A String", # The id of the live chat for this broadcast. |
| "isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. |
| # Internal only. |
| "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is |
| # only available once the broadcast's state is <code>complete</code>. The |
| # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value |
| # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is |
| # only available once the broadcast's state is <code>live</code>. The |
| # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested |
| # object in this object, the key is the name of the thumbnail image, and |
| # the value is an object that contains other information about the |
| # thumbnail. |
| "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| }, |
| }, |
| "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#liveBroadcast"</code>. |
| "contentDetails": { # Detailed settings of a broadcast. # The <code>contentDetails</code> object contains information about the |
| # event's video content, such as whether the content can be shown in an |
| # embedded video player or if it will be archived and therefore available |
| # for viewing after the event has concluded. |
| "boundStreamId": "A String", # This value uniquely identifies the |
| # <code><a href="/youtube/v3/live/docs/liveStreams">live stream</a></code> |
| # bound to the broadcast. |
| "closedCaptionsType": "A String", |
| "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin |
| # with an <a |
| # href="/youtube/v3/live/getting-started#Displaying_Slates">in-stream |
| # slate</a> when you update the broadcast's status to <code>live</code>. |
| # After updating the status, you then need to send a |
| # <code><a |
| # href="/youtube/v3/live/docs/liveCuepoints/insert">liveCuepoints.insert</a></code> |
| # request that sets the cuepoint's <code>eventState</code> to |
| # <code>end</code> to remove the in-stream slate and make your broadcast |
| # stream visible to viewers. |
| "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by |
| # <code>boundStreamId</code> was last updated. |
| "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while |
| # watching the video. DVR controls enable the viewer to control the video |
| # playback experience by pausing, rewinding, or fast forwarding content. |
| # The default value for this property is <code>true</code>.<br><br> |
| # |
| # <strong>Important:</strong> You must set the value to <code>true</code> |
| # and also set the <code>enableArchive</code> property's value to |
| # <code>true</code> if you want to make playback available immediately |
| # after the broadcast ends. |
| "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an |
| # embedded player. If you choose to archive the video (using the |
| # <code>enableArchive</code> property), this setting will also apply to |
| # the archived video. |
| "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for |
| # this broadcast. The ingestion URL of the closed captions is returned |
| # through the liveStreams API. This is mutually exclusive with using the |
| # <code>closed_captions_type</code> property, and is equivalent to setting |
| # <code>closed_captions_type</code> to CLOSED_CAPTIONS_HTTP_POST. |
| "recordFromStart": True or False, # Automatically start recording after the event goes live. |
| # The default value for this property is <code>true</code>.<br><br> |
| # |
| # <strong>Important:</strong> You must also set the <code>enableDvr</code> |
| # property's value to |
| # <code>true</code> if you want the playback to be available immediately |
| # after the broadcast ends. If you set this property's value to |
| # <code>true</code> but do not also set the <code>enableDvr</code> property |
| # to <code>true</code>, there may be a delay of around one day before the |
| # archived video will be available for playback. |
| "monitorStream": { # Settings and Info of the monitor stream # The <code>monitorStream</code> object contains information about the |
| # monitor stream, which the broadcaster can use to review the event |
| # content before the broadcast stream is shown publicly. |
| "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream. |
| "broadcastStreamDelayMs": 42, # If you have set the |
| # <code><a href="#enableMonitorStream">enableMonitorStream</a></code> |
| # property to <code>true</code>, then this property determines the |
| # length of the live broadcast delay. |
| "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the |
| # broadcast. If the monitor stream is enabled, then YouTube will |
| # broadcast the event content on a special stream intended only for |
| # the broadcaster's consumption. The broadcaster can use the stream |
| # to review the event content and also to identify the optimal times |
| # to insert cuepoints.<br><br> |
| # You need to set this value to <code>true</code> if you intend to have |
| # a broadcast delay for your event.<br><br> |
| # <strong>Note:</strong> This property cannot be updated once the |
| # broadcast is in the <code>testing</code> or <code>live</code> state. |
| }, |
| "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption |
| # for the broadcast. |
| "enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. |
| # The default value for this property is <code>false</code>.<br><br> |
| # This setting can only be used by Events. |
| "latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. |
| # LATENCY_NORMAL should match enable_low_latency=false |
| # LATENCY_LOW should match enable_low_latency=true |
| # LATENCY_ULTRA_LOW should have enable_low_latency omitted. |
| "projection": "A String", # The projection format of this broadcast. This defaults to |
| # <code>rectangular</code>. |
| "mesh": "A String", # The mesh for projecting the video if <code>projection</code> is |
| # <code>mesh</code>. The mesh value must be a UTF-8 string containing the |
| # base-64 encoding of 3D mesh data that follows the <a |
| # href="https://github.com/google/spatial-media/blob/master/docs/spherical-video-v2-rfc.md"> |
| # Spherical Video V2 RFC specification</a> for an mshp box, excluding the box |
| # size and type but including the following four reserved zero bytes for the |
| # version and flags. |
| "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. |
| "enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. |
| # The default value for this property is <code>false</code>.<br><br> |
| # This setting can only be used by Events. |
| }, |
| "status": { # Live broadcast state. # The <code>status</code> object contains information about the event's |
| # status. |
| "selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be |
| # kids only: go/live-cw-work. |
| "recordingStatus": "A String", # The broadcast's recording status. |
| "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents |
| # exactly one YouTube video, so the privacy settings are identical to |
| # those supported for videos. In addition, you can set this field by |
| # modifying the broadcast resource or by setting the |
| # <code><a |
| # href="/youtube/v3/docs/videos#status.privacyStatus" |
| # >privacyStatus</a></code> |
| # field of the corresponding video resource. |
| "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's |
| # <code><a |
| # href="/youtube/v3/live/docs/liveBroadcasts/transition" |
| # >liveBroadcasts.transition</a></code> method. |
| "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state). |
| "madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead |
| # of the creator. This field is read only. |
| }, |
| } |
| |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| that the |
| request's authorization credentials identify a YouTube CMS user who is |
| acting on behalf of the content owner specified in the parameter value. |
| This parameter is intended for YouTube content partners that own and manage |
| many different YouTube channels. It allows content owners to authenticate |
| once and get access to all their video and channel data, without having to |
| provide authentication credentials for each individual channel. The CMS |
| account that the user authenticates with must be linked to the specified |
| YouTube content owner. |
| onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| href="/youtube/v3/guides/authentication">authorized request</a>. |
| <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwnerChannel</strong></code> parameter |
| specifies the YouTube channel ID of the channel to which a video is being |
| added. This parameter is required when a request specifies a value for the |
| <code>onBehalfOfContentOwner</code> parameter, and it can only be used in |
| conjunction with that parameter. In addition, the request must be |
| authorized using a CMS account that is linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| specifies must be linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>This |
| parameter is intended for YouTube content partners that own and manage many |
| different YouTube channels. It allows content owners to authenticate once |
| and perform actions on behalf of the channel specified in the parameter |
| value, without having to provide authentication credentials for each |
| separate channel. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A <code><strong>liveBroadcast</strong></code> resource represents an event |
| # that will be streamed, via live video, on YouTube. |
| "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast. |
| "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 |
| # stats. These include concurrent viewers and total chat count. Statistics |
| # can change (in either direction) during the lifetime of an event. |
| # Statistics are only returned while the event is live. |
| # at the time of the request. Statistics are only returned for live broadcasts. |
| "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The |
| # property and its value will be present if the broadcast is public, has |
| # the live chat feature enabled, and has at least one message. Note that |
| # this field will not be filled after the broadcast ends. So this property |
| # would not identify the number of chat messages for an archived video of a |
| # completed live broadcast. |
| }, |
| "etag": "A String", # Etag of this resource. |
| "snippet": { # Basic broadcast information. # The <code>snippet</code> object contains basic details about the event, |
| # including its title, description, start time, and end time. |
| "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value |
| # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # is publishing the broadcast. |
| "description": "A String", # The broadcast's description. As with the <code>title</code>, you can set |
| # this field by modifying the broadcast resource or by setting the |
| # <code><a |
| # href="/youtube/v3/docs/videos#snippet.description">description</a></code> |
| # field of the corresponding video resource. |
| "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one |
| # YouTube video. You can set this field by modifying the broadcast resource |
| # or by setting the |
| # <code><a href="/youtube/v3/docs/videos#snippet.title">title</a></code> |
| # field of the corresponding video resource. |
| "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast |
| # schedule. The value is specified in |
| # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "liveChatId": "A String", # The id of the live chat for this broadcast. |
| "isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. |
| # Internal only. |
| "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is |
| # only available once the broadcast's state is <code>complete</code>. The |
| # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value |
| # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is |
| # only available once the broadcast's state is <code>live</code>. The |
| # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested |
| # object in this object, the key is the name of the thumbnail image, and |
| # the value is an object that contains other information about the |
| # thumbnail. |
| "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| }, |
| }, |
| "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#liveBroadcast"</code>. |
| "contentDetails": { # Detailed settings of a broadcast. # The <code>contentDetails</code> object contains information about the |
| # event's video content, such as whether the content can be shown in an |
| # embedded video player or if it will be archived and therefore available |
| # for viewing after the event has concluded. |
| "boundStreamId": "A String", # This value uniquely identifies the |
| # <code><a href="/youtube/v3/live/docs/liveStreams">live stream</a></code> |
| # bound to the broadcast. |
| "closedCaptionsType": "A String", |
| "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin |
| # with an <a |
| # href="/youtube/v3/live/getting-started#Displaying_Slates">in-stream |
| # slate</a> when you update the broadcast's status to <code>live</code>. |
| # After updating the status, you then need to send a |
| # <code><a |
| # href="/youtube/v3/live/docs/liveCuepoints/insert">liveCuepoints.insert</a></code> |
| # request that sets the cuepoint's <code>eventState</code> to |
| # <code>end</code> to remove the in-stream slate and make your broadcast |
| # stream visible to viewers. |
| "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by |
| # <code>boundStreamId</code> was last updated. |
| "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while |
| # watching the video. DVR controls enable the viewer to control the video |
| # playback experience by pausing, rewinding, or fast forwarding content. |
| # The default value for this property is <code>true</code>.<br><br> |
| # |
| # <strong>Important:</strong> You must set the value to <code>true</code> |
| # and also set the <code>enableArchive</code> property's value to |
| # <code>true</code> if you want to make playback available immediately |
| # after the broadcast ends. |
| "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an |
| # embedded player. If you choose to archive the video (using the |
| # <code>enableArchive</code> property), this setting will also apply to |
| # the archived video. |
| "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for |
| # this broadcast. The ingestion URL of the closed captions is returned |
| # through the liveStreams API. This is mutually exclusive with using the |
| # <code>closed_captions_type</code> property, and is equivalent to setting |
| # <code>closed_captions_type</code> to CLOSED_CAPTIONS_HTTP_POST. |
| "recordFromStart": True or False, # Automatically start recording after the event goes live. |
| # The default value for this property is <code>true</code>.<br><br> |
| # |
| # <strong>Important:</strong> You must also set the <code>enableDvr</code> |
| # property's value to |
| # <code>true</code> if you want the playback to be available immediately |
| # after the broadcast ends. If you set this property's value to |
| # <code>true</code> but do not also set the <code>enableDvr</code> property |
| # to <code>true</code>, there may be a delay of around one day before the |
| # archived video will be available for playback. |
| "monitorStream": { # Settings and Info of the monitor stream # The <code>monitorStream</code> object contains information about the |
| # monitor stream, which the broadcaster can use to review the event |
| # content before the broadcast stream is shown publicly. |
| "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream. |
| "broadcastStreamDelayMs": 42, # If you have set the |
| # <code><a href="#enableMonitorStream">enableMonitorStream</a></code> |
| # property to <code>true</code>, then this property determines the |
| # length of the live broadcast delay. |
| "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the |
| # broadcast. If the monitor stream is enabled, then YouTube will |
| # broadcast the event content on a special stream intended only for |
| # the broadcaster's consumption. The broadcaster can use the stream |
| # to review the event content and also to identify the optimal times |
| # to insert cuepoints.<br><br> |
| # You need to set this value to <code>true</code> if you intend to have |
| # a broadcast delay for your event.<br><br> |
| # <strong>Note:</strong> This property cannot be updated once the |
| # broadcast is in the <code>testing</code> or <code>live</code> state. |
| }, |
| "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption |
| # for the broadcast. |
| "enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. |
| # The default value for this property is <code>false</code>.<br><br> |
| # This setting can only be used by Events. |
| "latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. |
| # LATENCY_NORMAL should match enable_low_latency=false |
| # LATENCY_LOW should match enable_low_latency=true |
| # LATENCY_ULTRA_LOW should have enable_low_latency omitted. |
| "projection": "A String", # The projection format of this broadcast. This defaults to |
| # <code>rectangular</code>. |
| "mesh": "A String", # The mesh for projecting the video if <code>projection</code> is |
| # <code>mesh</code>. The mesh value must be a UTF-8 string containing the |
| # base-64 encoding of 3D mesh data that follows the <a |
| # href="https://github.com/google/spatial-media/blob/master/docs/spherical-video-v2-rfc.md"> |
| # Spherical Video V2 RFC specification</a> for an mshp box, excluding the box |
| # size and type but including the following four reserved zero bytes for the |
| # version and flags. |
| "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. |
| "enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. |
| # The default value for this property is <code>false</code>.<br><br> |
| # This setting can only be used by Events. |
| }, |
| "status": { # Live broadcast state. # The <code>status</code> object contains information about the event's |
| # status. |
| "selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be |
| # kids only: go/live-cw-work. |
| "recordingStatus": "A String", # The broadcast's recording status. |
| "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents |
| # exactly one YouTube video, so the privacy settings are identical to |
| # those supported for videos. In addition, you can set this field by |
| # modifying the broadcast resource or by setting the |
| # <code><a |
| # href="/youtube/v3/docs/videos#status.privacyStatus" |
| # >privacyStatus</a></code> |
| # field of the corresponding video resource. |
| "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's |
| # <code><a |
| # href="/youtube/v3/live/docs/liveBroadcasts/transition" |
| # >liveBroadcasts.transition</a></code> method. |
| "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state). |
| "madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead |
| # of the creator. This field is read only. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <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> |
| <pre>Retrieve the list of broadcasts associated with the given channel. |
| |
| Args: |
| part: string, The <code><strong>part</strong></code> parameter specifies a |
| comma-separated list of one or more <code>liveBroadcast</code> resource |
| properties that the API response will include. The <code>part</code> names |
| that you can include in the parameter value are <code>id</code>, |
| <code>snippet</code>, <code>contentDetails</code>, and <code>status</code>. (required) (repeated) |
| pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific |
| page in the result set that should be returned. In an API response, the |
| <code>nextPageToken</code> and <code>prevPageToken</code> properties |
| identify other pages that could be retrieved. |
| broadcastType: string, Return only broadcasts with the selected type. |
| maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the |
| maximum number of items that should be returned in the result set. |
| broadcastStatus: string, Return broadcasts with a certain status, e.g. active broadcasts. |
| mine: boolean, A parameter |
| onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| href="/youtube/v3/guides/authentication">authorized request</a>. |
| <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwnerChannel</strong></code> parameter |
| specifies the YouTube channel ID of the channel to which a video is being |
| added. This parameter is required when a request specifies a value for the |
| <code>onBehalfOfContentOwner</code> parameter, and it can only be used in |
| conjunction with that parameter. In addition, the request must be |
| authorized using a CMS account that is linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| specifies must be linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>This |
| parameter is intended for YouTube content partners that own and manage many |
| different YouTube channels. It allows content owners to authenticate once |
| and perform actions on behalf of the channel specified in the parameter |
| value, without having to provide authentication credentials for each |
| separate channel. |
| id: string, Return broadcasts with the given ids from Stubby or Apiary. (repeated) |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| that the |
| request's authorization credentials identify a YouTube CMS user who is |
| acting on behalf of the content owner specified in the parameter value. |
| This parameter is intended for YouTube content partners that own and manage |
| many different YouTube channels. It allows content owners to authenticate |
| once and get access to all their video and channel data, without having to |
| provide authentication credentials for each individual channel. The CMS |
| account that the user authenticates with must be linked to the specified |
| YouTube content owner. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "eventId": "A String", # Serialized EventId of the request which produced this response. |
| "items": [ # A list of broadcasts that match the request criteria. |
| { # A <code><strong>liveBroadcast</strong></code> resource represents an event |
| # that will be streamed, via live video, on YouTube. |
| "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast. |
| "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 |
| # stats. These include concurrent viewers and total chat count. Statistics |
| # can change (in either direction) during the lifetime of an event. |
| # Statistics are only returned while the event is live. |
| # at the time of the request. Statistics are only returned for live broadcasts. |
| "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The |
| # property and its value will be present if the broadcast is public, has |
| # the live chat feature enabled, and has at least one message. Note that |
| # this field will not be filled after the broadcast ends. So this property |
| # would not identify the number of chat messages for an archived video of a |
| # completed live broadcast. |
| }, |
| "etag": "A String", # Etag of this resource. |
| "snippet": { # Basic broadcast information. # The <code>snippet</code> object contains basic details about the event, |
| # including its title, description, start time, and end time. |
| "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value |
| # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # is publishing the broadcast. |
| "description": "A String", # The broadcast's description. As with the <code>title</code>, you can set |
| # this field by modifying the broadcast resource or by setting the |
| # <code><a |
| # href="/youtube/v3/docs/videos#snippet.description">description</a></code> |
| # field of the corresponding video resource. |
| "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one |
| # YouTube video. You can set this field by modifying the broadcast resource |
| # or by setting the |
| # <code><a href="/youtube/v3/docs/videos#snippet.title">title</a></code> |
| # field of the corresponding video resource. |
| "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast |
| # schedule. The value is specified in |
| # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "liveChatId": "A String", # The id of the live chat for this broadcast. |
| "isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. |
| # Internal only. |
| "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is |
| # only available once the broadcast's state is <code>complete</code>. The |
| # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value |
| # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is |
| # only available once the broadcast's state is <code>live</code>. The |
| # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested |
| # object in this object, the key is the name of the thumbnail image, and |
| # the value is an object that contains other information about the |
| # thumbnail. |
| "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| }, |
| }, |
| "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#liveBroadcast"</code>. |
| "contentDetails": { # Detailed settings of a broadcast. # The <code>contentDetails</code> object contains information about the |
| # event's video content, such as whether the content can be shown in an |
| # embedded video player or if it will be archived and therefore available |
| # for viewing after the event has concluded. |
| "boundStreamId": "A String", # This value uniquely identifies the |
| # <code><a href="/youtube/v3/live/docs/liveStreams">live stream</a></code> |
| # bound to the broadcast. |
| "closedCaptionsType": "A String", |
| "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin |
| # with an <a |
| # href="/youtube/v3/live/getting-started#Displaying_Slates">in-stream |
| # slate</a> when you update the broadcast's status to <code>live</code>. |
| # After updating the status, you then need to send a |
| # <code><a |
| # href="/youtube/v3/live/docs/liveCuepoints/insert">liveCuepoints.insert</a></code> |
| # request that sets the cuepoint's <code>eventState</code> to |
| # <code>end</code> to remove the in-stream slate and make your broadcast |
| # stream visible to viewers. |
| "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by |
| # <code>boundStreamId</code> was last updated. |
| "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while |
| # watching the video. DVR controls enable the viewer to control the video |
| # playback experience by pausing, rewinding, or fast forwarding content. |
| # The default value for this property is <code>true</code>.<br><br> |
| # |
| # <strong>Important:</strong> You must set the value to <code>true</code> |
| # and also set the <code>enableArchive</code> property's value to |
| # <code>true</code> if you want to make playback available immediately |
| # after the broadcast ends. |
| "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an |
| # embedded player. If you choose to archive the video (using the |
| # <code>enableArchive</code> property), this setting will also apply to |
| # the archived video. |
| "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for |
| # this broadcast. The ingestion URL of the closed captions is returned |
| # through the liveStreams API. This is mutually exclusive with using the |
| # <code>closed_captions_type</code> property, and is equivalent to setting |
| # <code>closed_captions_type</code> to CLOSED_CAPTIONS_HTTP_POST. |
| "recordFromStart": True or False, # Automatically start recording after the event goes live. |
| # The default value for this property is <code>true</code>.<br><br> |
| # |
| # <strong>Important:</strong> You must also set the <code>enableDvr</code> |
| # property's value to |
| # <code>true</code> if you want the playback to be available immediately |
| # after the broadcast ends. If you set this property's value to |
| # <code>true</code> but do not also set the <code>enableDvr</code> property |
| # to <code>true</code>, there may be a delay of around one day before the |
| # archived video will be available for playback. |
| "monitorStream": { # Settings and Info of the monitor stream # The <code>monitorStream</code> object contains information about the |
| # monitor stream, which the broadcaster can use to review the event |
| # content before the broadcast stream is shown publicly. |
| "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream. |
| "broadcastStreamDelayMs": 42, # If you have set the |
| # <code><a href="#enableMonitorStream">enableMonitorStream</a></code> |
| # property to <code>true</code>, then this property determines the |
| # length of the live broadcast delay. |
| "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the |
| # broadcast. If the monitor stream is enabled, then YouTube will |
| # broadcast the event content on a special stream intended only for |
| # the broadcaster's consumption. The broadcaster can use the stream |
| # to review the event content and also to identify the optimal times |
| # to insert cuepoints.<br><br> |
| # You need to set this value to <code>true</code> if you intend to have |
| # a broadcast delay for your event.<br><br> |
| # <strong>Note:</strong> This property cannot be updated once the |
| # broadcast is in the <code>testing</code> or <code>live</code> state. |
| }, |
| "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption |
| # for the broadcast. |
| "enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. |
| # The default value for this property is <code>false</code>.<br><br> |
| # This setting can only be used by Events. |
| "latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. |
| # LATENCY_NORMAL should match enable_low_latency=false |
| # LATENCY_LOW should match enable_low_latency=true |
| # LATENCY_ULTRA_LOW should have enable_low_latency omitted. |
| "projection": "A String", # The projection format of this broadcast. This defaults to |
| # <code>rectangular</code>. |
| "mesh": "A String", # The mesh for projecting the video if <code>projection</code> is |
| # <code>mesh</code>. The mesh value must be a UTF-8 string containing the |
| # base-64 encoding of 3D mesh data that follows the <a |
| # href="https://github.com/google/spatial-media/blob/master/docs/spherical-video-v2-rfc.md"> |
| # Spherical Video V2 RFC specification</a> for an mshp box, excluding the box |
| # size and type but including the following four reserved zero bytes for the |
| # version and flags. |
| "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. |
| "enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. |
| # The default value for this property is <code>false</code>.<br><br> |
| # This setting can only be used by Events. |
| }, |
| "status": { # Live broadcast state. # The <code>status</code> object contains information about the event's |
| # status. |
| "selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be |
| # kids only: go/live-cw-work. |
| "recordingStatus": "A String", # The broadcast's recording status. |
| "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents |
| # exactly one YouTube video, so the privacy settings are identical to |
| # those supported for videos. In addition, you can set this field by |
| # modifying the broadcast resource or by setting the |
| # <code><a |
| # href="/youtube/v3/docs/videos#status.privacyStatus" |
| # >privacyStatus</a></code> |
| # field of the corresponding video resource. |
| "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's |
| # <code><a |
| # href="/youtube/v3/live/docs/liveBroadcasts/transition" |
| # >liveBroadcasts.transition</a></code> method. |
| "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state). |
| "madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead |
| # of the creator. This field is read only. |
| }, |
| }, |
| ], |
| "pageInfo": { # Paging details for lists of resources, including total number of items # General pagination information. |
| # available and number of resources returned in a single page. |
| "resultsPerPage": 42, # The number of results included in the API response. |
| "totalResults": 42, # The total number of results in the result set. |
| }, |
| "etag": "A String", # Etag of this resource. |
| "visitorId": "A String", # The <code>visitorId</code> identifies the visitor. |
| "prevPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code> |
| # parameter to retrieve the previous page in the result set. |
| "tokenPagination": { # Stub token pagination template to suppress results. |
| }, |
| "kind": "youtube#liveBroadcastListResponse", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#liveBroadcastListResponse"</code>. |
| "nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code> |
| # parameter to retrieve the next page in the result set. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="transition">transition(id, broadcastStatus, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code> |
| <pre>Transition a broadcast to a given status. |
| |
| Args: |
| id: string, Broadcast to transition. (required) |
| broadcastStatus: string, The status to which the broadcast is going to transition. (required) |
| part: string, The <code><strong>part</strong></code> parameter specifies a |
| comma-separated list of one or more <code>liveBroadcast</code> resource |
| properties that the API response will include. The <code>part</code> names |
| that you can include in the parameter value are <code>id</code>, |
| <code>snippet</code>, <code>contentDetails</code>, and <code>status</code>. (required) (repeated) |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| that the |
| request's authorization credentials identify a YouTube CMS user who is |
| acting on behalf of the content owner specified in the parameter value. |
| This parameter is intended for YouTube content partners that own and manage |
| many different YouTube channels. It allows content owners to authenticate |
| once and get access to all their video and channel data, without having to |
| provide authentication credentials for each individual channel. The CMS |
| account that the user authenticates with must be linked to the specified |
| YouTube content owner. |
| onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| href="/youtube/v3/guides/authentication">authorized request</a>. |
| <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwnerChannel</strong></code> parameter |
| specifies the YouTube channel ID of the channel to which a video is being |
| added. This parameter is required when a request specifies a value for the |
| <code>onBehalfOfContentOwner</code> parameter, and it can only be used in |
| conjunction with that parameter. In addition, the request must be |
| authorized using a CMS account that is linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| specifies must be linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>This |
| parameter is intended for YouTube content partners that own and manage many |
| different YouTube channels. It allows content owners to authenticate once |
| and perform actions on behalf of the channel specified in the parameter |
| value, without having to provide authentication credentials for each |
| separate channel. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A <code><strong>liveBroadcast</strong></code> resource represents an event |
| # that will be streamed, via live video, on YouTube. |
| "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast. |
| "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 |
| # stats. These include concurrent viewers and total chat count. Statistics |
| # can change (in either direction) during the lifetime of an event. |
| # Statistics are only returned while the event is live. |
| # at the time of the request. Statistics are only returned for live broadcasts. |
| "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The |
| # property and its value will be present if the broadcast is public, has |
| # the live chat feature enabled, and has at least one message. Note that |
| # this field will not be filled after the broadcast ends. So this property |
| # would not identify the number of chat messages for an archived video of a |
| # completed live broadcast. |
| }, |
| "etag": "A String", # Etag of this resource. |
| "snippet": { # Basic broadcast information. # The <code>snippet</code> object contains basic details about the event, |
| # including its title, description, start time, and end time. |
| "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value |
| # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # is publishing the broadcast. |
| "description": "A String", # The broadcast's description. As with the <code>title</code>, you can set |
| # this field by modifying the broadcast resource or by setting the |
| # <code><a |
| # href="/youtube/v3/docs/videos#snippet.description">description</a></code> |
| # field of the corresponding video resource. |
| "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one |
| # YouTube video. You can set this field by modifying the broadcast resource |
| # or by setting the |
| # <code><a href="/youtube/v3/docs/videos#snippet.title">title</a></code> |
| # field of the corresponding video resource. |
| "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast |
| # schedule. The value is specified in |
| # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "liveChatId": "A String", # The id of the live chat for this broadcast. |
| "isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. |
| # Internal only. |
| "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is |
| # only available once the broadcast's state is <code>complete</code>. The |
| # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value |
| # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is |
| # only available once the broadcast's state is <code>live</code>. The |
| # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested |
| # object in this object, the key is the name of the thumbnail image, and |
| # the value is an object that contains other information about the |
| # thumbnail. |
| "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| }, |
| }, |
| "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#liveBroadcast"</code>. |
| "contentDetails": { # Detailed settings of a broadcast. # The <code>contentDetails</code> object contains information about the |
| # event's video content, such as whether the content can be shown in an |
| # embedded video player or if it will be archived and therefore available |
| # for viewing after the event has concluded. |
| "boundStreamId": "A String", # This value uniquely identifies the |
| # <code><a href="/youtube/v3/live/docs/liveStreams">live stream</a></code> |
| # bound to the broadcast. |
| "closedCaptionsType": "A String", |
| "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin |
| # with an <a |
| # href="/youtube/v3/live/getting-started#Displaying_Slates">in-stream |
| # slate</a> when you update the broadcast's status to <code>live</code>. |
| # After updating the status, you then need to send a |
| # <code><a |
| # href="/youtube/v3/live/docs/liveCuepoints/insert">liveCuepoints.insert</a></code> |
| # request that sets the cuepoint's <code>eventState</code> to |
| # <code>end</code> to remove the in-stream slate and make your broadcast |
| # stream visible to viewers. |
| "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by |
| # <code>boundStreamId</code> was last updated. |
| "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while |
| # watching the video. DVR controls enable the viewer to control the video |
| # playback experience by pausing, rewinding, or fast forwarding content. |
| # The default value for this property is <code>true</code>.<br><br> |
| # |
| # <strong>Important:</strong> You must set the value to <code>true</code> |
| # and also set the <code>enableArchive</code> property's value to |
| # <code>true</code> if you want to make playback available immediately |
| # after the broadcast ends. |
| "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an |
| # embedded player. If you choose to archive the video (using the |
| # <code>enableArchive</code> property), this setting will also apply to |
| # the archived video. |
| "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for |
| # this broadcast. The ingestion URL of the closed captions is returned |
| # through the liveStreams API. This is mutually exclusive with using the |
| # <code>closed_captions_type</code> property, and is equivalent to setting |
| # <code>closed_captions_type</code> to CLOSED_CAPTIONS_HTTP_POST. |
| "recordFromStart": True or False, # Automatically start recording after the event goes live. |
| # The default value for this property is <code>true</code>.<br><br> |
| # |
| # <strong>Important:</strong> You must also set the <code>enableDvr</code> |
| # property's value to |
| # <code>true</code> if you want the playback to be available immediately |
| # after the broadcast ends. If you set this property's value to |
| # <code>true</code> but do not also set the <code>enableDvr</code> property |
| # to <code>true</code>, there may be a delay of around one day before the |
| # archived video will be available for playback. |
| "monitorStream": { # Settings and Info of the monitor stream # The <code>monitorStream</code> object contains information about the |
| # monitor stream, which the broadcaster can use to review the event |
| # content before the broadcast stream is shown publicly. |
| "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream. |
| "broadcastStreamDelayMs": 42, # If you have set the |
| # <code><a href="#enableMonitorStream">enableMonitorStream</a></code> |
| # property to <code>true</code>, then this property determines the |
| # length of the live broadcast delay. |
| "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the |
| # broadcast. If the monitor stream is enabled, then YouTube will |
| # broadcast the event content on a special stream intended only for |
| # the broadcaster's consumption. The broadcaster can use the stream |
| # to review the event content and also to identify the optimal times |
| # to insert cuepoints.<br><br> |
| # You need to set this value to <code>true</code> if you intend to have |
| # a broadcast delay for your event.<br><br> |
| # <strong>Note:</strong> This property cannot be updated once the |
| # broadcast is in the <code>testing</code> or <code>live</code> state. |
| }, |
| "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption |
| # for the broadcast. |
| "enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. |
| # The default value for this property is <code>false</code>.<br><br> |
| # This setting can only be used by Events. |
| "latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. |
| # LATENCY_NORMAL should match enable_low_latency=false |
| # LATENCY_LOW should match enable_low_latency=true |
| # LATENCY_ULTRA_LOW should have enable_low_latency omitted. |
| "projection": "A String", # The projection format of this broadcast. This defaults to |
| # <code>rectangular</code>. |
| "mesh": "A String", # The mesh for projecting the video if <code>projection</code> is |
| # <code>mesh</code>. The mesh value must be a UTF-8 string containing the |
| # base-64 encoding of 3D mesh data that follows the <a |
| # href="https://github.com/google/spatial-media/blob/master/docs/spherical-video-v2-rfc.md"> |
| # Spherical Video V2 RFC specification</a> for an mshp box, excluding the box |
| # size and type but including the following four reserved zero bytes for the |
| # version and flags. |
| "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. |
| "enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. |
| # The default value for this property is <code>false</code>.<br><br> |
| # This setting can only be used by Events. |
| }, |
| "status": { # Live broadcast state. # The <code>status</code> object contains information about the event's |
| # status. |
| "selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be |
| # kids only: go/live-cw-work. |
| "recordingStatus": "A String", # The broadcast's recording status. |
| "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents |
| # exactly one YouTube video, so the privacy settings are identical to |
| # those supported for videos. In addition, you can set this field by |
| # modifying the broadcast resource or by setting the |
| # <code><a |
| # href="/youtube/v3/docs/videos#status.privacyStatus" |
| # >privacyStatus</a></code> |
| # field of the corresponding video resource. |
| "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's |
| # <code><a |
| # href="/youtube/v3/live/docs/liveBroadcasts/transition" |
| # >liveBroadcasts.transition</a></code> method. |
| "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state). |
| "madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead |
| # of the creator. This field is read only. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code> |
| <pre>Updates an existing broadcast for the authenticated user. |
| |
| Args: |
| part: string, The <code><strong>part</strong></code> parameter serves two purposes in |
| this operation. It identifies the properties that the write operation will |
| set as well as the properties that the API response will |
| include.<br><br>The <code>part</code> properties that you can include in |
| the parameter value are <code>id</code>, <code>snippet</code>, |
| <code>contentDetails</code>, and <code>status</code>.<br><br>Note that this |
| method will override the existing values for all of the mutable properties |
| that are contained in any parts that the parameter value specifies. For |
| example, a |
| broadcast's privacy status is defined in the <code>status</code> part. As |
| such, if your request is updating a private or unlisted broadcast, and the |
| request's <code>part</code> parameter value includes the |
| <code>status</code> part, the broadcast's privacy setting will be updated |
| to whatever value the request body specifies. If the request body does not |
| specify a value, the existing privacy setting will be removed and the |
| broadcast will revert to the default privacy setting. (required) (repeated) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A <code><strong>liveBroadcast</strong></code> resource represents an event |
| # that will be streamed, via live video, on YouTube. |
| "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast. |
| "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 |
| # stats. These include concurrent viewers and total chat count. Statistics |
| # can change (in either direction) during the lifetime of an event. |
| # Statistics are only returned while the event is live. |
| # at the time of the request. Statistics are only returned for live broadcasts. |
| "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The |
| # property and its value will be present if the broadcast is public, has |
| # the live chat feature enabled, and has at least one message. Note that |
| # this field will not be filled after the broadcast ends. So this property |
| # would not identify the number of chat messages for an archived video of a |
| # completed live broadcast. |
| }, |
| "etag": "A String", # Etag of this resource. |
| "snippet": { # Basic broadcast information. # The <code>snippet</code> object contains basic details about the event, |
| # including its title, description, start time, and end time. |
| "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value |
| # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # is publishing the broadcast. |
| "description": "A String", # The broadcast's description. As with the <code>title</code>, you can set |
| # this field by modifying the broadcast resource or by setting the |
| # <code><a |
| # href="/youtube/v3/docs/videos#snippet.description">description</a></code> |
| # field of the corresponding video resource. |
| "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one |
| # YouTube video. You can set this field by modifying the broadcast resource |
| # or by setting the |
| # <code><a href="/youtube/v3/docs/videos#snippet.title">title</a></code> |
| # field of the corresponding video resource. |
| "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast |
| # schedule. The value is specified in |
| # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "liveChatId": "A String", # The id of the live chat for this broadcast. |
| "isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. |
| # Internal only. |
| "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is |
| # only available once the broadcast's state is <code>complete</code>. The |
| # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value |
| # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is |
| # only available once the broadcast's state is <code>live</code>. The |
| # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested |
| # object in this object, the key is the name of the thumbnail image, and |
| # the value is an object that contains other information about the |
| # thumbnail. |
| "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| }, |
| }, |
| "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#liveBroadcast"</code>. |
| "contentDetails": { # Detailed settings of a broadcast. # The <code>contentDetails</code> object contains information about the |
| # event's video content, such as whether the content can be shown in an |
| # embedded video player or if it will be archived and therefore available |
| # for viewing after the event has concluded. |
| "boundStreamId": "A String", # This value uniquely identifies the |
| # <code><a href="/youtube/v3/live/docs/liveStreams">live stream</a></code> |
| # bound to the broadcast. |
| "closedCaptionsType": "A String", |
| "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin |
| # with an <a |
| # href="/youtube/v3/live/getting-started#Displaying_Slates">in-stream |
| # slate</a> when you update the broadcast's status to <code>live</code>. |
| # After updating the status, you then need to send a |
| # <code><a |
| # href="/youtube/v3/live/docs/liveCuepoints/insert">liveCuepoints.insert</a></code> |
| # request that sets the cuepoint's <code>eventState</code> to |
| # <code>end</code> to remove the in-stream slate and make your broadcast |
| # stream visible to viewers. |
| "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by |
| # <code>boundStreamId</code> was last updated. |
| "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while |
| # watching the video. DVR controls enable the viewer to control the video |
| # playback experience by pausing, rewinding, or fast forwarding content. |
| # The default value for this property is <code>true</code>.<br><br> |
| # |
| # <strong>Important:</strong> You must set the value to <code>true</code> |
| # and also set the <code>enableArchive</code> property's value to |
| # <code>true</code> if you want to make playback available immediately |
| # after the broadcast ends. |
| "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an |
| # embedded player. If you choose to archive the video (using the |
| # <code>enableArchive</code> property), this setting will also apply to |
| # the archived video. |
| "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for |
| # this broadcast. The ingestion URL of the closed captions is returned |
| # through the liveStreams API. This is mutually exclusive with using the |
| # <code>closed_captions_type</code> property, and is equivalent to setting |
| # <code>closed_captions_type</code> to CLOSED_CAPTIONS_HTTP_POST. |
| "recordFromStart": True or False, # Automatically start recording after the event goes live. |
| # The default value for this property is <code>true</code>.<br><br> |
| # |
| # <strong>Important:</strong> You must also set the <code>enableDvr</code> |
| # property's value to |
| # <code>true</code> if you want the playback to be available immediately |
| # after the broadcast ends. If you set this property's value to |
| # <code>true</code> but do not also set the <code>enableDvr</code> property |
| # to <code>true</code>, there may be a delay of around one day before the |
| # archived video will be available for playback. |
| "monitorStream": { # Settings and Info of the monitor stream # The <code>monitorStream</code> object contains information about the |
| # monitor stream, which the broadcaster can use to review the event |
| # content before the broadcast stream is shown publicly. |
| "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream. |
| "broadcastStreamDelayMs": 42, # If you have set the |
| # <code><a href="#enableMonitorStream">enableMonitorStream</a></code> |
| # property to <code>true</code>, then this property determines the |
| # length of the live broadcast delay. |
| "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the |
| # broadcast. If the monitor stream is enabled, then YouTube will |
| # broadcast the event content on a special stream intended only for |
| # the broadcaster's consumption. The broadcaster can use the stream |
| # to review the event content and also to identify the optimal times |
| # to insert cuepoints.<br><br> |
| # You need to set this value to <code>true</code> if you intend to have |
| # a broadcast delay for your event.<br><br> |
| # <strong>Note:</strong> This property cannot be updated once the |
| # broadcast is in the <code>testing</code> or <code>live</code> state. |
| }, |
| "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption |
| # for the broadcast. |
| "enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. |
| # The default value for this property is <code>false</code>.<br><br> |
| # This setting can only be used by Events. |
| "latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. |
| # LATENCY_NORMAL should match enable_low_latency=false |
| # LATENCY_LOW should match enable_low_latency=true |
| # LATENCY_ULTRA_LOW should have enable_low_latency omitted. |
| "projection": "A String", # The projection format of this broadcast. This defaults to |
| # <code>rectangular</code>. |
| "mesh": "A String", # The mesh for projecting the video if <code>projection</code> is |
| # <code>mesh</code>. The mesh value must be a UTF-8 string containing the |
| # base-64 encoding of 3D mesh data that follows the <a |
| # href="https://github.com/google/spatial-media/blob/master/docs/spherical-video-v2-rfc.md"> |
| # Spherical Video V2 RFC specification</a> for an mshp box, excluding the box |
| # size and type but including the following four reserved zero bytes for the |
| # version and flags. |
| "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. |
| "enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. |
| # The default value for this property is <code>false</code>.<br><br> |
| # This setting can only be used by Events. |
| }, |
| "status": { # Live broadcast state. # The <code>status</code> object contains information about the event's |
| # status. |
| "selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be |
| # kids only: go/live-cw-work. |
| "recordingStatus": "A String", # The broadcast's recording status. |
| "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents |
| # exactly one YouTube video, so the privacy settings are identical to |
| # those supported for videos. In addition, you can set this field by |
| # modifying the broadcast resource or by setting the |
| # <code><a |
| # href="/youtube/v3/docs/videos#status.privacyStatus" |
| # >privacyStatus</a></code> |
| # field of the corresponding video resource. |
| "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's |
| # <code><a |
| # href="/youtube/v3/live/docs/liveBroadcasts/transition" |
| # >liveBroadcasts.transition</a></code> method. |
| "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state). |
| "madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead |
| # of the creator. This field is read only. |
| }, |
| } |
| |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| that the |
| request's authorization credentials identify a YouTube CMS user who is |
| acting on behalf of the content owner specified in the parameter value. |
| This parameter is intended for YouTube content partners that own and manage |
| many different YouTube channels. It allows content owners to authenticate |
| once and get access to all their video and channel data, without having to |
| provide authentication credentials for each individual channel. The CMS |
| account that the user authenticates with must be linked to the specified |
| YouTube content owner. |
| onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| href="/youtube/v3/guides/authentication">authorized request</a>. |
| <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwnerChannel</strong></code> parameter |
| specifies the YouTube channel ID of the channel to which a video is being |
| added. This parameter is required when a request specifies a value for the |
| <code>onBehalfOfContentOwner</code> parameter, and it can only be used in |
| conjunction with that parameter. In addition, the request must be |
| authorized using a CMS account that is linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| specifies must be linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>This |
| parameter is intended for YouTube content partners that own and manage many |
| different YouTube channels. It allows content owners to authenticate once |
| and perform actions on behalf of the channel specified in the parameter |
| value, without having to provide authentication credentials for each |
| separate channel. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A <code><strong>liveBroadcast</strong></code> resource represents an event |
| # that will be streamed, via live video, on YouTube. |
| "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast. |
| "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 |
| # stats. These include concurrent viewers and total chat count. Statistics |
| # can change (in either direction) during the lifetime of an event. |
| # Statistics are only returned while the event is live. |
| # at the time of the request. Statistics are only returned for live broadcasts. |
| "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The |
| # property and its value will be present if the broadcast is public, has |
| # the live chat feature enabled, and has at least one message. Note that |
| # this field will not be filled after the broadcast ends. So this property |
| # would not identify the number of chat messages for an archived video of a |
| # completed live broadcast. |
| }, |
| "etag": "A String", # Etag of this resource. |
| "snippet": { # Basic broadcast information. # The <code>snippet</code> object contains basic details about the event, |
| # including its title, description, start time, and end time. |
| "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value |
| # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # is publishing the broadcast. |
| "description": "A String", # The broadcast's description. As with the <code>title</code>, you can set |
| # this field by modifying the broadcast resource or by setting the |
| # <code><a |
| # href="/youtube/v3/docs/videos#snippet.description">description</a></code> |
| # field of the corresponding video resource. |
| "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one |
| # YouTube video. You can set this field by modifying the broadcast resource |
| # or by setting the |
| # <code><a href="/youtube/v3/docs/videos#snippet.title">title</a></code> |
| # field of the corresponding video resource. |
| "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast |
| # schedule. The value is specified in |
| # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "liveChatId": "A String", # The id of the live chat for this broadcast. |
| "isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. |
| # Internal only. |
| "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is |
| # only available once the broadcast's state is <code>complete</code>. The |
| # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value |
| # is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is |
| # only available once the broadcast's state is <code>live</code>. The |
| # value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested |
| # object in this object, the key is the name of the thumbnail image, and |
| # the value is an object that contains other information about the |
| # thumbnail. |
| "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| }, |
| }, |
| "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#liveBroadcast"</code>. |
| "contentDetails": { # Detailed settings of a broadcast. # The <code>contentDetails</code> object contains information about the |
| # event's video content, such as whether the content can be shown in an |
| # embedded video player or if it will be archived and therefore available |
| # for viewing after the event has concluded. |
| "boundStreamId": "A String", # This value uniquely identifies the |
| # <code><a href="/youtube/v3/live/docs/liveStreams">live stream</a></code> |
| # bound to the broadcast. |
| "closedCaptionsType": "A String", |
| "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin |
| # with an <a |
| # href="/youtube/v3/live/getting-started#Displaying_Slates">in-stream |
| # slate</a> when you update the broadcast's status to <code>live</code>. |
| # After updating the status, you then need to send a |
| # <code><a |
| # href="/youtube/v3/live/docs/liveCuepoints/insert">liveCuepoints.insert</a></code> |
| # request that sets the cuepoint's <code>eventState</code> to |
| # <code>end</code> to remove the in-stream slate and make your broadcast |
| # stream visible to viewers. |
| "boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by |
| # <code>boundStreamId</code> was last updated. |
| "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while |
| # watching the video. DVR controls enable the viewer to control the video |
| # playback experience by pausing, rewinding, or fast forwarding content. |
| # The default value for this property is <code>true</code>.<br><br> |
| # |
| # <strong>Important:</strong> You must set the value to <code>true</code> |
| # and also set the <code>enableArchive</code> property's value to |
| # <code>true</code> if you want to make playback available immediately |
| # after the broadcast ends. |
| "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an |
| # embedded player. If you choose to archive the video (using the |
| # <code>enableArchive</code> property), this setting will also apply to |
| # the archived video. |
| "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for |
| # this broadcast. The ingestion URL of the closed captions is returned |
| # through the liveStreams API. This is mutually exclusive with using the |
| # <code>closed_captions_type</code> property, and is equivalent to setting |
| # <code>closed_captions_type</code> to CLOSED_CAPTIONS_HTTP_POST. |
| "recordFromStart": True or False, # Automatically start recording after the event goes live. |
| # The default value for this property is <code>true</code>.<br><br> |
| # |
| # <strong>Important:</strong> You must also set the <code>enableDvr</code> |
| # property's value to |
| # <code>true</code> if you want the playback to be available immediately |
| # after the broadcast ends. If you set this property's value to |
| # <code>true</code> but do not also set the <code>enableDvr</code> property |
| # to <code>true</code>, there may be a delay of around one day before the |
| # archived video will be available for playback. |
| "monitorStream": { # Settings and Info of the monitor stream # The <code>monitorStream</code> object contains information about the |
| # monitor stream, which the broadcaster can use to review the event |
| # content before the broadcast stream is shown publicly. |
| "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream. |
| "broadcastStreamDelayMs": 42, # If you have set the |
| # <code><a href="#enableMonitorStream">enableMonitorStream</a></code> |
| # property to <code>true</code>, then this property determines the |
| # length of the live broadcast delay. |
| "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the |
| # broadcast. If the monitor stream is enabled, then YouTube will |
| # broadcast the event content on a special stream intended only for |
| # the broadcaster's consumption. The broadcaster can use the stream |
| # to review the event content and also to identify the optimal times |
| # to insert cuepoints.<br><br> |
| # You need to set this value to <code>true</code> if you intend to have |
| # a broadcast delay for your event.<br><br> |
| # <strong>Note:</strong> This property cannot be updated once the |
| # broadcast is in the <code>testing</code> or <code>live</code> state. |
| }, |
| "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption |
| # for the broadcast. |
| "enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. |
| # The default value for this property is <code>false</code>.<br><br> |
| # This setting can only be used by Events. |
| "latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. |
| # LATENCY_NORMAL should match enable_low_latency=false |
| # LATENCY_LOW should match enable_low_latency=true |
| # LATENCY_ULTRA_LOW should have enable_low_latency omitted. |
| "projection": "A String", # The projection format of this broadcast. This defaults to |
| # <code>rectangular</code>. |
| "mesh": "A String", # The mesh for projecting the video if <code>projection</code> is |
| # <code>mesh</code>. The mesh value must be a UTF-8 string containing the |
| # base-64 encoding of 3D mesh data that follows the <a |
| # href="https://github.com/google/spatial-media/blob/master/docs/spherical-video-v2-rfc.md"> |
| # Spherical Video V2 RFC specification</a> for an mshp box, excluding the box |
| # size and type but including the following four reserved zero bytes for the |
| # version and flags. |
| "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. |
| "enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. |
| # The default value for this property is <code>false</code>.<br><br> |
| # This setting can only be used by Events. |
| }, |
| "status": { # Live broadcast state. # The <code>status</code> object contains information about the event's |
| # status. |
| "selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be |
| # kids only: go/live-cw-work. |
| "recordingStatus": "A String", # The broadcast's recording status. |
| "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents |
| # exactly one YouTube video, so the privacy settings are identical to |
| # those supported for videos. In addition, you can set this field by |
| # modifying the broadcast resource or by setting the |
| # <code><a |
| # href="/youtube/v3/docs/videos#status.privacyStatus" |
| # >privacyStatus</a></code> |
| # field of the corresponding video resource. |
| "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's |
| # <code><a |
| # href="/youtube/v3/live/docs/liveBroadcasts/transition" |
| # >liveBroadcasts.transition</a></code> method. |
| "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state). |
| "madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead |
| # of the creator. This field is read only. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
