Blame - docs/dyn/youtube_v3.liveBroadcasts.html - platform/external/python/google-api-python-client

2014-04-24 15:46:26 -0400

[diff] [blame]

86

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

87

<code><a href="#delete">delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p>

88

<p class="firstline">Delete a given broadcast.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

89

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

90

<code><a href="#insert">insert(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

91

<p class="firstline">Inserts a new stream for the authenticated user.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

92

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

93

<code><a href="#list">list(part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, id=None, broadcastStatus=None, maxResults=None, pageToken=None, mine=None, broadcastType=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

94

<p class="firstline">Retrieve the list of broadcasts associated with the given channel.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

95

96

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

97

<p class="firstline">Retrieves the next page of results.</p>

98

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

99

<code><a href="#transition">transition(id, broadcastStatus, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p>

100

<p class="firstline">Transition a broadcast to a given status.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

101

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

102

<code><a href="#update">update(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

103

<p class="firstline">Updates an existing broadcast for the authenticated user.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

104

<h3>Method Details</h3>

105

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

106

<code class="details" id="bind">bind(id, part, onBehalfOfContentOwner=None, streamId=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

107

<pre>Bind a broadcast to a stream.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

108

109

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

110

id: string, Broadcast to bind to the stream (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

111

part: string, The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status. (required) (repeated)

112

onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

113

streamId: string, Stream to bind, if not set unbind the current one.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

114

onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

115

x__xgafv: string, V1 error format.

116

Allowed values

117

1 - v1 error format

118

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

119

120

Returns:

121

An object of the form:

122

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

123

{ # A *liveBroadcast* resource represents an event that will be streamed, via live video, on YouTube.

124

"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.

125

"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.

126

"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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

127

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

128

"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".

129

"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.

130

"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.

131

"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.

132

"projection": "A String", # The projection format of this broadcast. This defaults to rectangular.

133

"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.

134

"enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. *Important:* You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.

135

"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.

136

"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.

137

"enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. *Note:* This property cannot be updated once the broadcast is in the testing or live state.

138

"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.

139

},

140

"latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.

141

"enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.

142

"mesh": "A String", # The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags.

143

"closedCaptionsType": "A String",

144

"boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.

145

"enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.

146

"enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.

147

"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.

148

"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. *Important:* You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.

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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

150

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

151

"snippet": { # Basic broadcast information. # The snippet object contains basic details about the event, including its title, description, start time, and end time.

152

"liveChatId": "A String", # The id of the live chat for this broadcast.

153

"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.

154

"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 format.

155

"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 format.

156

"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 format.

157

"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.

158

"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.

159

"url": "A String", # The thumbnail image's URL.

160

"width": 42, # (Optional) Width of the thumbnail image.

161

"height": 42, # (Optional) Height of the thumbnail image.

162

},

163

"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.

164

"url": "A String", # The thumbnail image's URL.

165

"width": 42, # (Optional) Width of the thumbnail image.

166

"height": 42, # (Optional) Height of the thumbnail image.

167

},

168

"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.

169

"url": "A String", # The thumbnail image's URL.

170

"width": 42, # (Optional) Width of the thumbnail image.

171

"height": 42, # (Optional) Height of the thumbnail image.

172

},

173

"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.

174

"url": "A String", # The thumbnail image's URL.

175

"width": 42, # (Optional) Width of the thumbnail image.

176

"height": 42, # (Optional) Height of the thumbnail image.

177

},

178

"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.

179

"url": "A String", # The thumbnail image's URL.

180

"width": 42, # (Optional) Width of the thumbnail image.

181

"height": 42, # (Optional) Height of the thumbnail image.

182

},

183

},

184

"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.

185

"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 format.

186

"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 format.

187

"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.

188

"isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. Internal only.

189

},

190

"status": { # Live broadcast state. # The status object contains information about the event's status.

191

"madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only.

192

"selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work.

193

"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.

194

"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.

195

"recordingStatus": "A String", # The broadcast's recording status.

196

"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).

197

},

198

"etag": "A String", # Etag of this resource.

199

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

203

<code class="details" id="close">close()</code>

204

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="control">control(id, part, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, displaySlate=None, walltime=None, offsetTimeMs=None, x__xgafv=None)</code>

209

<pre>Slate and recording control of the live broadcast. Support actions: slate on/off, recording start/stop/pause/resume. Design doc: goto/yt-api-liveBroadcast-control

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

210

211

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

212

id: string, Broadcast to operate. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

213

part: string, The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status. (required) (repeated)

214

onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

215

onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

216

displaySlate: boolean, Whether display or hide slate.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

217

walltime: string, The wall clock time at which the action should be executed. Only one of offset_time_ms and walltime may be set at a time.

218

offsetTimeMs: string, The exact time when the actions (e.g. slate on) are executed. It is an offset from the first frame of the monitor stream. If not set, it means "now" or ASAP. This field should not be set if the monitor stream is disabled, otherwise an error will be returned.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

219

x__xgafv: string, V1 error format.

220

Allowed values

221

1 - v1 error format

222

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

223

224

Returns:

225

An object of the form:

226

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

227

{ # A *liveBroadcast* resource represents an event that will be streamed, via live video, on YouTube.

228

"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.

229

"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.

230

"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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

231

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

232

"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".

233

"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.

234

"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.

235

"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.

236

"projection": "A String", # The projection format of this broadcast. This defaults to rectangular.

237

"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.

238

"enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. *Important:* You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.

239

"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.

240

"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.

241

"enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. *Note:* This property cannot be updated once the broadcast is in the testing or live state.

242

"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.

243

},

244

"latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.

245

"enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.

246

"mesh": "A String", # The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags.

247

"closedCaptionsType": "A String",

248

"boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.

249

"enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.

250

"enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.

251

"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.

252

"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. *Important:* You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.

253

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

254

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

255

"snippet": { # Basic broadcast information. # The snippet object contains basic details about the event, including its title, description, start time, and end time.

256

"liveChatId": "A String", # The id of the live chat for this broadcast.

257

"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.

258

"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 format.

259

"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 format.

260

"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 format.

261

"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.

262

"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.

263

"url": "A String", # The thumbnail image's URL.

264

"width": 42, # (Optional) Width of the thumbnail image.

265

"height": 42, # (Optional) Height of the thumbnail image.

266

},

267

"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.

268

"url": "A String", # The thumbnail image's URL.

269

"width": 42, # (Optional) Width of the thumbnail image.

270

"height": 42, # (Optional) Height of the thumbnail image.

271

},

272

"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.

273

"url": "A String", # The thumbnail image's URL.

274

"width": 42, # (Optional) Width of the thumbnail image.

275

"height": 42, # (Optional) Height of the thumbnail image.

276

},

277

"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.

278

"url": "A String", # The thumbnail image's URL.

279

"width": 42, # (Optional) Width of the thumbnail image.

280

"height": 42, # (Optional) Height of the thumbnail image.

281

},

282

"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.

283

"url": "A String", # The thumbnail image's URL.

284

"width": 42, # (Optional) Width of the thumbnail image.

285

"height": 42, # (Optional) Height of the thumbnail image.

286

},

287

},

288

"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.

289

"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 format.

290

"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 format.

291

"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.

292

"isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. Internal only.

293

},

294

"status": { # Live broadcast state. # The status object contains information about the event's status.

295

"madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only.

296

"selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work.

297

"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.

298

"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.

299

"recordingStatus": "A String", # The broadcast's recording status.

300

"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).

301

},

302

"etag": "A String", # Etag of this resource.

303

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

307

<code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code>

308

<pre>Delete a given broadcast.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

309

310

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

311

id: string, Broadcast to delete. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

312

onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

313

onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

314

x__xgafv: string, V1 error format.

315

Allowed values

316

1 - v1 error format

317

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

322

<code class="details" id="insert">insert(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

323

<pre>Inserts a new stream for the authenticated user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

324

325

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

326

part: string, The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, contentDetails, and status. (required) (repeated)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

327

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

328

The object takes the form of:

329

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

330

{ # A *liveBroadcast* resource represents an event that will be streamed, via live video, on YouTube.

331

"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.

332

"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.

333

"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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

334

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

335

"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".

336

"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.

337

"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.

338

"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.

339

"projection": "A String", # The projection format of this broadcast. This defaults to rectangular.

340

"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.

341

"enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. *Important:* You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.

342

"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.

343

"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.

344

"enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. *Note:* This property cannot be updated once the broadcast is in the testing or live state.

345

"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.

346

},

347

"latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.

348

"enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.

349

"mesh": "A String", # The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags.

350

"closedCaptionsType": "A String",

351

"boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.

352

"enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.

353

"enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.

354

"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.

355

"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. *Important:* You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.

356

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

357

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

358

"snippet": { # Basic broadcast information. # The snippet object contains basic details about the event, including its title, description, start time, and end time.

359

"liveChatId": "A String", # The id of the live chat for this broadcast.

360

"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.

361

"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 format.

362

"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 format.

363

"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 format.

364

"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.

365

"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.

366

"url": "A String", # The thumbnail image's URL.

367

"width": 42, # (Optional) Width of the thumbnail image.

368

"height": 42, # (Optional) Height of the thumbnail image.

369

},

370

"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.

371

"url": "A String", # The thumbnail image's URL.

372

"width": 42, # (Optional) Width of the thumbnail image.

373

"height": 42, # (Optional) Height of the thumbnail image.

374

},

375

"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.

376

"url": "A String", # The thumbnail image's URL.

377

"width": 42, # (Optional) Width of the thumbnail image.

378

"height": 42, # (Optional) Height of the thumbnail image.

379

},

380

"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.

381

"url": "A String", # The thumbnail image's URL.

382

"width": 42, # (Optional) Width of the thumbnail image.

383

"height": 42, # (Optional) Height of the thumbnail image.

384

},

385

"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.

386

"url": "A String", # The thumbnail image's URL.

387

"width": 42, # (Optional) Width of the thumbnail image.

388

"height": 42, # (Optional) Height of the thumbnail image.

389

},

390

},

391

"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.

392

"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 format.

393

"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 format.

394

"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.

395

"isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. Internal only.

396

},

397

"status": { # Live broadcast state. # The status object contains information about the event's status.

398

"madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only.

399

"selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work.

400

"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.

401

"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.

402

"recordingStatus": "A String", # The broadcast's recording status.

403

"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).

404

},

405

"etag": "A String", # Etag of this resource.

406

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

407

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

408

onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

409

onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

410

x__xgafv: string, V1 error format.

411

Allowed values

412

1 - v1 error format

413

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

414

415

Returns:

416

An object of the form:

417

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

418

{ # A *liveBroadcast* resource represents an event that will be streamed, via live video, on YouTube.

419

"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.

420

"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.

421

"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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

422

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

423

"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".

424

"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.

425

"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.

426

"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.

427

"projection": "A String", # The projection format of this broadcast. This defaults to rectangular.

428

"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.

429

"enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. *Important:* You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.

430

"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.

431

"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.

432

"enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. *Note:* This property cannot be updated once the broadcast is in the testing or live state.

433

"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.

434

},

435

"latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.

436

"enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.

437

"mesh": "A String", # The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags.

438

"closedCaptionsType": "A String",

439

"boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.

440

"enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.

441

"enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.

442

"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.

443

"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. *Important:* You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.

444

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

445

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

446

"snippet": { # Basic broadcast information. # The snippet object contains basic details about the event, including its title, description, start time, and end time.

447

"liveChatId": "A String", # The id of the live chat for this broadcast.

448

"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.

449

"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 format.

450

"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 format.

451

"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 format.

452

"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.

453

"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.

454

"url": "A String", # The thumbnail image's URL.

455

"width": 42, # (Optional) Width of the thumbnail image.

456

"height": 42, # (Optional) Height of the thumbnail image.

457

},

458

"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.

459

"url": "A String", # The thumbnail image's URL.

460

"width": 42, # (Optional) Width of the thumbnail image.

461

"height": 42, # (Optional) Height of the thumbnail image.

462

},

463

"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.

464

"url": "A String", # The thumbnail image's URL.

465

"width": 42, # (Optional) Width of the thumbnail image.

466

"height": 42, # (Optional) Height of the thumbnail image.

467

},

468

"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.

469

"url": "A String", # The thumbnail image's URL.

470

"width": 42, # (Optional) Width of the thumbnail image.

471

"height": 42, # (Optional) Height of the thumbnail image.

472

},

473

"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.

474

"url": "A String", # The thumbnail image's URL.

475

"width": 42, # (Optional) Width of the thumbnail image.

476

"height": 42, # (Optional) Height of the thumbnail image.

477

},

478

},

479

"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.

480

"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 format.

481

"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 format.

482

"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.

483

"isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. Internal only.

484

},

485

"status": { # Live broadcast state. # The status object contains information about the event's status.

486

"madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only.

487

"selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work.

488

"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.

489

"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.

490

"recordingStatus": "A String", # The broadcast's recording status.

491

"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).

492

},

493

"etag": "A String", # Etag of this resource.

494

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

498

<code class="details" id="list">list(part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, id=None, broadcastStatus=None, maxResults=None, pageToken=None, mine=None, broadcastType=None, x__xgafv=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

499

<pre>Retrieve the list of broadcasts associated with the given channel.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

500

501

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

502

part: string, The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, status and statistics. (required) (repeated)

503

onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

504

onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

505

id: string, Return broadcasts with the given ids from Stubby or Apiary. (repeated)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

506

broadcastStatus: string, Return broadcasts with a certain status, e.g. active broadcasts.

507

Allowed values

508

broadcastStatusFilterUnspecified -

509

all - Return all broadcasts.

510

active - Return current live broadcasts.

511

upcoming - Return broadcasts that have not yet started.

512

completed - Return broadcasts that have already ended.

513

maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.

514

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.

515

mine: boolean, A parameter

516

broadcastType: string, Return only broadcasts with the selected type.

517

Allowed values

518

broadcastTypeFilterUnspecified -

519

all - Return all broadcasts.

520

event - Return only scheduled event broadcasts.

521

persistent - Return only persistent broadcasts.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

522

x__xgafv: string, V1 error format.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

523

Allowed values

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

524

1 - v1 error format

525

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

526

527

Returns:

528

An object of the form:

529

530

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

531

"visitorId": "A String", # The visitorId identifies the visitor.

532

"tokenPagination": { # Stub token pagination template to suppress results.

533

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

534

"items": [ # A list of broadcasts that match the request criteria.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

535

{ # A *liveBroadcast* resource represents an event that will be streamed, via live video, on YouTube.

536

"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.

537

"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.

538

"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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

539

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

540

"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".

541

"contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.

542

"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.

543

"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.

544

"projection": "A String", # The projection format of this broadcast. This defaults to rectangular.

545

"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.

546

"enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. *Important:* You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.

547

"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.

548

"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.

549

"enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. *Note:* This property cannot be updated once the broadcast is in the testing or live state.

550

"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.

551

},

552

"latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.

553

"enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.

554

"mesh": "A String", # The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags.

555

"closedCaptionsType": "A String",

556

"boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.

557

"enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.

558

"enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.

559

"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.

560

"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. *Important:* You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.

561

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

562

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

563

"snippet": { # Basic broadcast information. # The snippet object contains basic details about the event, including its title, description, start time, and end time.

564

"liveChatId": "A String", # The id of the live chat for this broadcast.

565

"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.

566

"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 format.

567

"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 format.

568

"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 format.

569

"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.

570

"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.

571

"url": "A String", # The thumbnail image's URL.

572

"width": 42, # (Optional) Width of the thumbnail image.

573

"height": 42, # (Optional) Height of the thumbnail image.

574

},

575

"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.

576

"url": "A String", # The thumbnail image's URL.

577

"width": 42, # (Optional) Width of the thumbnail image.

578

"height": 42, # (Optional) Height of the thumbnail image.

579

},

580

"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.

581

"url": "A String", # The thumbnail image's URL.

582

"width": 42, # (Optional) Width of the thumbnail image.

583

"height": 42, # (Optional) Height of the thumbnail image.

584

},

585

"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.

586

"url": "A String", # The thumbnail image's URL.

587

"width": 42, # (Optional) Width of the thumbnail image.

588

"height": 42, # (Optional) Height of the thumbnail image.

589

},

590

"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.

591

"url": "A String", # The thumbnail image's URL.

592

"width": 42, # (Optional) Width of the thumbnail image.

593

"height": 42, # (Optional) Height of the thumbnail image.

594

},

595

},

596

"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.

597

"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 format.

598

"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 format.

599

"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.

600

"isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. Internal only.

601

},

602

"status": { # Live broadcast state. # The status object contains information about the event's status.

603

"madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only.

604

"selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work.

605

"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.

606

"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.

607

"recordingStatus": "A String", # The broadcast's recording status.

608

"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).

609

},

610

"etag": "A String", # Etag of this resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

611

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

612

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

613

"pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # General pagination information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

614

"resultsPerPage": 42, # The number of results included in the API response.

615

"totalResults": 42, # The total number of results in the result set.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

616

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

617

"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.

618

"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.

619

"eventId": "A String", # Serialized EventId of the request which produced this response.

620

"kind": "youtube#liveBroadcastListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcastListResponse".

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

621

"etag": "A String", # Etag of this resource.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

627

<pre>Retrieves the next page of results.

628

629

Args:

630

previous_request: The request for the previous page. (required)

631

previous_response: The response from the request for the previous page. (required)

632

633

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

634

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

635

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

640

<code class="details" id="transition">transition(id, broadcastStatus, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code>

641

<pre>Transition a broadcast to a given status.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

642

643

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

644

id: string, Broadcast to transition. (required)

645

broadcastStatus: string, The status to which the broadcast is going to transition. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

646

Allowed values

647

statusUnspecified -

648

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.",

649

live - Return only persistent broadcasts.

650

complete - The broadcast is over. YouTube stops transmitting video.

651

part: string, The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status. (required) (repeated)

652

onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

653

onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

654

x__xgafv: string, V1 error format.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

655

Allowed values

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

656

1 - v1 error format

657

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

658

659

Returns:

660

An object of the form:

661

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

662

{ # A *liveBroadcast* resource represents an event that will be streamed, via live video, on YouTube.

663

"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.

664

"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.

665

"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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

666

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

667

"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".

668

"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.

669

"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.

670

"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.

671

"projection": "A String", # The projection format of this broadcast. This defaults to rectangular.

672

"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.

673

"enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. *Important:* You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.

674

"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.

675

"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.

676

"enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. *Note:* This property cannot be updated once the broadcast is in the testing or live state.

677

"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.

678

},

679

"latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.

680

"enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.

681

"mesh": "A String", # The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags.

682

"closedCaptionsType": "A String",

683

"boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.

684

"enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.

685

"enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.

686

"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.

687

"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. *Important:* You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.

688

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

689

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

690

"snippet": { # Basic broadcast information. # The snippet object contains basic details about the event, including its title, description, start time, and end time.

691

"liveChatId": "A String", # The id of the live chat for this broadcast.

692

"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.

693

"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 format.

694

"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 format.

695

"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 format.

696

"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.

697

"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.

698

"url": "A String", # The thumbnail image's URL.

699

"width": 42, # (Optional) Width of the thumbnail image.

700

"height": 42, # (Optional) Height of the thumbnail image.

701

},

702

"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.

703

"url": "A String", # The thumbnail image's URL.

704

"width": 42, # (Optional) Width of the thumbnail image.

705

"height": 42, # (Optional) Height of the thumbnail image.

706

},

707

"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.

708

"url": "A String", # The thumbnail image's URL.

709

"width": 42, # (Optional) Width of the thumbnail image.

710

"height": 42, # (Optional) Height of the thumbnail image.

711

},

712

"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.

713

"url": "A String", # The thumbnail image's URL.

714

"width": 42, # (Optional) Width of the thumbnail image.

715

"height": 42, # (Optional) Height of the thumbnail image.

716

},

717

"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.

718

"url": "A String", # The thumbnail image's URL.

719

"width": 42, # (Optional) Width of the thumbnail image.

720

"height": 42, # (Optional) Height of the thumbnail image.

721

},

722

},

723

"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.

724

"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 format.

725

"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 format.

726

"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.

727

"isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. Internal only.

728

},

729

"status": { # Live broadcast state. # The status object contains information about the event's status.

730

"madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only.

731

"selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work.

732

"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.

733

"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.

734

"recordingStatus": "A String", # The broadcast's recording status.

735

"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).

736

},

737

"etag": "A String", # Etag of this resource.

738

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

742

<code class="details" id="update">update(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

743

<pre>Updates an existing broadcast for the authenticated user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

744

745

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

746

part: string, The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, contentDetails, and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a broadcast's privacy status is defined in the status part. As such, if your request is updating a private or unlisted broadcast, and the request's part parameter value includes the status part, the broadcast's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the broadcast will revert to the default privacy setting. (required) (repeated)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

747

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

748

The object takes the form of:

749

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

750

{ # A *liveBroadcast* resource represents an event that will be streamed, via live video, on YouTube.

751

"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.

752

"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.

753

"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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

754

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

755

"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".

756

"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.

757

"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.

758

"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.

759

"projection": "A String", # The projection format of this broadcast. This defaults to rectangular.

760

"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.

761

"enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. *Important:* You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.

762

"monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.

763

"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.

764

"enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. *Note:* This property cannot be updated once the broadcast is in the testing or live state.

765

"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.

766

},

767

"latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.

768

"enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.

769

"mesh": "A String", # The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags.

770

"closedCaptionsType": "A String",

771

"boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.

772

"enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.

773

"enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.

774

"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.

775

"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. *Important:* You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.

776

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

777

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

778

"snippet": { # Basic broadcast information. # The snippet object contains basic details about the event, including its title, description, start time, and end time.

779

"liveChatId": "A String", # The id of the live chat for this broadcast.

780

"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.

781

"actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 format.

782

"actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 format.

783

"publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 format.

784

"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.

785

"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.

786

"url": "A String", # The thumbnail image's URL.

787

"width": 42, # (Optional) Width of the thumbnail image.

788

"height": 42, # (Optional) Height of the thumbnail image.

789

},

790

"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.

791

"url": "A String", # The thumbnail image's URL.

792

"width": 42, # (Optional) Width of the thumbnail image.

793

"height": 42, # (Optional) Height of the thumbnail image.

794

},

795

"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.

796

"url": "A String", # The thumbnail image's URL.

797

"width": 42, # (Optional) Width of the thumbnail image.

798

"height": 42, # (Optional) Height of the thumbnail image.

799

},

800

"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.

801

"url": "A String", # The thumbnail image's URL.

802

"width": 42, # (Optional) Width of the thumbnail image.

803

"height": 42, # (Optional) Height of the thumbnail image.

804

},

805

"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.

806

"url": "A String", # The thumbnail image's URL.

807

"width": 42, # (Optional) Width of the thumbnail image.

808

"height": 42, # (Optional) Height of the thumbnail image.

809

},

810

},

811

"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.

812

"scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 format.

813

"scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 format.

814

"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.

815

"isDefaultBroadcast": True or False, # Indicates whether this broadcast is the default broadcast. Internal only.

816

},

817

"status": { # Live broadcast state. # The status object contains information about the event's status.

818

"madeForKids": True or False, # Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only.

819

"selfDeclaredMadeForKids": True or False, # This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work.

820

"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.

821

"lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.

822

"recordingStatus": "A String", # The broadcast's recording status.

823

"liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).

824

},

825

"etag": "A String", # Etag of this resource.

826

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

827

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

828

onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

829

onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

830

x__xgafv: string, V1 error format.

831

Allowed values

832

1 - v1 error format

833

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

834

835

Returns:

836

An object of the form:

837

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

838

{ # A *liveBroadcast* resource represents an event that will be streamed, via live video, on YouTube.

839

"id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.

840

"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.

841

"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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

842

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

843

"kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".

844

"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.

845

"boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.

846

"enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.

847

"projection": "A String", # The projection format of this broadcast. This defaults to rectangular.

848

"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.

849

"enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. *Important:* You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.

850

"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.

851

"embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.

852

"enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. *Note:* This property cannot be updated once the broadcast is in the testing or live state.

853

"broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.

854

},

855

"latencyPreference": "A String", # If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.

856

"enableAutoStart": True or False, # This setting indicates whether auto start is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.

857

"mesh": "A String", # The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags.

858

"closedCaptionsType": "A String",

859

"boundStreamLastUpdateTimeMs": "A String", # The date and time that the live stream referenced by boundStreamId was last updated.

860

"enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.

861

"enableAutoStop": True or False, # This setting indicates whether auto stop is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.

862

"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.

863

"recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. *Important:* You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.

864

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

865

},

Dmitry Frenkel