Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0e5b9bfd8a498fec87ed1237a0ed383f9329ed8f / . / docs / dyn / youtube_v3.liveBroadcasts.html
blob: 1c25a12a3f40239458bcc027b46b7cdd5b8467f2 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<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>
79<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.</p>
80<p class="toc_element">
81 <code><a href="#control">control(id, part, onBehalfOfContentOwner=None, displaySlate=None, onBehalfOfContentOwnerChannel=None, offsetTimeMs=None, walltime=None)</a></code></p>
82<p class="firstline">Controls the settings for a slate that can be displayed in the broadcast stream.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</a></code></p>
85<p class="firstline">Deletes a broadcast.</p>
86<p class="toc_element">
87 <code><a href="#insert">insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</a></code></p>
88<p class="firstline">Creates a broadcast.</p>
89<p class="toc_element">
90 <code><a href="#list">list(part, broadcastStatus=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, maxResults=None, mine=None, id=None)</a></code></p>
91<p class="firstline">Returns a list of YouTube broadcasts that match the API request parameters.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#transition">transition(broadcastStatus, id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</a></code></p>
97<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>
98<p class="toc_element">
99 <code><a href="#update">update(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</a></code></p>
100<p class="firstline">Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object.</p>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="bind">bind(id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, streamId=None)</code>
104 <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.
105
106Args:
107 id: string, The id parameter specifies the unique ID of the broadcast that is being bound to a video stream. (required)
108 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)
109 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
110
111The 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.
112 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
113
114The 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.
115
116This 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.
117 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.
118
119Returns:
120 An object of the form:
121
122 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
123 "status": { # The status object contains information about the event's status.
124 "recordingStatus": "A String", # The broadcast's recording status.
125 "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.
126 "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 -0700[diff] [blame]127 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128 },
129 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
130 "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.
131 "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.
132 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
133 "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.
134 "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.
135 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
136 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
137 #
138 #
139 #
140 # 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.
141 "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.
142 #
143 #
144 #
145 # 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.
146 "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.
147 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
148 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
149 "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.
150 #
151 # You need to set this value to true if you intend to have a broadcast delay for your event.
152 #
153 # Note: This property cannot be updated once the broadcast is in the testing or live state.
154 },
155 },
156 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
157 "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.
158 "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.
159 "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.
160 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
161 "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.
162 "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.
163 "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.
164 "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.
165 "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.
166 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
167 "url": "A String", # The thumbnail image's URL.
168 "width": 42, # (Optional) Width of the thumbnail image.
169 "height": 42, # (Optional) Height of the thumbnail image.
170 },
171 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
172 "url": "A String", # The thumbnail image's URL.
173 "width": 42, # (Optional) Width of the thumbnail image.
174 "height": 42, # (Optional) Height of the thumbnail image.
175 },
176 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
177 "url": "A String", # The thumbnail image's URL.
178 "width": 42, # (Optional) Width of the thumbnail image.
179 "height": 42, # (Optional) Height of the thumbnail image.
180 },
181 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
182 "url": "A String", # The thumbnail image's URL.
183 "width": 42, # (Optional) Width of the thumbnail image.
184 "height": 42, # (Optional) Height of the thumbnail image.
185 },
186 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
187 "url": "A String", # The thumbnail image's URL.
188 "width": 42, # (Optional) Width of the thumbnail image.
189 "height": 42, # (Optional) Height of the thumbnail image.
190 },
191 },
192 },
193 "etag": "A String", # Etag of this resource.
194 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
195 }</pre>
196</div>
197
198<div class="method">
199 <code class="details" id="control">control(id, part, onBehalfOfContentOwner=None, displaySlate=None, onBehalfOfContentOwnerChannel=None, offsetTimeMs=None, walltime=None)</code>
200 <pre>Controls the settings for a slate that can be displayed in the broadcast stream.
201
202Args:
203 id: string, The id parameter specifies the YouTube live broadcast ID that uniquely identifies the broadcast in which the slate is being updated. (required)
204 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)
205 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
206
207The 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.
208 displaySlate: boolean, The displaySlate parameter specifies whether the slate is being enabled or disabled.
209 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
210
211The 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.
212
213This 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.
214 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.
215
216If 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.
217
218Important: You should only specify a value for this parameter if your broadcast stream is delayed.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame^]219 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 -0400[diff] [blame]220
221Returns:
222 An object of the form:
223
224 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
225 "status": { # The status object contains information about the event's status.
226 "recordingStatus": "A String", # The broadcast's recording status.
227 "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.
228 "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 -0700[diff] [blame]229 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]230 },
231 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
232 "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.
233 "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.
234 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
235 "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.
236 "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.
237 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
238 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
239 #
240 #
241 #
242 # 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.
243 "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.
244 #
245 #
246 #
247 # 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.
248 "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.
249 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
250 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
251 "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.
252 #
253 # You need to set this value to true if you intend to have a broadcast delay for your event.
254 #
255 # Note: This property cannot be updated once the broadcast is in the testing or live state.
256 },
257 },
258 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
259 "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.
260 "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.
261 "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.
262 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
263 "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.
264 "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.
265 "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.
266 "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.
267 "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.
268 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
269 "url": "A String", # The thumbnail image's URL.
270 "width": 42, # (Optional) Width of the thumbnail image.
271 "height": 42, # (Optional) Height of the thumbnail image.
272 },
273 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
274 "url": "A String", # The thumbnail image's URL.
275 "width": 42, # (Optional) Width of the thumbnail image.
276 "height": 42, # (Optional) Height of the thumbnail image.
277 },
278 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
279 "url": "A String", # The thumbnail image's URL.
280 "width": 42, # (Optional) Width of the thumbnail image.
281 "height": 42, # (Optional) Height of the thumbnail image.
282 },
283 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
284 "url": "A String", # The thumbnail image's URL.
285 "width": 42, # (Optional) Width of the thumbnail image.
286 "height": 42, # (Optional) Height of the thumbnail image.
287 },
288 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
289 "url": "A String", # The thumbnail image's URL.
290 "width": 42, # (Optional) Width of the thumbnail image.
291 "height": 42, # (Optional) Height of the thumbnail image.
292 },
293 },
294 },
295 "etag": "A String", # Etag of this resource.
296 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
297 }</pre>
298</div>
299
300<div class="method">
301 <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
302 <pre>Deletes a broadcast.
303
304Args:
305 id: string, The id parameter specifies the YouTube live broadcast ID for the resource that is being deleted. (required)
306 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
307
308The 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.
309 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
310
311The 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.
312
313This 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.
314</pre>
315</div>
316
317<div class="method">
318 <code class="details" id="insert">insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
319 <pre>Creates a broadcast.
320
321Args:
322 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.
323
324The part properties that you can include in the parameter value are id, snippet, contentDetails, and status. (required)
325 body: object, The request body. (required)
326 The object takes the form of:
327
328{ # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
329 "status": { # The status object contains information about the event's status.
330 "recordingStatus": "A String", # The broadcast's recording status.
331 "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.
332 "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 -0700[diff] [blame]333 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]334 },
335 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
336 "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.
337 "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.
338 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
339 "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.
340 "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.
341 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
342 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
343 #
344 #
345 #
346 # Important: You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.
347 "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.
348 #
349 #
350 #
351 # 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.
352 "monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.
353 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
354 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
355 "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.
356 #
357 # You need to set this value to true if you intend to have a broadcast delay for your event.
358 #
359 # Note: This property cannot be updated once the broadcast is in the testing or live state.
360 },
361 },
362 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
363 "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.
364 "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.
365 "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.
366 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
367 "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.
368 "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.
369 "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
370 "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.
371 "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.
372 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
373 "url": "A String", # The thumbnail image's URL.
374 "width": 42, # (Optional) Width of the thumbnail image.
375 "height": 42, # (Optional) Height of the thumbnail image.
376 },
377 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
378 "url": "A String", # The thumbnail image's URL.
379 "width": 42, # (Optional) Width of the thumbnail image.
380 "height": 42, # (Optional) Height of the thumbnail image.
381 },
382 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
383 "url": "A String", # The thumbnail image's URL.
384 "width": 42, # (Optional) Width of the thumbnail image.
385 "height": 42, # (Optional) Height of the thumbnail image.
386 },
387 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
388 "url": "A String", # The thumbnail image's URL.
389 "width": 42, # (Optional) Width of the thumbnail image.
390 "height": 42, # (Optional) Height of the thumbnail image.
391 },
392 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
393 "url": "A String", # The thumbnail image's URL.
394 "width": 42, # (Optional) Width of the thumbnail image.
395 "height": 42, # (Optional) Height of the thumbnail image.
396 },
397 },
398 },
399 "etag": "A String", # Etag of this resource.
400 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
401}
402
403 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
404
405The 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.
406 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
407
408The 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.
409
410This 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.
411
412Returns:
413 An object of the form:
414
415 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
416 "status": { # The status object contains information about the event's status.
417 "recordingStatus": "A String", # The broadcast's recording status.
418 "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.
419 "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 -0700[diff] [blame]420 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]421 },
422 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
423 "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.
424 "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.
425 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
426 "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.
427 "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.
428 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
429 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
430 #
431 #
432 #
433 # 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.
434 "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.
435 #
436 #
437 #
438 # 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.
439 "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.
440 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
441 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
442 "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.
443 #
444 # You need to set this value to true if you intend to have a broadcast delay for your event.
445 #
446 # Note: This property cannot be updated once the broadcast is in the testing or live state.
447 },
448 },
449 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
450 "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.
451 "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.
452 "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.
453 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
454 "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.
455 "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.
456 "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.
457 "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.
458 "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.
459 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
460 "url": "A String", # The thumbnail image's URL.
461 "width": 42, # (Optional) Width of the thumbnail image.
462 "height": 42, # (Optional) Height of the thumbnail image.
463 },
464 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
465 "url": "A String", # The thumbnail image's URL.
466 "width": 42, # (Optional) Width of the thumbnail image.
467 "height": 42, # (Optional) Height of the thumbnail image.
468 },
469 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
470 "url": "A String", # The thumbnail image's URL.
471 "width": 42, # (Optional) Width of the thumbnail image.
472 "height": 42, # (Optional) Height of the thumbnail image.
473 },
474 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
475 "url": "A String", # The thumbnail image's URL.
476 "width": 42, # (Optional) Width of the thumbnail image.
477 "height": 42, # (Optional) Height of the thumbnail image.
478 },
479 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
480 "url": "A String", # The thumbnail image's URL.
481 "width": 42, # (Optional) Width of the thumbnail image.
482 "height": 42, # (Optional) Height of the thumbnail image.
483 },
484 },
485 },
486 "etag": "A String", # Etag of this resource.
487 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
488 }</pre>
489</div>
490
491<div class="method">
492 <code class="details" id="list">list(part, broadcastStatus=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, maxResults=None, mine=None, id=None)</code>
493 <pre>Returns a list of YouTube broadcasts that match the API request parameters.
494
495Args:
496 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)
497 broadcastStatus: string, The broadcastStatus parameter filters the API response to only include broadcasts with the specified status.
498 Allowed values
499 active - Return current live broadcasts.
500 all - Return all broadcasts.
501 completed - Return broadcasts that have already ended.
502 upcoming - Return broadcasts that have not yet started.
503 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
504
505The 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.
506 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.
507 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
508
509The 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.
510
511This 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.
512 maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
513 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.
514 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.
515
516Returns:
517 An object of the form:
518
519 {
520 "eventId": "A String", # Serialized EventId of the request which produced this response.
521 "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.
522 "kind": "youtube#liveBroadcastListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcastListResponse".
523 "visitorId": "A String", # The visitorId identifies the visitor.
524 "items": [ # A list of broadcasts that match the request criteria.
525 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
526 "status": { # The status object contains information about the event's status.
527 "recordingStatus": "A String", # The broadcast's recording status.
528 "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.
529 "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 -0700[diff] [blame]530 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]531 },
532 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
533 "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.
534 "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.
535 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
536 "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.
537 "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.
538 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
539 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
540 #
541 #
542 #
543 # 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.
544 "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.
545 #
546 #
547 #
548 # 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.
549 "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.
550 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
551 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
552 "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.
553 #
554 # You need to set this value to true if you intend to have a broadcast delay for your event.
555 #
556 # Note: This property cannot be updated once the broadcast is in the testing or live state.
557 },
558 },
559 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
560 "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.
561 "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.
562 "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.
563 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
564 "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.
565 "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.
566 "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.
567 "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.
568 "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.
569 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
570 "url": "A String", # The thumbnail image's URL.
571 "width": 42, # (Optional) Width of the thumbnail image.
572 "height": 42, # (Optional) Height of the thumbnail image.
573 },
574 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
575 "url": "A String", # The thumbnail image's URL.
576 "width": 42, # (Optional) Width of the thumbnail image.
577 "height": 42, # (Optional) Height of the thumbnail image.
578 },
579 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
580 "url": "A String", # The thumbnail image's URL.
581 "width": 42, # (Optional) Width of the thumbnail image.
582 "height": 42, # (Optional) Height of the thumbnail image.
583 },
584 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
585 "url": "A String", # The thumbnail image's URL.
586 "width": 42, # (Optional) Width of the thumbnail image.
587 "height": 42, # (Optional) Height of the thumbnail image.
588 },
589 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
590 "url": "A String", # The thumbnail image's URL.
591 "width": 42, # (Optional) Width of the thumbnail image.
592 "height": 42, # (Optional) Height of the thumbnail image.
593 },
594 },
595 },
596 "etag": "A String", # Etag of this resource.
597 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
598 },
599 ],
600 "tokenPagination": { # Stub token pagination template to suppress results.
601 },
602 "etag": "A String", # Etag of this resource.
603 "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.
604 "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
605 "totalResults": 42, # The total number of results in the result set.
606 "resultsPerPage": 42, # The number of results included in the API response.
607 },
608 }</pre>
609</div>
610
611<div class="method">
612 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
613 <pre>Retrieves the next page of results.
614
615Args:
616 previous_request: The request for the previous page. (required)
617 previous_response: The response from the request for the previous page. (required)
618
619Returns:
620 A request object that you can call 'execute()' on to request the next
621 page. Returns None if there are no more items in the collection.
622 </pre>
623</div>
624
625<div class="method">
626 <code class="details" id="transition">transition(broadcastStatus, id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
627 <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.
628
629Args:
630 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)
631 Allowed values
632 complete - The broadcast is over. YouTube stops transmitting video.
633 live - The broadcast is visible to its audience. YouTube transmits video to the broadcast's monitor stream and its broadcast stream.
634 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.
635 id: string, The id parameter specifies the unique ID of the broadcast that is transitioning to another status. (required)
636 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)
637 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
638
639The 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.
640 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
641
642The 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.
643
644This 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.
645
646Returns:
647 An object of the form:
648
649 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
650 "status": { # The status object contains information about the event's status.
651 "recordingStatus": "A String", # The broadcast's recording status.
652 "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.
653 "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 -0700[diff] [blame]654 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]655 },
656 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
657 "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.
658 "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.
659 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
660 "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.
661 "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.
662 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
663 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
664 #
665 #
666 #
667 # 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.
668 "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.
669 #
670 #
671 #
672 # 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.
673 "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.
674 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
675 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
676 "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.
677 #
678 # You need to set this value to true if you intend to have a broadcast delay for your event.
679 #
680 # Note: This property cannot be updated once the broadcast is in the testing or live state.
681 },
682 },
683 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
684 "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.
685 "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.
686 "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.
687 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
688 "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.
689 "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.
690 "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.
691 "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.
692 "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.
693 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
694 "url": "A String", # The thumbnail image's URL.
695 "width": 42, # (Optional) Width of the thumbnail image.
696 "height": 42, # (Optional) Height of the thumbnail image.
697 },
698 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
699 "url": "A String", # The thumbnail image's URL.
700 "width": 42, # (Optional) Width of the thumbnail image.
701 "height": 42, # (Optional) Height of the thumbnail image.
702 },
703 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
704 "url": "A String", # The thumbnail image's URL.
705 "width": 42, # (Optional) Width of the thumbnail image.
706 "height": 42, # (Optional) Height of the thumbnail image.
707 },
708 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
709 "url": "A String", # The thumbnail image's URL.
710 "width": 42, # (Optional) Width of the thumbnail image.
711 "height": 42, # (Optional) Height of the thumbnail image.
712 },
713 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
714 "url": "A String", # The thumbnail image's URL.
715 "width": 42, # (Optional) Width of the thumbnail image.
716 "height": 42, # (Optional) Height of the thumbnail image.
717 },
718 },
719 },
720 "etag": "A String", # Etag of this resource.
721 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
722 }</pre>
723</div>
724
725<div class="method">
726 <code class="details" id="update">update(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
727 <pre>Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object.
728
729Args:
730 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.
731
732The part properties that you can include in the parameter value are id, snippet, contentDetails, and status.
733
734Note 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)
735 body: object, The request body. (required)
736 The object takes the form of:
737
738{ # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
739 "status": { # The status object contains information about the event's status.
740 "recordingStatus": "A String", # The broadcast's recording status.
741 "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.
742 "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 -0700[diff] [blame]743 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]744 },
745 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
746 "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.
747 "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.
748 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
749 "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.
750 "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.
751 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
752 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
753 #
754 #
755 #
756 # 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.
757 "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.
758 #
759 #
760 #
761 # 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.
762 "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.
763 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
764 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
765 "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.
766 #
767 # You need to set this value to true if you intend to have a broadcast delay for your event.
768 #
769 # Note: This property cannot be updated once the broadcast is in the testing or live state.
770 },
771 },
772 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
773 "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.
774 "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.
775 "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.
776 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
777 "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.
778 "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.
779 "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.
780 "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.
781 "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 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
814
815The 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.
816 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
817
818The 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.
819
820This 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.
821
822Returns:
823 An object of the form:
824
825 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
826 "status": { # The status object contains information about the event's status.
827 "recordingStatus": "A String", # The broadcast's recording status.
828 "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.
829 "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 -0700[diff] [blame]830 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]831 },
832 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
833 "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.
834 "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.
835 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
836 "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.
837 "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.
838 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
839 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
840 #
841 #
842 #
843 # 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.
844 "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.
845 #
846 #
847 #
848 # 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.
849 "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.
850 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
851 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
852 "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.
853 #
854 # You need to set this value to true if you intend to have a broadcast delay for your event.
855 #
856 # Note: This property cannot be updated once the broadcast is in the testing or live state.
857 },
858 },
859 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
860 "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.
861 "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.
862 "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.
863 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
864 "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.
865 "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.
866 "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.
867 "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.
868 "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.
869 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
870 "url": "A String", # The thumbnail image's URL.
871 "width": 42, # (Optional) Width of the thumbnail image.
872 "height": 42, # (Optional) Height of the thumbnail image.
873 },
874 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
875 "url": "A String", # The thumbnail image's URL.
876 "width": 42, # (Optional) Width of the thumbnail image.
877 "height": 42, # (Optional) Height of the thumbnail image.
878 },
879 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
880 "url": "A String", # The thumbnail image's URL.
881 "width": 42, # (Optional) Width of the thumbnail image.
882 "height": 42, # (Optional) Height of the thumbnail image.
883 },
884 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
885 "url": "A String", # The thumbnail image's URL.
886 "width": 42, # (Optional) Width of the thumbnail image.
887 "height": 42, # (Optional) Height of the thumbnail image.
888 },
889 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
890 "url": "A String", # The thumbnail image's URL.
891 "width": 42, # (Optional) Width of the thumbnail image.
892 "height": 42, # (Optional) Height of the thumbnail image.
893 },
894 },
895 },
896 "etag": "A String", # Etag of this resource.
897 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
898 }</pre>
899</div>
900
901</body></html>