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

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

[diff] [blame]

84

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

John Asmuth

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

[diff] [blame]

85

<p class="firstline">Returns a list of video streams that match the API request parameters.</p>

86

87

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

88

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

89

Dan O'Meara

dd49464

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

[diff] [blame]

90

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

John Asmuth

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

[diff] [blame]

91

<p class="firstline">Updates a video stream. If the properties that you want to change cannot be updated, then you need to create a new stream with the proper settings.</p>

92

<h3>Method Details</h3>

93

94

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

95

<pre>Deletes a video stream.

96

97

Args:

98

id: string, The id parameter specifies the YouTube live stream ID for the resource that is being deleted. (required)

99

onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

100

Bu Sun Kim

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

[diff] [blame]

101

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.

John Asmuth

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

[diff] [blame]

102

onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

103

104

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.

105

106

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.

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

111

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

John Asmuth

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

[diff] [blame]

112

<pre>Creates a video stream. The stream enables you to send your video to YouTube, which can then broadcast the video to your audience.

113

114

Args:

115

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.

116

117

The part properties that you can include in the parameter value are id, snippet, cdn, and status. (required)

Dan O'Meara

dd49464

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

[diff] [blame]

118

body: object, The request body.

John Asmuth

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

[diff] [blame]

119

The object takes the form of:

120

121

{ # A live stream describes a live ingestion point.

Bu Sun Kim

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

[diff] [blame]

122

"cdn": { # Brief description of the live stream cdn settings. # The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.

123

"format": "A String", # The format of the video stream that you are sending to Youtube.

124

"frameRate": "A String", # The frame rate of the inbound video data.

125

"ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube.

126

"backupIngestionAddress": "A String", # The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL.

127

"ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.

128

#

129

# Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format:

130

#

131

# STREAM_URL/STREAM_NAME

132

"streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

133

},

Bu Sun Kim

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

[diff] [blame]

134

"ingestionType": "A String", # The method or protocol used to transmit the video stream.

135

"resolution": "A String", # The resolution of the inbound video data.

John Asmuth

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

[diff] [blame]

136

},

Bu Sun Kim

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

[diff] [blame]

137

"contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.

138

"closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.

139

"isReusable": True or False, # Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times.

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

140

#

141

# If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways:

142

# - A non-reusable stream can only be bound to one broadcast.

143

# - A non-reusable stream might be deleted by an automated process after the broadcast ends.

144

# - The liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream.

John Asmuth

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

[diff] [blame]

145

},

Bu Sun Kim

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

[diff] [blame]

146

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

147

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

148

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

149

"snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.

150

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

151

"description": "A String", # The stream's description. The value cannot be longer than 10000 characters.

152

"isDefaultStream": True or False,

153

"publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

154

"title": "A String", # The stream's title. The value must be between 1 and 128 characters long.

155

},

156

"status": { # Brief description of the live stream status. # The status object contains information about live stream's status.

157

"healthStatus": { # The health status of the stream.

158

"configurationIssues": [ # The configurations issues on this stream

159

{

160

"description": "A String", # The long-form description of the issue and how to resolve it.

161

"reason": "A String", # The short-form reason for this issue.

162

"severity": "A String", # How severe this issue is to the stream.

163

"type": "A String", # The kind of error happening.

164

},

165

],

166

"lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)

167

"status": "A String", # The status code of this stream

John Asmuth

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

[diff] [blame]

168

},

Bu Sun Kim

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

[diff] [blame]

169

"streamStatus": "A String",

John Asmuth

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

[diff] [blame]

170

},

John Asmuth

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

[diff] [blame]

171

}

172

173

onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

174

Bu Sun Kim

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

[diff] [blame]

175

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.

John Asmuth

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

[diff] [blame]

176

onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

177

178

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.

179

180

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.

181

182

Returns:

183

An object of the form:

184

185

{ # A live stream describes a live ingestion point.

Bu Sun Kim

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

[diff] [blame]

186

"cdn": { # Brief description of the live stream cdn settings. # The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.

187

"format": "A String", # The format of the video stream that you are sending to Youtube.

188

"frameRate": "A String", # The frame rate of the inbound video data.

189

"ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube.

190

"backupIngestionAddress": "A String", # The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL.

191

"ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.

192

#

193

# Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format:

194

#

195

# STREAM_URL/STREAM_NAME

196

"streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

197

},

Bu Sun Kim

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

[diff] [blame]

198

"ingestionType": "A String", # The method or protocol used to transmit the video stream.

199

"resolution": "A String", # The resolution of the inbound video data.

John Asmuth

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

[diff] [blame]

200

},

Bu Sun Kim

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

[diff] [blame]

201

"contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.

202

"closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.

203

"isReusable": True or False, # Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times.

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

204

#

205

# If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways:

206

# - A non-reusable stream can only be bound to one broadcast.

207

# - A non-reusable stream might be deleted by an automated process after the broadcast ends.

208

# - The liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream.

John Asmuth

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

[diff] [blame]

209

},

Bu Sun Kim

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

[diff] [blame]

210

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

211

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

212

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

213

"snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.

214

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

215

"description": "A String", # The stream's description. The value cannot be longer than 10000 characters.

216

"isDefaultStream": True or False,

217

"publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

218

"title": "A String", # The stream's title. The value must be between 1 and 128 characters long.

219

},

220

"status": { # Brief description of the live stream status. # The status object contains information about live stream's status.

221

"healthStatus": { # The health status of the stream.

222

"configurationIssues": [ # The configurations issues on this stream

223

{

224

"description": "A String", # The long-form description of the issue and how to resolve it.

225

"reason": "A String", # The short-form reason for this issue.

226

"severity": "A String", # How severe this issue is to the stream.

227

"type": "A String", # The kind of error happening.

228

},

229

],

230

"lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)

231

"status": "A String", # The status code of this stream

John Asmuth

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

[diff] [blame]

232

},

Bu Sun Kim

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

[diff] [blame]

233

"streamStatus": "A String",

John Asmuth

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

[diff] [blame]

234

},

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

239

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

John Asmuth

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

[diff] [blame]

240

<pre>Returns a list of video streams that match the API request parameters.

241

242

Args:

243

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

Bu Sun Kim

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

[diff] [blame]

244

id: string, The id parameter specifies a comma-separated list of YouTube stream IDs that identify the streams being retrieved. In a liveStream resource, the id property specifies the stream's ID.

245

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

246

mine: boolean, The mine parameter can be used to instruct the API to only return streams owned by the authenticated user. Set the parameter value to true to only retrieve your own streams.

John Asmuth

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

[diff] [blame]

247

onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

248

Bu Sun Kim

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

[diff] [blame]

249

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.

John Asmuth

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

[diff] [blame]

250

onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

251

252

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.

253

254

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-05-20 12:08:20 -0700

[diff] [blame]

255

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.

John Asmuth

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

[diff] [blame]

256

257

Returns:

258

An object of the form:

259

260

{

Bu Sun Kim

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

[diff] [blame]

261

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

262

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

263

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

John Asmuth

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

[diff] [blame]

264

{ # A live stream describes a live ingestion point.

Bu Sun Kim

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

[diff] [blame]

265

"cdn": { # Brief description of the live stream cdn settings. # The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.

266

"format": "A String", # The format of the video stream that you are sending to Youtube.

267

"frameRate": "A String", # The frame rate of the inbound video data.

268

"ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube.

269

"backupIngestionAddress": "A String", # The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL.

270

"ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.

271

#

272

# Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format:

273

#

274

# STREAM_URL/STREAM_NAME

275

"streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

276

},

Bu Sun Kim

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

[diff] [blame]

277

"ingestionType": "A String", # The method or protocol used to transmit the video stream.

278

"resolution": "A String", # The resolution of the inbound video data.

John Asmuth

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

[diff] [blame]

279

},

Bu Sun Kim

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

[diff] [blame]

280

"contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.

281

"closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.

282

"isReusable": True or False, # Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times.

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

283

#

284

# If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways:

285

# - A non-reusable stream can only be bound to one broadcast.

286

# - A non-reusable stream might be deleted by an automated process after the broadcast ends.

287

# - The liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream.

John Asmuth

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

[diff] [blame]

288

},

Bu Sun Kim

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

[diff] [blame]

289

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

290

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

291

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

292

"snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.

293

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

294

"description": "A String", # The stream's description. The value cannot be longer than 10000 characters.

295

"isDefaultStream": True or False,

296

"publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

297

"title": "A String", # The stream's title. The value must be between 1 and 128 characters long.

298

},

299

"status": { # Brief description of the live stream status. # The status object contains information about live stream's status.

300

"healthStatus": { # The health status of the stream.

301

"configurationIssues": [ # The configurations issues on this stream

302

{

303

"description": "A String", # The long-form description of the issue and how to resolve it.

304

"reason": "A String", # The short-form reason for this issue.

305

"severity": "A String", # How severe this issue is to the stream.

306

"type": "A String", # The kind of error happening.

307

},

308

],

309

"lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)

310

"status": "A String", # The status code of this stream

John Asmuth

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

[diff] [blame]

311

},

Bu Sun Kim

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

[diff] [blame]

312

"streamStatus": "A String",

John Asmuth

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

[diff] [blame]

313

},

John Asmuth

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

[diff] [blame]

314

},

315

],

Bu Sun Kim

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

[diff] [blame]

316

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

317

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

318

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

319

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

320

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

John Asmuth

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

[diff] [blame]

321

},

Bu Sun Kim

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

[diff] [blame]

322

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

323

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

John Asmuth

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

[diff] [blame]

324

},

Bu Sun Kim

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

[diff] [blame]

325

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

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>

331

<pre>Retrieves the next page of results.

332

333

Args:

334

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

335

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

336

337

Returns:

Bu Sun Kim

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

[diff] [blame]

338

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

John Asmuth

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

[diff] [blame]

339

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

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

344

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

John Asmuth

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

[diff] [blame]

345

<pre>Updates a video stream. If the properties that you want to change cannot be updated, then you need to create a new stream with the proper settings.

346

347

Args:

348

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.

349

350

The part properties that you can include in the parameter value are id, snippet, cdn, and status.

351

352

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. If the request body does not specify a value for a mutable property, the existing value for that property will be removed. (required)

Dan O'Meara

dd49464

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

[diff] [blame]

353

body: object, The request body.

John Asmuth

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

[diff] [blame]

354

The object takes the form of:

355

356

{ # A live stream describes a live ingestion point.

Bu Sun Kim

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

[diff] [blame]

357

"cdn": { # Brief description of the live stream cdn settings. # The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.

358

"format": "A String", # The format of the video stream that you are sending to Youtube.

359

"frameRate": "A String", # The frame rate of the inbound video data.

360

"ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube.

361

"backupIngestionAddress": "A String", # The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL.

362

"ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.

363

#

364

# Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format:

365

#

366

# STREAM_URL/STREAM_NAME

367

"streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

368

},

Bu Sun Kim

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

[diff] [blame]

369

"ingestionType": "A String", # The method or protocol used to transmit the video stream.

370

"resolution": "A String", # The resolution of the inbound video data.

John Asmuth

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

[diff] [blame]

371

},

Bu Sun Kim

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

[diff] [blame]

372

"contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.

373

"closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.

374

"isReusable": True or False, # Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times.

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

375

#

376

# If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways:

377

# - A non-reusable stream can only be bound to one broadcast.

378

# - A non-reusable stream might be deleted by an automated process after the broadcast ends.

379

# - The liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream.

John Asmuth

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

[diff] [blame]

380

},

Bu Sun Kim

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

[diff] [blame]

381

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

382

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

383

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

384

"snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.

385

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

386

"description": "A String", # The stream's description. The value cannot be longer than 10000 characters.

387

"isDefaultStream": True or False,

388

"publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

389

"title": "A String", # The stream's title. The value must be between 1 and 128 characters long.

390

},

391

"status": { # Brief description of the live stream status. # The status object contains information about live stream's status.

392

"healthStatus": { # The health status of the stream.

393

"configurationIssues": [ # The configurations issues on this stream

394

{

395

"description": "A String", # The long-form description of the issue and how to resolve it.

396

"reason": "A String", # The short-form reason for this issue.

397

"severity": "A String", # How severe this issue is to the stream.

398

"type": "A String", # The kind of error happening.

399

},

400

],

401

"lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds)

402

"status": "A String", # The status code of this stream

John Asmuth

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

[diff] [blame]

403

},

Bu Sun Kim

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

[diff] [blame]

404

"streamStatus": "A String",

John Asmuth

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

[diff] [blame]

405

},

John Asmuth

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

[diff] [blame]

406

}

407

408

onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.

409

Bu Sun Kim

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

[diff] [blame]

410

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.

John Asmuth

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

[diff] [blame]

411

onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

412

413

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.

414

415

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.

416

417

Returns:

418

An object of the form:

419

420

{ # A live stream describes a live ingestion point.

Bu Sun Kim

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

[diff] [blame]

421

"cdn": { # Brief description of the live stream cdn settings. # The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.

422

"format": "A String", # The format of the video stream that you are sending to Youtube.

423

"frameRate": "A String", # The frame rate of the inbound video data.

424

"ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube.

425

"backupIngestionAddress": "A String", # The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL.

426

"ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.

427

#

428

# Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format:

429

#

430

# STREAM_URL/STREAM_NAME

431

"streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

432

},

Bu Sun Kim

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

[diff] [blame]

433

"ingestionType": "A String", # The method or protocol used to transmit the video stream.

434

"resolution": "A String", # The resolution of the inbound video data.

John Asmuth

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

[diff] [blame]

435

},

Bu Sun Kim

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

[diff] [blame]

436

"contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.

437

"closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.

438

"isReusable": True or False, # Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times.

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

439

#

440

# If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways:

441

# - A non-reusable stream can only be bound to one broadcast.

442

# - A non-reusable stream might be deleted by an automated process after the broadcast ends.

443

# - The liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream.

John Asmuth

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

[diff] [blame]

444

},

Bu Sun Kim