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

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

[diff] [blame]

88

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

John Asmuth

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

[diff] [blame]

89

90

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

91

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

92

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

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

John Asmuth

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

[diff] [blame]

95

<h3>Method Details</h3>

96

Dmitry Frenkel

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

[diff] [blame]

97

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

98

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

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

John Asmuth

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

[diff] [blame]

104

105

Args:

Bu Sun Kim

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

[diff] [blame]

106

id: string, A parameter (required)

Dmitry Frenkel

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

[diff] [blame]

107

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-11-16 11:05:03 -0700

[diff] [blame]

108

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]

109

x__xgafv: string, V1 error format.

110

Allowed values

111

1 - v1 error format

112

2 - v2 error format

John Asmuth

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

[diff] [blame]

</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

117

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

Bu Sun Kim

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

[diff] [blame]

118

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

John Asmuth

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

[diff] [blame]

119

120

Args:

Dmitry Frenkel

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

[diff] [blame]

121

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, cdn, and status. (required) (repeated)

Dan O'Meara

dd49464

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

[diff] [blame]

122

body: object, The request body.

John Asmuth

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

[diff] [blame]

123

The object takes the form of:

124

125

{ # A live stream describes a live ingestion point.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

126

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

127

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

128

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

129

"isDefaultStream": True or False,

130

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

131

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

John Asmuth

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

[diff] [blame]

132

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

133

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

134

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

135

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

136

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

137

{

138

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

139

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

140

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

141

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

142

},

143

],

144

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

145

},

146

"streamStatus": "A String",

John Asmuth

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

[diff] [blame]

147

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

148

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

149

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

150

"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. 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: - A non-reusable stream can only be bound to one broadcast. - A non-reusable stream might be deleted by an automated process after the broadcast ends. - 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.

151

},

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

"rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.

161

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

162

"ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL. 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: *STREAM_URL/STREAM_NAME*

163

"rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.

164

},

165

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

166

},

167

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

168

}

John Asmuth

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

[diff] [blame]

169

Dmitry Frenkel

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

[diff] [blame]

170

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-11-16 11:05:03 -0700

[diff] [blame]

171

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]

172

x__xgafv: string, V1 error format.

173

Allowed values

174

1 - v1 error format

175

2 - v2 error format

John Asmuth

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

[diff] [blame]

176

177

Returns:

178

An object of the form:

179

180

{ # A live stream describes a live ingestion point.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

181

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

182

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

183

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

184

"isDefaultStream": True or False,

185

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

186

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

John Asmuth

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

[diff] [blame]

187

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

188

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

189

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

190

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

191

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

192

{

193

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

194

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

195

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

196

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

197

},

198

],

199

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

200

},

201

"streamStatus": "A String",

John Asmuth

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

[diff] [blame]

202

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

203

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

204

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

205

"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. 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: - A non-reusable stream can only be bound to one broadcast. - A non-reusable stream might be deleted by an automated process after the broadcast ends. - 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.

206

},

207

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

208

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

209

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

210

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

211

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

212

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

213

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

214

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

215

"rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.

216

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

217

"ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL. 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: *STREAM_URL/STREAM_NAME*

218

"rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.

219

},

220

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

221

},

222

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

223

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

227

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

Bu Sun Kim

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

[diff] [blame]

228

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

John Asmuth

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

[diff] [blame]

229

230

Args:

Dmitry Frenkel

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

[diff] [blame]

231

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) (repeated)

Dmitry Frenkel

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

[diff] [blame]

232

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-11-16 11:05:03 -0700

[diff] [blame]

233

mine: boolean, A parameter

Dmitry Frenkel

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

[diff] [blame]

234

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

235

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.

236

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

237

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.

Bu Sun Kim

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

[diff] [blame]

238

x__xgafv: string, V1 error format.

239

Allowed values

240

1 - v1 error format

241

2 - v2 error format

John Asmuth

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

[diff] [blame]

242

243

Returns:

244

An object of the form:

245

246

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

247

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

248

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

249

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

250

},

Dmitry Frenkel

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

[diff] [blame]

251

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

252

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

253

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

Dmitry Frenkel

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

[diff] [blame]

254

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

255

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

256

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

257

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

Bu Sun Kim

6502091

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

[diff] [blame]

258

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

John Asmuth

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

[diff] [blame]

259

{ # A live stream describes a live ingestion point.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

260

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

261

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

262

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

263

"isDefaultStream": True or False,

264

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

265

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

John Asmuth

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

[diff] [blame]

266

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

267

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

268

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

269

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

270

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

271

{

272

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

273

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

274

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

275

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

276

},

277

],

278

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

279

},

280

"streamStatus": "A String",

Bu Sun Kim

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

[diff] [blame]

281

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

282

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

283

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

284

"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. 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: - A non-reusable stream can only be bound to one broadcast. - A non-reusable stream might be deleted by an automated process after the broadcast ends. - 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.

285

},

286

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

287

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

288

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

289

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

290

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

291

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

292

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

293

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

294

"rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.

295

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

296

"ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL. 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: *STREAM_URL/STREAM_NAME*

297

"rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.

298

},

299

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

300

},

301

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

Bu Sun Kim

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

[diff] [blame]

302

},

John Asmuth

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

[diff] [blame]

303

],

Dmitry Frenkel

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

[diff] [blame]

304

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

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>

310

<pre>Retrieves the next page of results.

311

312

Args:

313

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

314

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

315

316

Returns:

Bu Sun Kim

6502091

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

[diff] [blame]

317

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

John Asmuth

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

[diff] [blame]

318

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

</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

323

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

Bu Sun Kim

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

[diff] [blame]

324

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

John Asmuth

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

[diff] [blame]

325

326

Args:

Dmitry Frenkel

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

[diff] [blame]

327

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

Dan O'Meara

dd49464

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

[diff] [blame]

328

body: object, The request body.

John Asmuth

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

[diff] [blame]

329

The object takes the form of:

330

331

{ # A live stream describes a live ingestion point.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

332

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

333

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

334

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

335

"isDefaultStream": True or False,

336

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

337

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

John Asmuth

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

[diff] [blame]

338

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

339

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

340

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

341

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

342

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

343

{

344

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

345

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

346

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

347

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

348

},

349

],

350

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

351

},

352

"streamStatus": "A String",

John Asmuth

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

[diff] [blame]

353

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

354

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

355

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

356

"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. 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: - A non-reusable stream can only be bound to one broadcast. - A non-reusable stream might be deleted by an automated process after the broadcast ends. - 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.

357

},

358

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

359

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

360

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

361

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

362

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

363

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

364

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

365

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

366

"rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.

367

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

368

"ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL. 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: *STREAM_URL/STREAM_NAME*

369

"rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.

370

},

371

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

372

},

373

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

374

}

John Asmuth

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

[diff] [blame]

375

Dmitry Frenkel

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

[diff] [blame]

376

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-11-16 11:05:03 -0700

[diff] [blame]

377

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]

378

x__xgafv: string, V1 error format.

379

Allowed values

380

1 - v1 error format

381

2 - v2 error format

John Asmuth

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

[diff] [blame]

382

383

Returns:

384

An object of the form:

385

386

{ # A live stream describes a live ingestion point.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

387

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

388

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

389

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

390

"isDefaultStream": True or False,

391

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

392

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

John Asmuth

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

[diff] [blame]

393

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

394

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

395

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

396

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

397

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

398

{

399

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

400

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

401

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

402

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

403

},

404

],

405

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

406

},

407

"streamStatus": "A String",

John Asmuth

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

[diff] [blame]

408

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

409

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

410

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

411

"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. 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: - A non-reusable stream can only be bound to one broadcast. - A non-reusable stream might be deleted by an automated process after the broadcast ends. - 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.

412

},

413

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

414

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

415

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

416

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

417

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

418

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

419

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

420

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

421

"rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.

422

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

423

"ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL. 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: *STREAM_URL/STREAM_NAME*

424

"rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.

425

},

426

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

427

},

428

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

429

}</pre>

John Asmuth