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

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

[diff] [blame]

86

87

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

88

Retrieves the next page of results.

89

Bu Sun Kim

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

[diff] [blame]

90

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

91

Updates an existing stream for the authenticated user.

John Asmuth

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

[diff] [blame]

92

<h3>Method Details</h3>

93

Bu Sun Kim

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

[diff] [blame]

94

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

95

<pre>Deletes an existing stream for the authenticated user.

John Asmuth

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

[diff] [blame]

96

97

Args:

Bu Sun Kim

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

[diff] [blame]

98

id: string, A parameter (required)

99

onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a

100

href="/youtube/v3/guides/authentication">authorized request</a>.

101

Note: This parameter is intended exclusively for YouTube

102

content partners. The

103

<code>onBehalfOfContentOwnerChannel</code> parameter

104

specifies the YouTube channel ID of the channel to which a video is being

105

added. This parameter is required when a request specifies a value for the

106

<code>onBehalfOfContentOwner</code> parameter, and it can only be used in

107

conjunction with that parameter. In addition, the request must be

108

authorized using a CMS account that is linked to the content owner that the

109

<code>onBehalfOfContentOwner</code> parameter specifies. Finally, the

110

channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value

111

specifies must be linked to the content owner that the

112

<code>onBehalfOfContentOwner</code> parameter specifies. This

113

parameter is intended for YouTube content partners that own and manage many

114

different YouTube channels. It allows content owners to authenticate once

115

and perform actions on behalf of the channel specified in the parameter

116

value, without having to provide authentication credentials for each

117

separate channel.

118

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

119

content partners. The

120

<code>onBehalfOfContentOwner</code> parameter indicates

121

that the

122

request's authorization credentials identify a YouTube CMS user who is

123

acting on behalf of the content owner specified in the parameter value.

124

This parameter is intended for YouTube content partners that own and manage

125

many different YouTube channels. It allows content owners to authenticate

126

once and get access to all their video and channel data, without having to

127

provide authentication credentials for each individual channel. The CMS

128

account that the user authenticates with must be linked to the specified

129

YouTube content owner.

130

x__xgafv: string, V1 error format.

131

Allowed values

132

1 - v1 error format

133

2 - v2 error format

John Asmuth

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

[diff] [blame]

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

138

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

139

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

John Asmuth

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

[diff] [blame]

140

141

Args:

Bu Sun Kim

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

[diff] [blame]

142

part: string, The <code>part</code> parameter serves two purposes in

143

this operation. It identifies the properties that the write operation will

144

set as well as the properties that the API response will

145

include. The <code>part</code> properties that you can include in

146

the parameter value are <code>id</code>, <code>snippet</code>,

147

<code>cdn</code>, and <code>status</code>. (required) (repeated)

Dan O'Meara

dd49464

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

[diff] [blame]

148

body: object, The request body.

John Asmuth

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

[diff] [blame]

149

The object takes the form of:

150

151

{ # A live stream describes a live ingestion point.

Bu Sun Kim

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

[diff] [blame]

152

"cdn": { # Brief description of the live stream cdn settings. # The <code>cdn</code> object defines the live stream's content delivery

153

# network (CDN) settings. These settings provide details about the manner

154

# in which you stream your content to YouTube.

155

"ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The <code>ingestionInfo</code> object contains information that YouTube

156

# provides that you need to transmit your RTMP or HTTP stream to YouTube.

157

"rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of

158

# <code>backupIngestionAddress</code> in order to stream via RTMPS. Not

159

# applicable to non-RTMP streams.

160

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

161

"backupIngestionAddress": "A String", # The backup ingestion URL that you should use to stream video to

162

# YouTube. You have the option of simultaneously streaming the content

163

# that you are sending to the <code>ingestionAddress</code> to this URL.

164

"ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to

165

# YouTube. You must stream video to this URL.

166

# Depending on which application or tool you use to encode

167

# your video stream, you may need to enter the stream URL and stream

168

# name separately or you may need to concatenate them in the following

169

# format: <pre>STREAM_URL/STREAM_NAME</pre>

170

"rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of

171

# <code>ingestionAddress</code> in order to stream via RTMPS. Not applicable

172

# to non-RTMP streams.

John Asmuth

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

[diff] [blame]

173

},

Bu Sun Kim

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

[diff] [blame]

174

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

175

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

176

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

177

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

178

},

179

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

180

"contentDetails": { # Detailed settings of a stream. # The <code>content_details</code> object contains information about the

181

# stream, including the closed captions ingestion URL.

182

"isReusable": True or False, # Indicates whether the stream is reusable, which means that it

183

# can be bound to multiple broadcasts. It is common for

184

# broadcasters to reuse the same stream for many different

185

# broadcasts if those broadcasts occur at different times.

186

# If you set this value to <code>false</code>, then the stream

187

# will not be reusable, which means that it can only be bound to

188

# one broadcast. Non-reusable streams differ from reusable streams in the

189

# following ways:

190

# <ul>

191

# <li>A non-reusable stream can only be bound to one broadcast.</li>

192

# <li>A non-reusable stream might be deleted by an automated process

193

# after the broadcast ends.</li>

194

# <li>The <code><a href="/youtube/v3/live/docs/liveStreams/list">

195

# liveStreams.list</a></code> method does not list non-reusable streams

196

# if you call the method and set the <code>mine</code> parameter to

197

# <code>true</code>. The only way to use that method to retrieve the

198

# resource for a non-reusable stream is to use the <code>id</code>

199

# parameter to identify the stream.</li>

200

# </ul>

201

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

202

},

203

"status": { # Brief description of the live stream status. # The <code>status</code> object contains information about

204

# live stream's status.

205

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

206

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

207

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

208

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

209

{

210

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

211

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

212

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

213

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

214

},

215

],

John Asmuth

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

[diff] [blame]

216

},

Bu Sun Kim

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

[diff] [blame]

217

"streamStatus": "A String",

218

},

219

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

220

# <code>"youtube#liveStream"</code>.

221

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

222

"snippet": { # The <code>snippet</code> object contains basic details about the

223

# stream, including its channel, title, and description.

224

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

225

# is transmitting the stream.

226

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

227

# characters.

228

"publishedAt": "A String", # The date and time that the stream was created. The value is specified in

229

# <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

230

# format.

231

"isDefaultStream": True or False,

232

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

233

},

234

}

John Asmuth

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

[diff] [blame]

235

Bu Sun Kim

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

[diff] [blame]

236

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

237

content partners. The

238

<code>onBehalfOfContentOwner</code> parameter indicates

239

that the

240

request's authorization credentials identify a YouTube CMS user who is

241

acting on behalf of the content owner specified in the parameter value.

242

This parameter is intended for YouTube content partners that own and manage

243

many different YouTube channels. It allows content owners to authenticate

244

once and get access to all their video and channel data, without having to

245

provide authentication credentials for each individual channel. The CMS

246

account that the user authenticates with must be linked to the specified

247

YouTube content owner.

248

onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a

249

href="/youtube/v3/guides/authentication">authorized request</a>.

250

Note: This parameter is intended exclusively for YouTube

251

content partners. The

252

<code>onBehalfOfContentOwnerChannel</code> parameter

253

specifies the YouTube channel ID of the channel to which a video is being

254

added. This parameter is required when a request specifies a value for the

255

<code>onBehalfOfContentOwner</code> parameter, and it can only be used in

256

conjunction with that parameter. In addition, the request must be

257

authorized using a CMS account that is linked to the content owner that the

258

<code>onBehalfOfContentOwner</code> parameter specifies. Finally, the

259

channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value

260

specifies must be linked to the content owner that the

261

<code>onBehalfOfContentOwner</code> parameter specifies. This

262

parameter is intended for YouTube content partners that own and manage many

263

different YouTube channels. It allows content owners to authenticate once

264

and perform actions on behalf of the channel specified in the parameter

265

value, without having to provide authentication credentials for each

266

separate channel.

267

x__xgafv: string, V1 error format.

268

Allowed values

269

1 - v1 error format

270

2 - v2 error format

John Asmuth

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

[diff] [blame]

271

272

Returns:

273

An object of the form:

274

275

{ # A live stream describes a live ingestion point.

Bu Sun Kim

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

[diff] [blame]

276

"cdn": { # Brief description of the live stream cdn settings. # The <code>cdn</code> object defines the live stream's content delivery

277

# network (CDN) settings. These settings provide details about the manner

278

# in which you stream your content to YouTube.

279

"ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The <code>ingestionInfo</code> object contains information that YouTube

280

# provides that you need to transmit your RTMP or HTTP stream to YouTube.

281

"rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of

282

# <code>backupIngestionAddress</code> in order to stream via RTMPS. Not

283

# applicable to non-RTMP streams.

284

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

285

"backupIngestionAddress": "A String", # The backup ingestion URL that you should use to stream video to

286

# YouTube. You have the option of simultaneously streaming the content

287

# that you are sending to the <code>ingestionAddress</code> to this URL.

288

"ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to

289

# YouTube. You must stream video to this URL.

290

# Depending on which application or tool you use to encode

291

# your video stream, you may need to enter the stream URL and stream

292

# name separately or you may need to concatenate them in the following

293

# format: <pre>STREAM_URL/STREAM_NAME</pre>

294

"rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of

295

# <code>ingestionAddress</code> in order to stream via RTMPS. Not applicable

296

# to non-RTMP streams.

John Asmuth

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

[diff] [blame]

297

},

Bu Sun Kim

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

[diff] [blame]

298

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

299

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

300

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

301

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

302

},

303

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

304

"contentDetails": { # Detailed settings of a stream. # The <code>content_details</code> object contains information about the

305

# stream, including the closed captions ingestion URL.

306

"isReusable": True or False, # Indicates whether the stream is reusable, which means that it

307

# can be bound to multiple broadcasts. It is common for

308

# broadcasters to reuse the same stream for many different

309

# broadcasts if those broadcasts occur at different times.

310

# If you set this value to <code>false</code>, then the stream

311

# will not be reusable, which means that it can only be bound to

312

# one broadcast. Non-reusable streams differ from reusable streams in the

313

# following ways:

314

# <ul>

315

# <li>A non-reusable stream can only be bound to one broadcast.</li>

316

# <li>A non-reusable stream might be deleted by an automated process

317

# after the broadcast ends.</li>

318

# <li>The <code><a href="/youtube/v3/live/docs/liveStreams/list">

319

# liveStreams.list</a></code> method does not list non-reusable streams

320

# if you call the method and set the <code>mine</code> parameter to

321

# <code>true</code>. The only way to use that method to retrieve the

322

# resource for a non-reusable stream is to use the <code>id</code>

323

# parameter to identify the stream.</li>

324

# </ul>

325

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

326

},

327

"status": { # Brief description of the live stream status. # The <code>status</code> object contains information about

328

# live stream's status.

329

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

330

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

331

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

332

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

333

{

334

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

335

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

336

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

337

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

338

},

339

],

John Asmuth

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

[diff] [blame]

340

},

Bu Sun Kim

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

[diff] [blame]

341

"streamStatus": "A String",

342

},

343

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

344

# <code>"youtube#liveStream"</code>.

345

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

346

"snippet": { # The <code>snippet</code> object contains basic details about the

347

# stream, including its channel, title, and description.

348

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

349

# is transmitting the stream.

350

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

351

# characters.

352

"publishedAt": "A String", # The date and time that the stream was created. The value is specified in

353

# <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

354

# format.

355

"isDefaultStream": True or False,

356

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

357

},

358

}</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]

362

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

363

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

John Asmuth

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

[diff] [blame]

364

365

Args:

Bu Sun Kim

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

[diff] [blame]

366

part: string, The <code>part</code> parameter specifies a

367

comma-separated list of one or more <code>liveStream</code> resource

368

properties that the API response will include. The <code>part</code> names

369

that you can include in the parameter value are <code>id</code>,

370

<code>snippet</code>, <code>cdn</code>, and <code>status</code>. (required) (repeated)

371

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

372

content partners. The

373

<code>onBehalfOfContentOwner</code> parameter indicates

374

that the

375

request's authorization credentials identify a YouTube CMS user who is

376

acting on behalf of the content owner specified in the parameter value.

377

This parameter is intended for YouTube content partners that own and manage

378

many different YouTube channels. It allows content owners to authenticate

379

once and get access to all their video and channel data, without having to

380

provide authentication credentials for each individual channel. The CMS

381

account that the user authenticates with must be linked to the specified

382

YouTube content owner.

383

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

384

mine: boolean, A parameter

385

maxResults: integer, The <code>maxResults</code> parameter specifies the

386

maximum number of items that should be returned in the result set.

387

onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a

388

href="/youtube/v3/guides/authentication">authorized request</a>.

389

Note: This parameter is intended exclusively for YouTube

390

content partners. The

391

<code>onBehalfOfContentOwnerChannel</code> parameter

392

specifies the YouTube channel ID of the channel to which a video is being

393

added. This parameter is required when a request specifies a value for the

394

<code>onBehalfOfContentOwner</code> parameter, and it can only be used in

395

conjunction with that parameter. In addition, the request must be

396

authorized using a CMS account that is linked to the content owner that the

397

<code>onBehalfOfContentOwner</code> parameter specifies. Finally, the

398

channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value

399

specifies must be linked to the content owner that the

400

<code>onBehalfOfContentOwner</code> parameter specifies. This

401

parameter is intended for YouTube content partners that own and manage many

402

different YouTube channels. It allows content owners to authenticate once

403

and perform actions on behalf of the channel specified in the parameter

404

value, without having to provide authentication credentials for each

405

separate channel.

406

pageToken: string, The <code>pageToken</code> parameter identifies a specific

407

page in the result set that should be returned. In an API response, the

408

<code>nextPageToken</code> and <code>prevPageToken</code> properties

409

identify other pages that could be retrieved.

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

418

{

Bu Sun Kim

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

[diff] [blame]

419

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

Bu Sun Kim

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

[diff] [blame]

420

"visitorId": "A String", # The <code>visitorId</code> identifies the visitor.

Bu Sun Kim

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

[diff] [blame]

421

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

John Asmuth

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

[diff] [blame]

422

{ # A live stream describes a live ingestion point.

Bu Sun Kim

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

[diff] [blame]

423

"cdn": { # Brief description of the live stream cdn settings. # The <code>cdn</code> object defines the live stream's content delivery

424

# network (CDN) settings. These settings provide details about the manner

425

# in which you stream your content to YouTube.

426

"ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The <code>ingestionInfo</code> object contains information that YouTube

427

# provides that you need to transmit your RTMP or HTTP stream to YouTube.

428

"rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of

429

# <code>backupIngestionAddress</code> in order to stream via RTMPS. Not

430

# applicable to non-RTMP streams.

431

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

432

"backupIngestionAddress": "A String", # The backup ingestion URL that you should use to stream video to

433

# YouTube. You have the option of simultaneously streaming the content

434

# that you are sending to the <code>ingestionAddress</code> to this URL.

435

"ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to

436

# YouTube. You must stream video to this URL.

437

# Depending on which application or tool you use to encode

438

# your video stream, you may need to enter the stream URL and stream

439

# name separately or you may need to concatenate them in the following

440

# format: <pre>STREAM_URL/STREAM_NAME</pre>

441

"rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of

442

# <code>ingestionAddress</code> in order to stream via RTMPS. Not applicable

443

# to non-RTMP streams.

John Asmuth

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

[diff] [blame]

444

},

Bu Sun Kim

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

[diff] [blame]

445

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

446

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

447

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

448

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

John Asmuth

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

[diff] [blame]

449

},

Bu Sun Kim

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

[diff] [blame]

450

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

451

"contentDetails": { # Detailed settings of a stream. # The <code>content_details</code> object contains information about the

452

# stream, including the closed captions ingestion URL.

453

"isReusable": True or False, # Indicates whether the stream is reusable, which means that it

454

# can be bound to multiple broadcasts. It is common for

455

# broadcasters to reuse the same stream for many different

456

# broadcasts if those broadcasts occur at different times.

457

# If you set this value to <code>false</code>, then the stream

458

# will not be reusable, which means that it can only be bound to

459

# one broadcast. Non-reusable streams differ from reusable streams in the

460

# following ways:

461

# <ul>

462

# <li>A non-reusable stream can only be bound to one broadcast.</li>

463

# <li>A non-reusable stream might be deleted by an automated process

464

# after the broadcast ends.</li>

465

# <li>The <code><a href="/youtube/v3/live/docs/liveStreams/list">

466

# liveStreams.list</a></code> method does not list non-reusable streams

467

# if you call the method and set the <code>mine</code> parameter to

468

# <code>true</code>. The only way to use that method to retrieve the

469

# resource for a non-reusable stream is to use the <code>id</code>

470

# parameter to identify the stream.</li>

471

# </ul>

472

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

473

},

474

"status": { # Brief description of the live stream status. # The <code>status</code> object contains information about

475

# live stream's status.

476

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

477

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

478

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

479

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

480

{

481

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

482

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

483

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

484

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

},

],

},

"streamStatus": "A String",

489

},

490

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

491

# <code>"youtube#liveStream"</code>.

492

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

493

"snippet": { # The <code>snippet</code> object contains basic details about the

494

# stream, including its channel, title, and description.

495

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

496

# is transmitting the stream.

497

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

498

# characters.

499

"publishedAt": "A String", # The date and time that the stream was created. The value is specified in

500

# <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

501

# format.

502

"isDefaultStream": True or False,

503

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

504

},

505

},

John Asmuth

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

[diff] [blame]

506

],

Bu Sun Kim

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

[diff] [blame]

507

"prevPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>

508

# parameter to retrieve the previous page in the result set.

509

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

510

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

511

},

512

"nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>

513

# parameter to retrieve the next page in the result set.

514

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

515

# <code>"youtube#liveStreamListResponse"</code>.

516

"pageInfo": { # Paging details for lists of resources, including total number of items

517

# available and number of resources returned in a single page.

Bu Sun Kim

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

[diff] [blame]

518

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

519

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

John Asmuth

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

[diff] [blame]

520

},

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>

526

<pre>Retrieves the next page of results.

527

528

Args:

529

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

530

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

531

532

Returns:

Bu Sun Kim

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

[diff] [blame]

533

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

John Asmuth

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

[diff] [blame]

534

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]

539

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

540

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

John Asmuth

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

[diff] [blame]

541

542

Args:

Bu Sun Kim

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

[diff] [blame]

543

part: string, The <code>part</code> parameter serves two purposes in

544

this operation. It identifies the properties that the write operation will

545

set as well as the properties that the API response will

546

include. The <code>part</code> properties that you can include in

547

the parameter value are <code>id</code>, <code>snippet</code>,

548

<code>cdn</code>, and <code>status</code>. Note that this method

549

will override the existing values for all of the mutable properties that

550

are contained in any parts that the parameter value specifies. If the

551

request body does not specify a value for a mutable property, the existing

552

value for that property will be removed. (required) (repeated)

Dan O'Meara

dd49464

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

[diff] [blame]

553

body: object, The request body.

John Asmuth

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

[diff] [blame]

554

The object takes the form of:

555

556

{ # A live stream describes a live ingestion point.

Bu Sun Kim

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

[diff] [blame]

557

"cdn": { # Brief description of the live stream cdn settings. # The <code>cdn</code> object defines the live stream's content delivery

558

# network (CDN) settings. These settings provide details about the manner

559

# in which you stream your content to YouTube.

560

"ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The <code>ingestionInfo</code> object contains information that YouTube

561

# provides that you need to transmit your RTMP or HTTP stream to YouTube.

562

"rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of

563

# <code>backupIngestionAddress</code> in order to stream via RTMPS. Not

564

# applicable to non-RTMP streams.

565

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

566

"backupIngestionAddress": "A String", # The backup ingestion URL that you should use to stream video to

567

# YouTube. You have the option of simultaneously streaming the content

568

# that you are sending to the <code>ingestionAddress</code> to this URL.

569

"ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to

570

# YouTube. You must stream video to this URL.

571

# Depending on which application or tool you use to encode

572

# your video stream, you may need to enter the stream URL and stream

573

# name separately or you may need to concatenate them in the following

574

# format: <pre>STREAM_URL/STREAM_NAME</pre>

575

"rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of

576

# <code>ingestionAddress</code> in order to stream via RTMPS. Not applicable

577

# to non-RTMP streams.

John Asmuth

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

[diff] [blame]

578

},

Bu Sun Kim

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

[diff] [blame]

579

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

580

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

581

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

582

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

583

},

584

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

585

"contentDetails": { # Detailed settings of a stream. # The <code>content_details</code> object contains information about the

586

# stream, including the closed captions ingestion URL.

587

"isReusable": True or False, # Indicates whether the stream is reusable, which means that it

588

# can be bound to multiple broadcasts. It is common for

589

# broadcasters to reuse the same stream for many different

590

# broadcasts if those broadcasts occur at different times.

591

# If you set this value to <code>false</code>, then the stream

592

# will not be reusable, which means that it can only be bound to

593

# one broadcast. Non-reusable streams differ from reusable streams in the

594

# following ways:

595

# <ul>

596

# <li>A non-reusable stream can only be bound to one broadcast.</li>

597

# <li>A non-reusable stream might be deleted by an automated process

598

# after the broadcast ends.</li>

599

# <li>The <code><a href="/youtube/v3/live/docs/liveStreams/list">

600

# liveStreams.list</a></code> method does not list non-reusable streams

601

# if you call the method and set the <code>mine</code> parameter to

602

# <code>true</code>. The only way to use that method to retrieve the

603

# resource for a non-reusable stream is to use the <code>id</code>

604

# parameter to identify the stream.</li>

605

# </ul>

606

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

607

},

608

"status": { # Brief description of the live stream status. # The <code>status</code> object contains information about

609

# live stream's status.

610

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

611

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

612

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

613

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

614

{

615

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

616

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

617

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

618

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

619

},

620

],

John Asmuth

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

[diff] [blame]

621

},

Bu Sun Kim

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

[diff] [blame]

622

"streamStatus": "A String",

623

},

624

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

625

# <code>"youtube#liveStream"</code>.

626

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

627

"snippet": { # The <code>snippet</code> object contains basic details about the

628

# stream, including its channel, title, and description.

629

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

630

# is transmitting the stream.

631

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

632

# characters.

633

"publishedAt": "A String", # The date and time that the stream was created. The value is specified in

634

# <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

635

# format.

636

"isDefaultStream": True or False,

637

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

638

},

639

}

John Asmuth

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

[diff] [blame]

640

Bu Sun Kim

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

[diff] [blame]

641

onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a

642

href="/youtube/v3/guides/authentication">authorized request</a>.

643

Note: This parameter is intended exclusively for YouTube

644

content partners. The

645

<code>onBehalfOfContentOwnerChannel</code> parameter

646

specifies the YouTube channel ID of the channel to which a video is being

647

added. This parameter is required when a request specifies a value for the

648

<code>onBehalfOfContentOwner</code> parameter, and it can only be used in

649

conjunction with that parameter. In addition, the request must be

650

authorized using a CMS account that is linked to the content owner that the

651

<code>onBehalfOfContentOwner</code> parameter specifies. Finally, the

652

channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value

653

specifies must be linked to the content owner that the

654

<code>onBehalfOfContentOwner</code> parameter specifies. This

655

parameter is intended for YouTube content partners that own and manage many

656

different YouTube channels. It allows content owners to authenticate once

657

and perform actions on behalf of the channel specified in the parameter

658

value, without having to provide authentication credentials for each

659

separate channel.

660

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

661

content partners. The

662

<code>onBehalfOfContentOwner</code> parameter indicates

663

that the

664

request's authorization credentials identify a YouTube CMS user who is

665

acting on behalf of the content owner specified in the parameter value.

666

This parameter is intended for YouTube content partners that own and manage

667

many different YouTube channels. It allows content owners to authenticate

668

once and get access to all their video and channel data, without having to

669

provide authentication credentials for each individual channel. The CMS

670

account that the user authenticates with must be linked to the specified

671

YouTube content owner.

672

x__xgafv: string, V1 error format.

673

Allowed values

674

1 - v1 error format

675

2 - v2 error format

John Asmuth

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

[diff] [blame]

676

677

Returns:

678

An object of the form:

679

680

{ # A live stream describes a live ingestion point.

Bu Sun Kim

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

[diff] [blame]

681

"cdn": { # Brief description of the live stream cdn settings. # The <code>cdn</code> object defines the live stream's content delivery

682

# network (CDN) settings. These settings provide details about the manner

683

# in which you stream your content to YouTube.

684

"ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The <code>ingestionInfo</code> object contains information that YouTube

685

# provides that you need to transmit your RTMP or HTTP stream to YouTube.

686

"rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of

687

# <code>backupIngestionAddress</code> in order to stream via RTMPS. Not

688

# applicable to non-RTMP streams.

689

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

690

"backupIngestionAddress": "A String", # The backup ingestion URL that you should use to stream video to

691

# YouTube. You have the option of simultaneously streaming the content

692

# that you are sending to the <code>ingestionAddress</code> to this URL.

693

"ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to

694

# YouTube. You must stream video to this URL.

695

# Depending on which application or tool you use to encode

696

# your video stream, you may need to enter the stream URL and stream

697

# name separately or you may need to concatenate them in the following

698

# format: <pre>STREAM_URL/STREAM_NAME</pre>

699

"rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of

700

# <code>ingestionAddress</code> in order to stream via RTMPS. Not applicable

701

# to non-RTMP streams.

John Asmuth

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

[diff] [blame]

702

},

Bu Sun Kim

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

[diff] [blame]

703

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

704

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

705

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

706

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

707

},

708

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

709

"contentDetails": { # Detailed settings of a stream. # The <code>content_details</code> object contains information about the

710

# stream, including the closed captions ingestion URL.

711

"isReusable": True or False, # Indicates whether the stream is reusable, which means that it

712

# can be bound to multiple broadcasts. It is common for

713

# broadcasters to reuse the same stream for many different

714

# broadcasts if those broadcasts occur at different times.

715

# If you set this value to <code>false</code>, then the stream

716

# will not be reusable, which means that it can only be bound to

717

# one broadcast. Non-reusable streams differ from reusable streams in the

718

# following ways:

719

# <ul>

720

# <li>A non-reusable stream can only be bound to one broadcast.</li>

721

# <li>A non-reusable stream might be deleted by an automated process

722

# after the broadcast ends.</li>

723

# <li>The <code><a href="/youtube/v3/live/docs/liveStreams/list">

724

# liveStreams.list</a></code> method does not list non-reusable streams

725

# if you call the method and set the <code>mine</code> parameter to

726

# <code>true</code>. The only way to use that method to retrieve the

727

# resource for a non-reusable stream is to use the <code>id</code>

728

# parameter to identify the stream.</li>

729

# </ul>

730

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

731

},

732

"status": { # Brief description of the live stream status. # The <code>status</code> object contains information about

733

# live stream's status.

734

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

735

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

736

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

737

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

738

{

739

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

740

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

741

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

742

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

743

},

744

],

John Asmuth

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

[diff] [blame]

745

},

Bu Sun Kim

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

[diff] [blame]

746

"streamStatus": "A String",

747

},

748

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

749

# <code>"youtube#liveStream"</code>.

750

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

751

"snippet": { # The <code>snippet</code> object contains basic details about the

752

# stream, including its channel, title, and description.

753

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

754

# is transmitting the stream.

755

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

756

# characters.

757

"publishedAt": "A String", # The date and time that the stream was created. The value is specified in

758

# <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

759

# format.

760

"isDefaultStream": True or False,

761

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

762

},

763

}</pre>

John Asmuth