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