blob: ffa626b70d983f5120854681fe1b5a2fb05d8b6b [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.liveBroadcasts.html">liveBroadcasts</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#bind">bind(id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, streamId=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -070079<p class="firstline">Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast.</p>
80<p class="toc_element">
81 <code><a href="#bind_direct">bind_direct(id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, streamId=None)</a></code></p>
82<p class="firstline">Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast.</p>
John Asmuth614db982014-04-24 15:46:26 -040083<p class="toc_element">
84 <code><a href="#control">control(id, part, onBehalfOfContentOwner=None, displaySlate=None, onBehalfOfContentOwnerChannel=None, offsetTimeMs=None, walltime=None)</a></code></p>
85<p class="firstline">Controls the settings for a slate that can be displayed in the broadcast stream.</p>
86<p class="toc_element">
87 <code><a href="#delete">delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</a></code></p>
88<p class="firstline">Deletes a broadcast.</p>
89<p class="toc_element">
90 <code><a href="#insert">insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</a></code></p>
91<p class="firstline">Creates a broadcast.</p>
92<p class="toc_element">
93 <code><a href="#list">list(part, broadcastStatus=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, maxResults=None, mine=None, id=None)</a></code></p>
94<p class="firstline">Returns a list of YouTube broadcasts that match the API request parameters.</p>
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">
99 <code><a href="#transition">transition(broadcastStatus, id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</a></code></p>
100<p class="firstline">Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream. Before calling this method, you should confirm that the value of the status.streamStatus property for the stream bound to your broadcast is active.</p>
101<p class="toc_element">
102 <code><a href="#update">update(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</a></code></p>
103<p class="firstline">Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object.</p>
104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="bind">bind(id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, streamId=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700107 <pre>Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast.
John Asmuth614db982014-04-24 15:46:26 -0400108
109Args:
110 id: string, The id parameter specifies the unique ID of the broadcast that is being bound to a video stream. (required)
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)
112 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
113
114The 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.
115 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
116
117The 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.
118
119This 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.
120 streamId: string, The streamId parameter specifies the unique ID of the video stream that is being bound to a broadcast. If this parameter is omitted, the API will remove any existing binding between the broadcast and a video stream.
121
122Returns:
123 An object of the form:
124
125 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
126 "status": { # The status object contains information about the event's status.
127 "recordingStatus": "A String", # The broadcast's recording status.
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 "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
Craig Citro065b5302014-08-14 00:47:23 -0700130 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400131 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000132 "topicDetails": {
133 "topics": [
134 {
135 "snippet": { # Information about the topic matched.
136 "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
137 "name": "A String", # The name of the topic.
138 },
139 "type": "A String", # The type of the topic.
140 "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
141 },
142 ],
143 },
John Asmuth614db982014-04-24 15:46:26 -0400144 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000145 "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.
146 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
147 "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.
148 },
John Asmuth614db982014-04-24 15:46:26 -0400149 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000150 "enableLowLatency": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400151 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
152 "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.
153 "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000154 "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.
John Asmuth614db982014-04-24 15:46:26 -0400155 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
156 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
157 #
158 #
159 #
160 # 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.
161 "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.
162 #
163 #
164 #
165 # 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.
166 "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.
167 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
168 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
169 "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.
170 #
171 # You need to set this value to true if you intend to have a broadcast delay for your event.
172 #
173 # Note: This property cannot be updated once the broadcast is in the testing or live state.
174 },
175 },
176 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
177 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
178 "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.
179 "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.
180 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
181 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700182 "liveChatId": "A String", # The id of the live chat for this broadcast.
183 "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
184 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
185 "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
186 "isDefaultBroadcast": True or False,
187 "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.
188 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
189 "url": "A String", # The thumbnail image's URL.
190 "width": 42, # (Optional) Width of the thumbnail image.
191 "height": 42, # (Optional) Height of the thumbnail image.
192 },
193 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
194 "url": "A String", # The thumbnail image's URL.
195 "width": 42, # (Optional) Width of the thumbnail image.
196 "height": 42, # (Optional) Height of the thumbnail image.
197 },
198 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
199 "url": "A String", # The thumbnail image's URL.
200 "width": 42, # (Optional) Width of the thumbnail image.
201 "height": 42, # (Optional) Height of the thumbnail image.
202 },
203 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
204 "url": "A String", # The thumbnail image's URL.
205 "width": 42, # (Optional) Width of the thumbnail image.
206 "height": 42, # (Optional) Height of the thumbnail image.
207 },
208 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
209 "url": "A String", # The thumbnail image's URL.
210 "width": 42, # (Optional) Width of the thumbnail image.
211 "height": 42, # (Optional) Height of the thumbnail image.
212 },
213 },
214 },
215 "etag": "A String", # Etag of this resource.
216 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
217 }</pre>
218</div>
219
220<div class="method">
221 <code class="details" id="bind_direct">bind_direct(id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, streamId=None)</code>
222 <pre>Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast.
223
224Args:
225 id: string, The id parameter specifies the unique ID of the broadcast that is being bound to a video stream. (required)
226 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)
227 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
228
229The 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.
230 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
231
232The 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.
233
234This 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.
235 streamId: string, The streamId parameter specifies the unique ID of the video stream that is being bound to a broadcast. If this parameter is omitted, the API will remove any existing binding between the broadcast and a video stream.
236
237Returns:
238 An object of the form:
239
240 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
241 "status": { # The status object contains information about the event's status.
242 "recordingStatus": "A String", # The broadcast's recording status.
243 "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.
244 "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
245 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
246 },
247 "topicDetails": {
248 "topics": [
249 {
250 "snippet": { # Information about the topic matched.
251 "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
252 "name": "A String", # The name of the topic.
253 },
254 "type": "A String", # The type of the topic.
255 "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
256 },
257 ],
258 },
259 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
260 "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.
261 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
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 },
264 "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.
265 "enableLowLatency": True or False,
266 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
267 "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.
268 "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
269 "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.
270 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
271 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
272 #
273 #
274 #
275 # 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.
276 "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.
277 #
278 #
279 #
280 # 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.
281 "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.
282 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
283 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
284 "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.
285 #
286 # You need to set this value to true if you intend to have a broadcast delay for your event.
287 #
288 # Note: This property cannot be updated once the broadcast is in the testing or live state.
289 },
290 },
291 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
292 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
293 "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.
294 "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.
295 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
296 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
297 "liveChatId": "A String", # The id of the live chat for this broadcast.
John Asmuth614db982014-04-24 15:46:26 -0400298 "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
299 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
300 "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000301 "isDefaultBroadcast": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400302 "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.
303 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
304 "url": "A String", # The thumbnail image's URL.
305 "width": 42, # (Optional) Width of the thumbnail image.
306 "height": 42, # (Optional) Height of the thumbnail image.
307 },
308 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
309 "url": "A String", # The thumbnail image's URL.
310 "width": 42, # (Optional) Width of the thumbnail image.
311 "height": 42, # (Optional) Height of the thumbnail image.
312 },
313 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
314 "url": "A String", # The thumbnail image's URL.
315 "width": 42, # (Optional) Width of the thumbnail image.
316 "height": 42, # (Optional) Height of the thumbnail image.
317 },
318 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
319 "url": "A String", # The thumbnail image's URL.
320 "width": 42, # (Optional) Width of the thumbnail image.
321 "height": 42, # (Optional) Height of the thumbnail image.
322 },
323 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
324 "url": "A String", # The thumbnail image's URL.
325 "width": 42, # (Optional) Width of the thumbnail image.
326 "height": 42, # (Optional) Height of the thumbnail image.
327 },
328 },
329 },
330 "etag": "A String", # Etag of this resource.
331 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
332 }</pre>
333</div>
334
335<div class="method">
336 <code class="details" id="control">control(id, part, onBehalfOfContentOwner=None, displaySlate=None, onBehalfOfContentOwnerChannel=None, offsetTimeMs=None, walltime=None)</code>
337 <pre>Controls the settings for a slate that can be displayed in the broadcast stream.
338
339Args:
340 id: string, The id parameter specifies the YouTube live broadcast ID that uniquely identifies the broadcast in which the slate is being updated. (required)
341 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)
342 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
343
344The 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.
345 displaySlate: boolean, The displaySlate parameter specifies whether the slate is being enabled or disabled.
346 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
347
348The 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.
349
350This 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.
351 offsetTimeMs: string, The offsetTimeMs parameter specifies a positive time offset when the specified slate change will occur. The value is measured in milliseconds from the beginning of the broadcast's monitor stream, which is the time that the testing phase for the broadcast began. Even though it is specified in milliseconds, the value is actually an approximation, and YouTube completes the requested action as closely as possible to that time.
352
353If you do not specify a value for this parameter, then YouTube performs the action as soon as possible. See the Getting started guide for more details.
354
355Important: You should only specify a value for this parameter if your broadcast stream is delayed.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700356 walltime: string, The walltime parameter specifies the wall clock time at which the specified slate change will occur. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.
John Asmuth614db982014-04-24 15:46:26 -0400357
358Returns:
359 An object of the form:
360
361 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
362 "status": { # The status object contains information about the event's status.
363 "recordingStatus": "A String", # The broadcast's recording status.
364 "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.
365 "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
Craig Citro065b5302014-08-14 00:47:23 -0700366 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400367 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000368 "topicDetails": {
369 "topics": [
370 {
371 "snippet": { # Information about the topic matched.
372 "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
373 "name": "A String", # The name of the topic.
374 },
375 "type": "A String", # The type of the topic.
376 "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
377 },
378 ],
379 },
John Asmuth614db982014-04-24 15:46:26 -0400380 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000381 "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.
382 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
383 "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.
384 },
John Asmuth614db982014-04-24 15:46:26 -0400385 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000386 "enableLowLatency": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400387 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
388 "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.
389 "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000390 "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.
John Asmuth614db982014-04-24 15:46:26 -0400391 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
392 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
393 #
394 #
395 #
396 # 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.
397 "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.
398 #
399 #
400 #
401 # 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.
402 "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.
403 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
404 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
405 "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.
406 #
407 # You need to set this value to true if you intend to have a broadcast delay for your event.
408 #
409 # Note: This property cannot be updated once the broadcast is in the testing or live state.
410 },
411 },
412 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
413 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
414 "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.
415 "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.
416 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
417 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700418 "liveChatId": "A String", # The id of the live chat for this broadcast.
John Asmuth614db982014-04-24 15:46:26 -0400419 "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
420 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
421 "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000422 "isDefaultBroadcast": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400423 "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.
424 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
425 "url": "A String", # The thumbnail image's URL.
426 "width": 42, # (Optional) Width of the thumbnail image.
427 "height": 42, # (Optional) Height of the thumbnail image.
428 },
429 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
430 "url": "A String", # The thumbnail image's URL.
431 "width": 42, # (Optional) Width of the thumbnail image.
432 "height": 42, # (Optional) Height of the thumbnail image.
433 },
434 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
435 "url": "A String", # The thumbnail image's URL.
436 "width": 42, # (Optional) Width of the thumbnail image.
437 "height": 42, # (Optional) Height of the thumbnail image.
438 },
439 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
440 "url": "A String", # The thumbnail image's URL.
441 "width": 42, # (Optional) Width of the thumbnail image.
442 "height": 42, # (Optional) Height of the thumbnail image.
443 },
444 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
445 "url": "A String", # The thumbnail image's URL.
446 "width": 42, # (Optional) Width of the thumbnail image.
447 "height": 42, # (Optional) Height of the thumbnail image.
448 },
449 },
450 },
451 "etag": "A String", # Etag of this resource.
452 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
453 }</pre>
454</div>
455
456<div class="method">
457 <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
458 <pre>Deletes a broadcast.
459
460Args:
461 id: string, The id parameter specifies the YouTube live broadcast ID for the resource that is being deleted. (required)
462 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
463
464The 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.
465 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
466
467The 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.
468
469This 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.
470</pre>
471</div>
472
473<div class="method">
474 <code class="details" id="insert">insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
475 <pre>Creates a broadcast.
476
477Args:
478 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.
479
480The part properties that you can include in the parameter value are id, snippet, contentDetails, and status. (required)
481 body: object, The request body. (required)
482 The object takes the form of:
483
484{ # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
485 "status": { # The status object contains information about the event's status.
486 "recordingStatus": "A String", # The broadcast's recording status.
487 "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.
488 "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
Craig Citro065b5302014-08-14 00:47:23 -0700489 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400490 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000491 "topicDetails": {
492 "topics": [
493 {
494 "snippet": { # Information about the topic matched.
495 "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
496 "name": "A String", # The name of the topic.
497 },
498 "type": "A String", # The type of the topic.
499 "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
500 },
501 ],
502 },
John Asmuth614db982014-04-24 15:46:26 -0400503 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000504 "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.
505 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
506 "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.
507 },
John Asmuth614db982014-04-24 15:46:26 -0400508 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000509 "enableLowLatency": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400510 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
511 "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.
512 "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000513 "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.
John Asmuth614db982014-04-24 15:46:26 -0400514 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
515 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
516 #
517 #
518 #
519 # 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.
520 "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.
521 #
522 #
523 #
524 # 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.
525 "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.
526 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
527 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
528 "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.
529 #
530 # You need to set this value to true if you intend to have a broadcast delay for your event.
531 #
532 # Note: This property cannot be updated once the broadcast is in the testing or live state.
533 },
534 },
535 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
536 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
537 "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.
538 "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.
539 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
540 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700541 "liveChatId": "A String", # The id of the live chat for this broadcast.
John Asmuth614db982014-04-24 15:46:26 -0400542 "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
543 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
544 "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000545 "isDefaultBroadcast": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400546 "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.
547 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
548 "url": "A String", # The thumbnail image's URL.
549 "width": 42, # (Optional) Width of the thumbnail image.
550 "height": 42, # (Optional) Height of the thumbnail image.
551 },
552 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
553 "url": "A String", # The thumbnail image's URL.
554 "width": 42, # (Optional) Width of the thumbnail image.
555 "height": 42, # (Optional) Height of the thumbnail image.
556 },
557 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
558 "url": "A String", # The thumbnail image's URL.
559 "width": 42, # (Optional) Width of the thumbnail image.
560 "height": 42, # (Optional) Height of the thumbnail image.
561 },
562 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
563 "url": "A String", # The thumbnail image's URL.
564 "width": 42, # (Optional) Width of the thumbnail image.
565 "height": 42, # (Optional) Height of the thumbnail image.
566 },
567 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
568 "url": "A String", # The thumbnail image's URL.
569 "width": 42, # (Optional) Width of the thumbnail image.
570 "height": 42, # (Optional) Height of the thumbnail image.
571 },
572 },
573 },
574 "etag": "A String", # Etag of this resource.
575 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
576}
577
578 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
579
580The 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.
581 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
582
583The 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.
584
585This 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.
586
587Returns:
588 An object of the form:
589
590 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
591 "status": { # The status object contains information about the event's status.
592 "recordingStatus": "A String", # The broadcast's recording status.
593 "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.
594 "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
Craig Citro065b5302014-08-14 00:47:23 -0700595 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400596 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000597 "topicDetails": {
598 "topics": [
599 {
600 "snippet": { # Information about the topic matched.
601 "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
602 "name": "A String", # The name of the topic.
603 },
604 "type": "A String", # The type of the topic.
605 "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
606 },
607 ],
608 },
John Asmuth614db982014-04-24 15:46:26 -0400609 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000610 "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.
611 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
612 "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.
613 },
John Asmuth614db982014-04-24 15:46:26 -0400614 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000615 "enableLowLatency": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400616 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
617 "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.
618 "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000619 "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.
John Asmuth614db982014-04-24 15:46:26 -0400620 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
621 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
622 #
623 #
624 #
625 # 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.
626 "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.
627 #
628 #
629 #
630 # 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.
631 "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.
632 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
633 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
634 "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.
635 #
636 # You need to set this value to true if you intend to have a broadcast delay for your event.
637 #
638 # Note: This property cannot be updated once the broadcast is in the testing or live state.
639 },
640 },
641 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
642 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
643 "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.
644 "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.
645 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
646 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700647 "liveChatId": "A String", # The id of the live chat for this broadcast.
John Asmuth614db982014-04-24 15:46:26 -0400648 "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
649 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
650 "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000651 "isDefaultBroadcast": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400652 "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.
653 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
654 "url": "A String", # The thumbnail image's URL.
655 "width": 42, # (Optional) Width of the thumbnail image.
656 "height": 42, # (Optional) Height of the thumbnail image.
657 },
658 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
659 "url": "A String", # The thumbnail image's URL.
660 "width": 42, # (Optional) Width of the thumbnail image.
661 "height": 42, # (Optional) Height of the thumbnail image.
662 },
663 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
664 "url": "A String", # The thumbnail image's URL.
665 "width": 42, # (Optional) Width of the thumbnail image.
666 "height": 42, # (Optional) Height of the thumbnail image.
667 },
668 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
669 "url": "A String", # The thumbnail image's URL.
670 "width": 42, # (Optional) Width of the thumbnail image.
671 "height": 42, # (Optional) Height of the thumbnail image.
672 },
673 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
674 "url": "A String", # The thumbnail image's URL.
675 "width": 42, # (Optional) Width of the thumbnail image.
676 "height": 42, # (Optional) Height of the thumbnail image.
677 },
678 },
679 },
680 "etag": "A String", # Etag of this resource.
681 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
682 }</pre>
683</div>
684
685<div class="method">
686 <code class="details" id="list">list(part, broadcastStatus=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, maxResults=None, mine=None, id=None)</code>
687 <pre>Returns a list of YouTube broadcasts that match the API request parameters.
688
689Args:
690 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)
691 broadcastStatus: string, The broadcastStatus parameter filters the API response to only include broadcasts with the specified status.
692 Allowed values
693 active - Return current live broadcasts.
694 all - Return all broadcasts.
695 completed - Return broadcasts that have already ended.
696 upcoming - Return broadcasts that have not yet started.
697 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
698
699The 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.
700 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.
701 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
702
703The 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.
704
705This 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.
706 maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
707 mine: boolean, The mine parameter can be used to instruct the API to only return broadcasts owned by the authenticated user. Set the parameter value to true to only retrieve your own broadcasts.
708 id: string, The id parameter specifies a comma-separated list of YouTube broadcast IDs that identify the broadcasts being retrieved. In a liveBroadcast resource, the id property specifies the broadcast's ID.
709
710Returns:
711 An object of the form:
712
713 {
714 "eventId": "A String", # Serialized EventId of the request which produced this response.
715 "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.
716 "kind": "youtube#liveBroadcastListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcastListResponse".
717 "visitorId": "A String", # The visitorId identifies the visitor.
718 "items": [ # A list of broadcasts that match the request criteria.
719 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
720 "status": { # The status object contains information about the event's status.
721 "recordingStatus": "A String", # The broadcast's recording status.
722 "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.
723 "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
Craig Citro065b5302014-08-14 00:47:23 -0700724 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400725 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000726 "topicDetails": {
727 "topics": [
728 {
729 "snippet": { # Information about the topic matched.
730 "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
731 "name": "A String", # The name of the topic.
732 },
733 "type": "A String", # The type of the topic.
734 "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
735 },
736 ],
737 },
John Asmuth614db982014-04-24 15:46:26 -0400738 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000739 "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.
740 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
741 "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.
742 },
John Asmuth614db982014-04-24 15:46:26 -0400743 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000744 "enableLowLatency": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400745 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
746 "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.
747 "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000748 "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.
John Asmuth614db982014-04-24 15:46:26 -0400749 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
750 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
751 #
752 #
753 #
754 # 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.
755 "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.
756 #
757 #
758 #
759 # 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.
760 "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.
761 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
762 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
763 "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.
764 #
765 # You need to set this value to true if you intend to have a broadcast delay for your event.
766 #
767 # Note: This property cannot be updated once the broadcast is in the testing or live state.
768 },
769 },
770 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
771 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
772 "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.
773 "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.
774 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
775 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700776 "liveChatId": "A String", # The id of the live chat for this broadcast.
John Asmuth614db982014-04-24 15:46:26 -0400777 "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
778 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
779 "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000780 "isDefaultBroadcast": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400781 "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.
782 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
783 "url": "A String", # The thumbnail image's URL.
784 "width": 42, # (Optional) Width of the thumbnail image.
785 "height": 42, # (Optional) Height of the thumbnail image.
786 },
787 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
788 "url": "A String", # The thumbnail image's URL.
789 "width": 42, # (Optional) Width of the thumbnail image.
790 "height": 42, # (Optional) Height of the thumbnail image.
791 },
792 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
793 "url": "A String", # The thumbnail image's URL.
794 "width": 42, # (Optional) Width of the thumbnail image.
795 "height": 42, # (Optional) Height of the thumbnail image.
796 },
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 },
808 },
809 "etag": "A String", # Etag of this resource.
810 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
811 },
812 ],
813 "tokenPagination": { # Stub token pagination template to suppress results.
814 },
815 "etag": "A String", # Etag of this resource.
816 "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.
817 "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
818 "totalResults": 42, # The total number of results in the result set.
819 "resultsPerPage": 42, # The number of results included in the API response.
820 },
821 }</pre>
822</div>
823
824<div class="method">
825 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
826 <pre>Retrieves the next page of results.
827
828Args:
829 previous_request: The request for the previous page. (required)
830 previous_response: The response from the request for the previous page. (required)
831
832Returns:
833 A request object that you can call 'execute()' on to request the next
834 page. Returns None if there are no more items in the collection.
835 </pre>
836</div>
837
838<div class="method">
839 <code class="details" id="transition">transition(broadcastStatus, id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
840 <pre>Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream. Before calling this method, you should confirm that the value of the status.streamStatus property for the stream bound to your broadcast is active.
841
842Args:
843 broadcastStatus: string, The broadcastStatus parameter identifies the state to which the broadcast is changing. Note that to transition a broadcast to either the testing or live state, the status.streamStatus must be active for the stream that the broadcast is bound to. (required)
844 Allowed values
845 complete - The broadcast is over. YouTube stops transmitting video.
846 live - The broadcast is visible to its audience. YouTube transmits video to the broadcast's monitor stream and its broadcast stream.
847 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.
848 id: string, The id parameter specifies the unique ID of the broadcast that is transitioning to another status. (required)
849 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)
850 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
851
852The 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.
853 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
854
855The 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.
856
857This 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.
858
859Returns:
860 An object of the form:
861
862 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
863 "status": { # The status object contains information about the event's status.
864 "recordingStatus": "A String", # The broadcast's recording status.
865 "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.
866 "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
Craig Citro065b5302014-08-14 00:47:23 -0700867 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400868 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000869 "topicDetails": {
870 "topics": [
871 {
872 "snippet": { # Information about the topic matched.
873 "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
874 "name": "A String", # The name of the topic.
875 },
876 "type": "A String", # The type of the topic.
877 "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
878 },
879 ],
880 },
John Asmuth614db982014-04-24 15:46:26 -0400881 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000882 "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.
883 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
884 "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.
885 },
John Asmuth614db982014-04-24 15:46:26 -0400886 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000887 "enableLowLatency": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400888 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
889 "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.
890 "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000891 "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.
John Asmuth614db982014-04-24 15:46:26 -0400892 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
893 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
894 #
895 #
896 #
897 # 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.
898 "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.
899 #
900 #
901 #
902 # 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.
903 "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.
904 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
905 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
906 "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.
907 #
908 # You need to set this value to true if you intend to have a broadcast delay for your event.
909 #
910 # Note: This property cannot be updated once the broadcast is in the testing or live state.
911 },
912 },
913 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
914 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
915 "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.
916 "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.
917 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
918 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700919 "liveChatId": "A String", # The id of the live chat for this broadcast.
John Asmuth614db982014-04-24 15:46:26 -0400920 "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
921 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
922 "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000923 "isDefaultBroadcast": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400924 "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.
925 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
926 "url": "A String", # The thumbnail image's URL.
927 "width": 42, # (Optional) Width of the thumbnail image.
928 "height": 42, # (Optional) Height of the thumbnail image.
929 },
930 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
931 "url": "A String", # The thumbnail image's URL.
932 "width": 42, # (Optional) Width of the thumbnail image.
933 "height": 42, # (Optional) Height of the thumbnail image.
934 },
935 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
936 "url": "A String", # The thumbnail image's URL.
937 "width": 42, # (Optional) Width of the thumbnail image.
938 "height": 42, # (Optional) Height of the thumbnail image.
939 },
940 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
941 "url": "A String", # The thumbnail image's URL.
942 "width": 42, # (Optional) Width of the thumbnail image.
943 "height": 42, # (Optional) Height of the thumbnail image.
944 },
945 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
946 "url": "A String", # The thumbnail image's URL.
947 "width": 42, # (Optional) Width of the thumbnail image.
948 "height": 42, # (Optional) Height of the thumbnail image.
949 },
950 },
951 },
952 "etag": "A String", # Etag of this resource.
953 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
954 }</pre>
955</div>
956
957<div class="method">
958 <code class="details" id="update">update(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
959 <pre>Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object.
960
961Args:
962 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.
963
964The part properties that you can include in the parameter value are id, snippet, contentDetails, and status.
965
966Note 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)
967 body: object, The request body. (required)
968 The object takes the form of:
969
970{ # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
971 "status": { # The status object contains information about the event's status.
972 "recordingStatus": "A String", # The broadcast's recording status.
973 "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.
974 "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
Craig Citro065b5302014-08-14 00:47:23 -0700975 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400976 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000977 "topicDetails": {
978 "topics": [
979 {
980 "snippet": { # Information about the topic matched.
981 "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
982 "name": "A String", # The name of the topic.
983 },
984 "type": "A String", # The type of the topic.
985 "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
986 },
987 ],
988 },
John Asmuth614db982014-04-24 15:46:26 -0400989 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000990 "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.
991 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
992 "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.
993 },
John Asmuth614db982014-04-24 15:46:26 -0400994 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000995 "enableLowLatency": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400996 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
997 "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.
998 "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000999 "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.
John Asmuth614db982014-04-24 15:46:26 -04001000 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
1001 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
1002 #
1003 #
1004 #
1005 # 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.
1006 "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.
1007 #
1008 #
1009 #
1010 # 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.
1011 "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.
1012 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
1013 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
1014 "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.
1015 #
1016 # You need to set this value to true if you intend to have a broadcast delay for your event.
1017 #
1018 # Note: This property cannot be updated once the broadcast is in the testing or live state.
1019 },
1020 },
1021 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
1022 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
1023 "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.
1024 "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.
1025 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
1026 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
Takashi Matsuo06694102015-09-11 13:55:40 -07001027 "liveChatId": "A String", # The id of the live chat for this broadcast.
John Asmuth614db982014-04-24 15:46:26 -04001028 "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
1029 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
1030 "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001031 "isDefaultBroadcast": True or False,
John Asmuth614db982014-04-24 15:46:26 -04001032 "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.
1033 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
1034 "url": "A String", # The thumbnail image's URL.
1035 "width": 42, # (Optional) Width of the thumbnail image.
1036 "height": 42, # (Optional) Height of the thumbnail image.
1037 },
1038 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
1039 "url": "A String", # The thumbnail image's URL.
1040 "width": 42, # (Optional) Width of the thumbnail image.
1041 "height": 42, # (Optional) Height of the thumbnail image.
1042 },
1043 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
1044 "url": "A String", # The thumbnail image's URL.
1045 "width": 42, # (Optional) Width of the thumbnail image.
1046 "height": 42, # (Optional) Height of the thumbnail image.
1047 },
1048 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
1049 "url": "A String", # The thumbnail image's URL.
1050 "width": 42, # (Optional) Width of the thumbnail image.
1051 "height": 42, # (Optional) Height of the thumbnail image.
1052 },
1053 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
1054 "url": "A String", # The thumbnail image's URL.
1055 "width": 42, # (Optional) Width of the thumbnail image.
1056 "height": 42, # (Optional) Height of the thumbnail image.
1057 },
1058 },
1059 },
1060 "etag": "A String", # Etag of this resource.
1061 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
1062}
1063
1064 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
1065
1066The 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.
1067 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
1068
1069The 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.
1070
1071This 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.
1072
1073Returns:
1074 An object of the form:
1075
1076 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
1077 "status": { # The status object contains information about the event's status.
1078 "recordingStatus": "A String", # The broadcast's recording status.
1079 "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.
1080 "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
Craig Citro065b5302014-08-14 00:47:23 -07001081 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -04001082 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001083 "topicDetails": {
1084 "topics": [
1085 {
1086 "snippet": { # Information about the topic matched.
1087 "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
1088 "name": "A String", # The name of the topic.
1089 },
1090 "type": "A String", # The type of the topic.
1091 "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
1092 },
1093 ],
1094 },
John Asmuth614db982014-04-24 15:46:26 -04001095 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001096 "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.
1097 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
1098 "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.
1099 },
John Asmuth614db982014-04-24 15:46:26 -04001100 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001101 "enableLowLatency": True or False,
John Asmuth614db982014-04-24 15:46:26 -04001102 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
1103 "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.
1104 "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001105 "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.
John Asmuth614db982014-04-24 15:46:26 -04001106 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
1107 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
1108 #
1109 #
1110 #
1111 # 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.
1112 "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.
1113 #
1114 #
1115 #
1116 # 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.
1117 "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.
1118 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
1119 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
1120 "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.
1121 #
1122 # You need to set this value to true if you intend to have a broadcast delay for your event.
1123 #
1124 # Note: This property cannot be updated once the broadcast is in the testing or live state.
1125 },
1126 },
1127 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
1128 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
1129 "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.
1130 "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.
1131 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
1132 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
Takashi Matsuo06694102015-09-11 13:55:40 -07001133 "liveChatId": "A String", # The id of the live chat for this broadcast.
John Asmuth614db982014-04-24 15:46:26 -04001134 "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
1135 "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 (YYYY-MM-DDThh:mm:ss.sZ) format.
1136 "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001137 "isDefaultBroadcast": True or False,
John Asmuth614db982014-04-24 15:46:26 -04001138 "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.
1139 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
1140 "url": "A String", # The thumbnail image's URL.
1141 "width": 42, # (Optional) Width of the thumbnail image.
1142 "height": 42, # (Optional) Height of the thumbnail image.
1143 },
1144 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
1145 "url": "A String", # The thumbnail image's URL.
1146 "width": 42, # (Optional) Width of the thumbnail image.
1147 "height": 42, # (Optional) Height of the thumbnail image.
1148 },
1149 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
1150 "url": "A String", # The thumbnail image's URL.
1151 "width": 42, # (Optional) Width of the thumbnail image.
1152 "height": 42, # (Optional) Height of the thumbnail image.
1153 },
1154 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
1155 "url": "A String", # The thumbnail image's URL.
1156 "width": 42, # (Optional) Width of the thumbnail image.
1157 "height": 42, # (Optional) Height of the thumbnail image.
1158 },
1159 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
1160 "url": "A String", # The thumbnail image's URL.
1161 "width": 42, # (Optional) Width of the thumbnail image.
1162 "height": 42, # (Optional) Height of the thumbnail image.
1163 },
1164 },
1165 },
1166 "etag": "A String", # Etag of this resource.
1167 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
1168 }</pre>
1169</div>
1170
1171</body></html>