Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 70d03943e3a36983866fe40947aef79a16892ec3 / . / docs / dyn / youtube_v3.liveBroadcasts.html
blob: fd6d1a32831065dcd8072a91e7c572307efe86b4 [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>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]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, though a video stream may be bound to more than one broadcast.</p>
80<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]90 <code><a href="#list">list(part, broadcastStatus=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, maxResults=None, mine=None, broadcastType=None, id=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]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, though a video stream may be bound to more than one broadcast.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]129 "topicDetails": {
130 "topics": [
131 {
132 "snippet": { # Information about the topic matched.
133 "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
134 "name": "A String", # The name of the topic.
135 },
136 "type": "A String", # The type of the topic.
137 "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
138 },
139 ],
140 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]141 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]142 "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
143 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
144 "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
145 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]146 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]147 "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]148 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
149 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]150 "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]151 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]152 "closedCaptionsType": "A String",
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]153 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
154 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
155 #
156 #
157 #
158 # 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.
159 "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.
160 #
161 #
162 #
163 # 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.
164 "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.
165 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
166 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
167 "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.
168 #
169 # You need to set this value to true if you intend to have a broadcast delay for your event.
170 #
171 # Note: This property cannot be updated once the broadcast is in the testing or live state.
172 },
173 },
174 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
175 "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.
176 "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.
177 "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.
178 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
179 "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.
180 "liveChatId": "A String", # The id of the live chat for this broadcast.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]181 "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.
182 "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.
183 "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]184 "isDefaultBroadcast": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]185 "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.
186 "default": { # A thumbnail is an image representing a YouTube resource. # The default 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 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
192 "url": "A String", # The thumbnail image's URL.
193 "width": 42, # (Optional) Width of the thumbnail image.
194 "height": 42, # (Optional) Height of the thumbnail image.
195 },
196 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
197 "url": "A String", # The thumbnail image's URL.
198 "width": 42, # (Optional) Width of the thumbnail image.
199 "height": 42, # (Optional) Height of the thumbnail image.
200 },
201 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
202 "url": "A String", # The thumbnail image's URL.
203 "width": 42, # (Optional) Width of the thumbnail image.
204 "height": 42, # (Optional) Height of the thumbnail image.
205 },
206 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
207 "url": "A String", # The thumbnail image's URL.
208 "width": 42, # (Optional) Width of the thumbnail image.
209 "height": 42, # (Optional) Height of the thumbnail image.
210 },
211 },
212 },
213 "etag": "A String", # Etag of this resource.
214 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
215 }</pre>
216</div>
217
218<div class="method">
219 <code class="details" id="control">control(id, part, onBehalfOfContentOwner=None, displaySlate=None, onBehalfOfContentOwnerChannel=None, offsetTimeMs=None, walltime=None)</code>
220 <pre>Controls the settings for a slate that can be displayed in the broadcast stream.
221
222Args:
223 id: string, The id parameter specifies the YouTube live broadcast ID that uniquely identifies the broadcast in which the slate is being updated. (required)
224 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)
225 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
226
227The 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.
228 displaySlate: boolean, The displaySlate parameter specifies whether the slate is being enabled or disabled.
229 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
230
231The 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.
232
233This 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.
234 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.
235
236If 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.
237
238Important: 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]239 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]240
241Returns:
242 An object of the form:
243
244 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
245 "status": { # The status object contains information about the event's status.
246 "recordingStatus": "A String", # The broadcast's recording status.
247 "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.
248 "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]249 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]250 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]251 "topicDetails": {
252 "topics": [
253 {
254 "snippet": { # Information about the topic matched.
255 "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
256 "name": "A String", # The name of the topic.
257 },
258 "type": "A String", # The type of the topic.
259 "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
260 },
261 ],
262 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]263 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]264 "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
265 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
266 "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
267 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]268 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]269 "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]270 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
271 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]272 "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]273 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]274 "closedCaptionsType": "A String",
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]275 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
276 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
277 #
278 #
279 #
280 # 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.
281 "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.
282 #
283 #
284 #
285 # 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.
286 "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.
287 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
288 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
289 "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.
290 #
291 # You need to set this value to true if you intend to have a broadcast delay for your event.
292 #
293 # Note: This property cannot be updated once the broadcast is in the testing or live state.
294 },
295 },
296 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
297 "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.
298 "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.
299 "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.
300 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
301 "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]302 "liveChatId": "A String", # The id of the live chat for this broadcast.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]303 "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.
304 "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.
305 "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]306 "isDefaultBroadcast": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]307 "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.
308 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
309 "url": "A String", # The thumbnail image's URL.
310 "width": 42, # (Optional) Width of the thumbnail image.
311 "height": 42, # (Optional) Height of the thumbnail image.
312 },
313 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
314 "url": "A String", # The thumbnail image's URL.
315 "width": 42, # (Optional) Width of the thumbnail image.
316 "height": 42, # (Optional) Height of the thumbnail image.
317 },
318 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
319 "url": "A String", # The thumbnail image's URL.
320 "width": 42, # (Optional) Width of the thumbnail image.
321 "height": 42, # (Optional) Height of the thumbnail image.
322 },
323 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
324 "url": "A String", # The thumbnail image's URL.
325 "width": 42, # (Optional) Width of the thumbnail image.
326 "height": 42, # (Optional) Height of the thumbnail image.
327 },
328 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
329 "url": "A String", # The thumbnail image's URL.
330 "width": 42, # (Optional) Width of the thumbnail image.
331 "height": 42, # (Optional) Height of the thumbnail image.
332 },
333 },
334 },
335 "etag": "A String", # Etag of this resource.
336 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
337 }</pre>
338</div>
339
340<div class="method">
341 <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
342 <pre>Deletes a broadcast.
343
344Args:
345 id: string, The id parameter specifies the YouTube live broadcast ID for the resource that is being deleted. (required)
346 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
347
348The 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.
349 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
350
351The 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.
352
353This 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.
354</pre>
355</div>
356
357<div class="method">
358 <code class="details" id="insert">insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
359 <pre>Creates a broadcast.
360
361Args:
362 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.
363
364The part properties that you can include in the parameter value are id, snippet, contentDetails, and status. (required)
365 body: object, The request body. (required)
366 The object takes the form of:
367
368{ # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
369 "status": { # The status object contains information about the event's status.
370 "recordingStatus": "A String", # The broadcast's recording status.
371 "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.
372 "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]373 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]374 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]375 "topicDetails": {
376 "topics": [
377 {
378 "snippet": { # Information about the topic matched.
379 "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
380 "name": "A String", # The name of the topic.
381 },
382 "type": "A String", # The type of the topic.
383 "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
384 },
385 ],
386 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]387 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]388 "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
389 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
390 "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
391 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]392 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]393 "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]394 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
395 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]396 "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]397 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]398 "closedCaptionsType": "A String",
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]399 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
400 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
401 #
402 #
403 #
404 # 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.
405 "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.
406 #
407 #
408 #
409 # 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.
410 "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.
411 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
412 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
413 "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.
414 #
415 # You need to set this value to true if you intend to have a broadcast delay for your event.
416 #
417 # Note: This property cannot be updated once the broadcast is in the testing or live state.
418 },
419 },
420 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
421 "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.
422 "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.
423 "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.
424 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
425 "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]426 "liveChatId": "A String", # The id of the live chat for this broadcast.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]427 "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.
428 "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.
429 "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]430 "isDefaultBroadcast": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]431 "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.
432 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
433 "url": "A String", # The thumbnail image's URL.
434 "width": 42, # (Optional) Width of the thumbnail image.
435 "height": 42, # (Optional) Height of the thumbnail image.
436 },
437 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
438 "url": "A String", # The thumbnail image's URL.
439 "width": 42, # (Optional) Width of the thumbnail image.
440 "height": 42, # (Optional) Height of the thumbnail image.
441 },
442 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
443 "url": "A String", # The thumbnail image's URL.
444 "width": 42, # (Optional) Width of the thumbnail image.
445 "height": 42, # (Optional) Height of the thumbnail image.
446 },
447 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
448 "url": "A String", # The thumbnail image's URL.
449 "width": 42, # (Optional) Width of the thumbnail image.
450 "height": 42, # (Optional) Height of the thumbnail image.
451 },
452 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
453 "url": "A String", # The thumbnail image's URL.
454 "width": 42, # (Optional) Width of the thumbnail image.
455 "height": 42, # (Optional) Height of the thumbnail image.
456 },
457 },
458 },
459 "etag": "A String", # Etag of this resource.
460 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
461}
462
463 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
464
465The 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.
466 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
467
468The 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.
469
470This 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.
471
472Returns:
473 An object of the form:
474
475 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
476 "status": { # The status object contains information about the event's status.
477 "recordingStatus": "A String", # The broadcast's recording status.
478 "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.
479 "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]480 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]481 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]482 "topicDetails": {
483 "topics": [
484 {
485 "snippet": { # Information about the topic matched.
486 "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
487 "name": "A String", # The name of the topic.
488 },
489 "type": "A String", # The type of the topic.
490 "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
491 },
492 ],
493 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]494 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]495 "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
496 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
497 "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
498 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]499 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]500 "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]501 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
502 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]503 "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]504 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]505 "closedCaptionsType": "A String",
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]506 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
507 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
508 #
509 #
510 #
511 # 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.
512 "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.
513 #
514 #
515 #
516 # 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.
517 "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.
518 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
519 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
520 "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.
521 #
522 # You need to set this value to true if you intend to have a broadcast delay for your event.
523 #
524 # Note: This property cannot be updated once the broadcast is in the testing or live state.
525 },
526 },
527 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
528 "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.
529 "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.
530 "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.
531 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
532 "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]533 "liveChatId": "A String", # The id of the live chat for this broadcast.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]534 "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.
535 "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.
536 "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]537 "isDefaultBroadcast": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]538 "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.
539 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
540 "url": "A String", # The thumbnail image's URL.
541 "width": 42, # (Optional) Width of the thumbnail image.
542 "height": 42, # (Optional) Height of the thumbnail image.
543 },
544 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
545 "url": "A String", # The thumbnail image's URL.
546 "width": 42, # (Optional) Width of the thumbnail image.
547 "height": 42, # (Optional) Height of the thumbnail image.
548 },
549 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
550 "url": "A String", # The thumbnail image's URL.
551 "width": 42, # (Optional) Width of the thumbnail image.
552 "height": 42, # (Optional) Height of the thumbnail image.
553 },
554 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
555 "url": "A String", # The thumbnail image's URL.
556 "width": 42, # (Optional) Width of the thumbnail image.
557 "height": 42, # (Optional) Height of the thumbnail image.
558 },
559 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
560 "url": "A String", # The thumbnail image's URL.
561 "width": 42, # (Optional) Width of the thumbnail image.
562 "height": 42, # (Optional) Height of the thumbnail image.
563 },
564 },
565 },
566 "etag": "A String", # Etag of this resource.
567 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
568 }</pre>
569</div>
570
571<div class="method">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]572 <code class="details" id="list">list(part, broadcastStatus=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, maxResults=None, mine=None, broadcastType=None, id=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]573 <pre>Returns a list of YouTube broadcasts that match the API request parameters.
574
575Args:
576 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)
577 broadcastStatus: string, The broadcastStatus parameter filters the API response to only include broadcasts with the specified status.
578 Allowed values
579 active - Return current live broadcasts.
580 all - Return all broadcasts.
581 completed - Return broadcasts that have already ended.
582 upcoming - Return broadcasts that have not yet started.
583 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
584
585The 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.
586 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.
587 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
588
589The 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.
590
591This 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.
592 maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
593 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]594 broadcastType: string, The broadcastType parameter filters the API response to only include broadcasts with the specified type. This is only compatible with the mine filter for now.
595 Allowed values
596 all - Return all broadcasts.
597 event - Return only scheduled event broadcasts.
598 persistent - Return only persistent broadcasts.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]599 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.
600
601Returns:
602 An object of the form:
603
604 {
605 "eventId": "A String", # Serialized EventId of the request which produced this response.
606 "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.
607 "kind": "youtube#liveBroadcastListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcastListResponse".
608 "visitorId": "A String", # The visitorId identifies the visitor.
609 "items": [ # A list of broadcasts that match the request criteria.
610 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
611 "status": { # The status object contains information about the event's status.
612 "recordingStatus": "A String", # The broadcast's recording status.
613 "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.
614 "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]615 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]616 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]617 "topicDetails": {
618 "topics": [
619 {
620 "snippet": { # Information about the topic matched.
621 "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
622 "name": "A String", # The name of the topic.
623 },
624 "type": "A String", # The type of the topic.
625 "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
626 },
627 ],
628 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]629 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]630 "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
631 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
632 "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
633 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]634 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]635 "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]636 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
637 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]638 "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]639 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]640 "closedCaptionsType": "A String",
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]641 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
642 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
643 #
644 #
645 #
646 # 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.
647 "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.
648 #
649 #
650 #
651 # 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.
652 "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.
653 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
654 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
655 "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.
656 #
657 # You need to set this value to true if you intend to have a broadcast delay for your event.
658 #
659 # Note: This property cannot be updated once the broadcast is in the testing or live state.
660 },
661 },
662 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
663 "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.
664 "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.
665 "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.
666 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
667 "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]668 "liveChatId": "A String", # The id of the live chat for this broadcast.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]669 "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.
670 "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.
671 "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]672 "isDefaultBroadcast": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]673 "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.
674 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
675 "url": "A String", # The thumbnail image's URL.
676 "width": 42, # (Optional) Width of the thumbnail image.
677 "height": 42, # (Optional) Height of the thumbnail image.
678 },
679 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
680 "url": "A String", # The thumbnail image's URL.
681 "width": 42, # (Optional) Width of the thumbnail image.
682 "height": 42, # (Optional) Height of the thumbnail image.
683 },
684 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
685 "url": "A String", # The thumbnail image's URL.
686 "width": 42, # (Optional) Width of the thumbnail image.
687 "height": 42, # (Optional) Height of the thumbnail image.
688 },
689 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
690 "url": "A String", # The thumbnail image's URL.
691 "width": 42, # (Optional) Width of the thumbnail image.
692 "height": 42, # (Optional) Height of the thumbnail image.
693 },
694 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
695 "url": "A String", # The thumbnail image's URL.
696 "width": 42, # (Optional) Width of the thumbnail image.
697 "height": 42, # (Optional) Height of the thumbnail image.
698 },
699 },
700 },
701 "etag": "A String", # Etag of this resource.
702 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
703 },
704 ],
705 "tokenPagination": { # Stub token pagination template to suppress results.
706 },
707 "etag": "A String", # Etag of this resource.
708 "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.
709 "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
710 "totalResults": 42, # The total number of results in the result set.
711 "resultsPerPage": 42, # The number of results included in the API response.
712 },
713 }</pre>
714</div>
715
716<div class="method">
717 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
718 <pre>Retrieves the next page of results.
719
720Args:
721 previous_request: The request for the previous page. (required)
722 previous_response: The response from the request for the previous page. (required)
723
724Returns:
725 A request object that you can call 'execute()' on to request the next
726 page. Returns None if there are no more items in the collection.
727 </pre>
728</div>
729
730<div class="method">
731 <code class="details" id="transition">transition(broadcastStatus, id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
732 <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.
733
734Args:
735 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)
736 Allowed values
737 complete - The broadcast is over. YouTube stops transmitting video.
738 live - The broadcast is visible to its audience. YouTube transmits video to the broadcast's monitor stream and its broadcast stream.
739 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.
740 id: string, The id parameter specifies the unique ID of the broadcast that is transitioning to another status. (required)
741 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)
742 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
743
744The 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.
745 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
746
747The 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.
748
749This 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.
750
751Returns:
752 An object of the form:
753
754 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
755 "status": { # The status object contains information about the event's status.
756 "recordingStatus": "A String", # The broadcast's recording status.
757 "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.
758 "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]759 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]760 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]761 "topicDetails": {
762 "topics": [
763 {
764 "snippet": { # Information about the topic matched.
765 "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
766 "name": "A String", # The name of the topic.
767 },
768 "type": "A String", # The type of the topic.
769 "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
770 },
771 ],
772 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]773 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]774 "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
775 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
776 "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
777 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]778 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]779 "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]780 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
781 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]782 "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]783 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]784 "closedCaptionsType": "A String",
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]785 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
786 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
787 #
788 #
789 #
790 # 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.
791 "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.
792 #
793 #
794 #
795 # 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.
796 "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.
797 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
798 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
799 "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.
800 #
801 # You need to set this value to true if you intend to have a broadcast delay for your event.
802 #
803 # Note: This property cannot be updated once the broadcast is in the testing or live state.
804 },
805 },
806 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
807 "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.
808 "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.
809 "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.
810 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
811 "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]812 "liveChatId": "A String", # The id of the live chat for this broadcast.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]813 "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.
814 "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.
815 "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]816 "isDefaultBroadcast": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]817 "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.
818 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
819 "url": "A String", # The thumbnail image's URL.
820 "width": 42, # (Optional) Width of the thumbnail image.
821 "height": 42, # (Optional) Height of the thumbnail image.
822 },
823 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
824 "url": "A String", # The thumbnail image's URL.
825 "width": 42, # (Optional) Width of the thumbnail image.
826 "height": 42, # (Optional) Height of the thumbnail image.
827 },
828 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
829 "url": "A String", # The thumbnail image's URL.
830 "width": 42, # (Optional) Width of the thumbnail image.
831 "height": 42, # (Optional) Height of the thumbnail image.
832 },
833 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
834 "url": "A String", # The thumbnail image's URL.
835 "width": 42, # (Optional) Width of the thumbnail image.
836 "height": 42, # (Optional) Height of the thumbnail image.
837 },
838 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
839 "url": "A String", # The thumbnail image's URL.
840 "width": 42, # (Optional) Width of the thumbnail image.
841 "height": 42, # (Optional) Height of the thumbnail image.
842 },
843 },
844 },
845 "etag": "A String", # Etag of this resource.
846 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
847 }</pre>
848</div>
849
850<div class="method">
851 <code class="details" id="update">update(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
852 <pre>Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object.
853
854Args:
855 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.
856
857The part properties that you can include in the parameter value are id, snippet, contentDetails, and status.
858
859Note 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)
860 body: object, The request body. (required)
861 The object takes the form of:
862
863{ # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
864 "status": { # The status object contains information about the event's status.
865 "recordingStatus": "A String", # The broadcast's recording status.
866 "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.
867 "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]868 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]869 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]870 "topicDetails": {
871 "topics": [
872 {
873 "snippet": { # Information about the topic matched.
874 "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
875 "name": "A String", # The name of the topic.
876 },
877 "type": "A String", # The type of the topic.
878 "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
879 },
880 ],
881 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]882 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]883 "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
884 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
885 "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
886 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]887 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]888 "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]889 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
890 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]891 "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]892 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]893 "closedCaptionsType": "A String",
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]894 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
895 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
896 #
897 #
898 #
899 # 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.
900 "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.
901 #
902 #
903 #
904 # 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.
905 "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.
906 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
907 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
908 "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.
909 #
910 # You need to set this value to true if you intend to have a broadcast delay for your event.
911 #
912 # Note: This property cannot be updated once the broadcast is in the testing or live state.
913 },
914 },
915 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
916 "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.
917 "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.
918 "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.
919 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
920 "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]921 "liveChatId": "A String", # The id of the live chat for this broadcast.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]922 "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.
923 "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.
924 "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]925 "isDefaultBroadcast": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]926 "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.
927 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
928 "url": "A String", # The thumbnail image's URL.
929 "width": 42, # (Optional) Width of the thumbnail image.
930 "height": 42, # (Optional) Height of the thumbnail image.
931 },
932 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
933 "url": "A String", # The thumbnail image's URL.
934 "width": 42, # (Optional) Width of the thumbnail image.
935 "height": 42, # (Optional) Height of the thumbnail image.
936 },
937 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
938 "url": "A String", # The thumbnail image's URL.
939 "width": 42, # (Optional) Width of the thumbnail image.
940 "height": 42, # (Optional) Height of the thumbnail image.
941 },
942 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
943 "url": "A String", # The thumbnail image's URL.
944 "width": 42, # (Optional) Width of the thumbnail image.
945 "height": 42, # (Optional) Height of the thumbnail image.
946 },
947 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
948 "url": "A String", # The thumbnail image's URL.
949 "width": 42, # (Optional) Width of the thumbnail image.
950 "height": 42, # (Optional) Height of the thumbnail image.
951 },
952 },
953 },
954 "etag": "A String", # Etag of this resource.
955 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
956}
957
958 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
959
960The 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.
961 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
962
963The 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.
964
965This 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.
966
967Returns:
968 An object of the form:
969
970 { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
971 "status": { # The status object contains information about the event's status.
972 "recordingStatus": "A String", # The broadcast's recording status.
973 "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
974 "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]975 "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]976 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]977 "topicDetails": {
978 "topics": [
979 {
980 "snippet": { # Information about the topic matched.
981 "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
982 "name": "A String", # The name of the topic.
983 },
984 "type": "A String", # The type of the topic.
985 "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
986 },
987 ],
988 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]989 "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]990 "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
991 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
992 "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
993 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]994 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]995 "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]996 "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
997 "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]998 "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]999 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1000 "closedCaptionsType": "A String",
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1001 "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
1002 "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
1003 #
1004 #
1005 #
1006 # 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.
1007 "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.
1008 #
1009 #
1010 #
1011 # 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.
1012 "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.
1013 "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
1014 "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
1015 "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.
1016 #
1017 # You need to set this value to true if you intend to have a broadcast delay for your event.
1018 #
1019 # Note: This property cannot be updated once the broadcast is in the testing or live state.
1020 },
1021 },
1022 "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
1023 "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.
1024 "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.
1025 "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.
1026 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
1027 "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1028 "liveChatId": "A String", # The id of the live chat for this broadcast.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1029 "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.
1030 "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.
1031 "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1032 "isDefaultBroadcast": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1033 "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.
1034 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
1035 "url": "A String", # The thumbnail image's URL.
1036 "width": 42, # (Optional) Width of the thumbnail image.
1037 "height": 42, # (Optional) Height of the thumbnail image.
1038 },
1039 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
1040 "url": "A String", # The thumbnail image's URL.
1041 "width": 42, # (Optional) Width of the thumbnail image.
1042 "height": 42, # (Optional) Height of the thumbnail image.
1043 },
1044 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
1045 "url": "A String", # The thumbnail image's URL.
1046 "width": 42, # (Optional) Width of the thumbnail image.
1047 "height": 42, # (Optional) Height of the thumbnail image.
1048 },
1049 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
1050 "url": "A String", # The thumbnail image's URL.
1051 "width": 42, # (Optional) Width of the thumbnail image.
1052 "height": 42, # (Optional) Height of the thumbnail image.
1053 },
1054 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
1055 "url": "A String", # The thumbnail image's URL.
1056 "width": 42, # (Optional) Width of the thumbnail image.
1057 "height": 42, # (Optional) Height of the thumbnail image.
1058 },
1059 },
1060 },
1061 "etag": "A String", # Etag of this resource.
1062 "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
1063 }</pre>
1064</div>
1065
1066</body></html>