| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.liveStreams.html">liveStreams</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(id, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes an existing stream for the authenticated user.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Inserts a new stream for the authenticated user.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(part, onBehalfOfContentOwner=None, id=None, mine=None, maxResults=None, onBehalfOfContentOwnerChannel=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieve the list of streams associated with the given channel. --</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#update">update(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates an existing stream for the authenticated user.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="delete">delete(id, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| <pre>Deletes an existing stream for the authenticated user. |
| |
| Args: |
| id: string, A parameter (required) |
| onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| href="/youtube/v3/guides/authentication">authorized request</a>. |
| <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwnerChannel</strong></code> 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 |
| <code>onBehalfOfContentOwner</code> 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 |
| <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| specifies must be linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>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. |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> 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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code> |
| <pre>Inserts a new stream for the authenticated user. |
| |
| Args: |
| part: string, The <code><strong>part</strong></code> 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.<br><br>The <code>part</code> properties that you can include in |
| the parameter value are <code>id</code>, <code>snippet</code>, |
| <code>cdn</code>, and <code>status</code>. (required) (repeated) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A live stream describes a live ingestion point. |
| "cdn": { # Brief description of the live stream cdn settings. # The <code>cdn</code> 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. |
| "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The <code>ingestionInfo</code> object contains information that YouTube |
| # provides that you need to transmit your RTMP or HTTP stream to YouTube. |
| "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of |
| # <code>backupIngestionAddress</code> in order to stream via RTMPS. Not |
| # applicable to non-RTMP streams. |
| "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream. |
| "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 <code>ingestionAddress</code> to this URL. |
| "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to |
| # YouTube. You must stream video to this URL.<br><br> |
| # 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:<br><pre><strong>STREAM_URL/STREAM_NAME</strong></pre> |
| "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of |
| # <code>ingestionAddress</code> in order to stream via RTMPS. Not applicable |
| # to non-RTMP streams. |
| }, |
| "format": "A String", # The format of the video stream that you are sending to Youtube. <br><br> |
| "frameRate": "A String", # The frame rate of the inbound video data. |
| "resolution": "A String", # The resolution of the inbound video data. |
| "ingestionType": "A String", # The method or protocol used to transmit the video stream. |
| }, |
| "etag": "A String", # Etag of this resource. |
| "contentDetails": { # Detailed settings of a stream. # The <code>content_details</code> object contains information about the |
| # stream, including the closed captions ingestion URL. |
| "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.<br><br> |
| # If you set this value to <code>false</code>, 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: |
| # <ul> |
| # <li>A non-reusable stream can only be bound to one broadcast.</li> |
| # <li>A non-reusable stream might be deleted by an automated process |
| # after the broadcast ends.</li> |
| # <li>The <code><a href="/youtube/v3/live/docs/liveStreams/list"> |
| # liveStreams.list</a></code> method does not list non-reusable streams |
| # if you call the method and set the <code>mine</code> parameter to |
| # <code>true</code>. The only way to use that method to retrieve the |
| # resource for a non-reusable stream is to use the <code>id</code> |
| # parameter to identify the stream.</li> |
| # </ul> |
| "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent. |
| }, |
| "status": { # Brief description of the live stream status. # The <code>status</code> object contains information about |
| # live stream's status. |
| "healthStatus": { # The health status of the stream. |
| "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds) |
| "status": "A String", # The status code of this stream |
| "configurationIssues": [ # The configurations issues on this stream |
| { |
| "type": "A String", # The kind of error happening. |
| "description": "A String", # The long-form description of the issue and how to resolve it. |
| "reason": "A String", # The short-form reason for this issue. |
| "severity": "A String", # How severe this issue is to the stream. |
| }, |
| ], |
| }, |
| "streamStatus": "A String", |
| }, |
| "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#liveStream"</code>. |
| "id": "A String", # The ID that YouTube assigns to uniquely identify the stream. |
| "snippet": { # The <code>snippet</code> object contains basic details about the |
| # stream, including its channel, title, and description. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # is transmitting the stream. |
| "description": "A String", # The stream's description. The value cannot be longer than 10000 |
| # characters. |
| "publishedAt": "A String", # The date and time that the stream was created. The value is specified in |
| # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "isDefaultStream": True or False, |
| "title": "A String", # The stream's title. The value must be between 1 and 128 characters long. |
| }, |
| } |
| |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> 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. |
| onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| href="/youtube/v3/guides/authentication">authorized request</a>. |
| <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwnerChannel</strong></code> 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 |
| <code>onBehalfOfContentOwner</code> 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 |
| <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| specifies must be linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A live stream describes a live ingestion point. |
| "cdn": { # Brief description of the live stream cdn settings. # The <code>cdn</code> 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. |
| "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The <code>ingestionInfo</code> object contains information that YouTube |
| # provides that you need to transmit your RTMP or HTTP stream to YouTube. |
| "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of |
| # <code>backupIngestionAddress</code> in order to stream via RTMPS. Not |
| # applicable to non-RTMP streams. |
| "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream. |
| "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 <code>ingestionAddress</code> to this URL. |
| "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to |
| # YouTube. You must stream video to this URL.<br><br> |
| # 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:<br><pre><strong>STREAM_URL/STREAM_NAME</strong></pre> |
| "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of |
| # <code>ingestionAddress</code> in order to stream via RTMPS. Not applicable |
| # to non-RTMP streams. |
| }, |
| "format": "A String", # The format of the video stream that you are sending to Youtube. <br><br> |
| "frameRate": "A String", # The frame rate of the inbound video data. |
| "resolution": "A String", # The resolution of the inbound video data. |
| "ingestionType": "A String", # The method or protocol used to transmit the video stream. |
| }, |
| "etag": "A String", # Etag of this resource. |
| "contentDetails": { # Detailed settings of a stream. # The <code>content_details</code> object contains information about the |
| # stream, including the closed captions ingestion URL. |
| "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.<br><br> |
| # If you set this value to <code>false</code>, 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: |
| # <ul> |
| # <li>A non-reusable stream can only be bound to one broadcast.</li> |
| # <li>A non-reusable stream might be deleted by an automated process |
| # after the broadcast ends.</li> |
| # <li>The <code><a href="/youtube/v3/live/docs/liveStreams/list"> |
| # liveStreams.list</a></code> method does not list non-reusable streams |
| # if you call the method and set the <code>mine</code> parameter to |
| # <code>true</code>. The only way to use that method to retrieve the |
| # resource for a non-reusable stream is to use the <code>id</code> |
| # parameter to identify the stream.</li> |
| # </ul> |
| "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent. |
| }, |
| "status": { # Brief description of the live stream status. # The <code>status</code> object contains information about |
| # live stream's status. |
| "healthStatus": { # The health status of the stream. |
| "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds) |
| "status": "A String", # The status code of this stream |
| "configurationIssues": [ # The configurations issues on this stream |
| { |
| "type": "A String", # The kind of error happening. |
| "description": "A String", # The long-form description of the issue and how to resolve it. |
| "reason": "A String", # The short-form reason for this issue. |
| "severity": "A String", # How severe this issue is to the stream. |
| }, |
| ], |
| }, |
| "streamStatus": "A String", |
| }, |
| "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#liveStream"</code>. |
| "id": "A String", # The ID that YouTube assigns to uniquely identify the stream. |
| "snippet": { # The <code>snippet</code> object contains basic details about the |
| # stream, including its channel, title, and description. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # is transmitting the stream. |
| "description": "A String", # The stream's description. The value cannot be longer than 10000 |
| # characters. |
| "publishedAt": "A String", # The date and time that the stream was created. The value is specified in |
| # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "isDefaultStream": True or False, |
| "title": "A String", # The stream's title. The value must be between 1 and 128 characters long. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(part, onBehalfOfContentOwner=None, id=None, mine=None, maxResults=None, onBehalfOfContentOwnerChannel=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Retrieve the list of streams associated with the given channel. -- |
| |
| Args: |
| part: string, The <code><strong>part</strong></code> parameter specifies a |
| comma-separated list of one or more <code>liveStream</code> resource |
| properties that the API response will include. The <code>part</code> names |
| that you can include in the parameter value are <code>id</code>, |
| <code>snippet</code>, <code>cdn</code>, and <code>status</code>. (required) (repeated) |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> 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. |
| id: string, Return LiveStreams with the given ids from Stubby or Apiary. (repeated) |
| mine: boolean, A parameter |
| maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the |
| maximum number of items that should be returned in the result set. |
| onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| href="/youtube/v3/guides/authentication">authorized request</a>. |
| <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwnerChannel</strong></code> 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 |
| <code>onBehalfOfContentOwner</code> 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 |
| <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| specifies must be linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>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. |
| pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific |
| page in the result set that should be returned. In an API response, the |
| <code>nextPageToken</code> and <code>prevPageToken</code> properties |
| identify other pages that could be retrieved. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "eventId": "A String", # Serialized EventId of the request which produced this response. |
| "visitorId": "A String", # The <code>visitorId</code> identifies the visitor. |
| "items": [ # A list of live streams that match the request criteria. |
| { # A live stream describes a live ingestion point. |
| "cdn": { # Brief description of the live stream cdn settings. # The <code>cdn</code> 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. |
| "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The <code>ingestionInfo</code> object contains information that YouTube |
| # provides that you need to transmit your RTMP or HTTP stream to YouTube. |
| "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of |
| # <code>backupIngestionAddress</code> in order to stream via RTMPS. Not |
| # applicable to non-RTMP streams. |
| "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream. |
| "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 <code>ingestionAddress</code> to this URL. |
| "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to |
| # YouTube. You must stream video to this URL.<br><br> |
| # 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:<br><pre><strong>STREAM_URL/STREAM_NAME</strong></pre> |
| "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of |
| # <code>ingestionAddress</code> in order to stream via RTMPS. Not applicable |
| # to non-RTMP streams. |
| }, |
| "format": "A String", # The format of the video stream that you are sending to Youtube. <br><br> |
| "frameRate": "A String", # The frame rate of the inbound video data. |
| "resolution": "A String", # The resolution of the inbound video data. |
| "ingestionType": "A String", # The method or protocol used to transmit the video stream. |
| }, |
| "etag": "A String", # Etag of this resource. |
| "contentDetails": { # Detailed settings of a stream. # The <code>content_details</code> object contains information about the |
| # stream, including the closed captions ingestion URL. |
| "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.<br><br> |
| # If you set this value to <code>false</code>, 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: |
| # <ul> |
| # <li>A non-reusable stream can only be bound to one broadcast.</li> |
| # <li>A non-reusable stream might be deleted by an automated process |
| # after the broadcast ends.</li> |
| # <li>The <code><a href="/youtube/v3/live/docs/liveStreams/list"> |
| # liveStreams.list</a></code> method does not list non-reusable streams |
| # if you call the method and set the <code>mine</code> parameter to |
| # <code>true</code>. The only way to use that method to retrieve the |
| # resource for a non-reusable stream is to use the <code>id</code> |
| # parameter to identify the stream.</li> |
| # </ul> |
| "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent. |
| }, |
| "status": { # Brief description of the live stream status. # The <code>status</code> object contains information about |
| # live stream's status. |
| "healthStatus": { # The health status of the stream. |
| "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds) |
| "status": "A String", # The status code of this stream |
| "configurationIssues": [ # The configurations issues on this stream |
| { |
| "type": "A String", # The kind of error happening. |
| "description": "A String", # The long-form description of the issue and how to resolve it. |
| "reason": "A String", # The short-form reason for this issue. |
| "severity": "A String", # How severe this issue is to the stream. |
| }, |
| ], |
| }, |
| "streamStatus": "A String", |
| }, |
| "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#liveStream"</code>. |
| "id": "A String", # The ID that YouTube assigns to uniquely identify the stream. |
| "snippet": { # The <code>snippet</code> object contains basic details about the |
| # stream, including its channel, title, and description. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # is transmitting the stream. |
| "description": "A String", # The stream's description. The value cannot be longer than 10000 |
| # characters. |
| "publishedAt": "A String", # The date and time that the stream was created. The value is specified in |
| # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "isDefaultStream": True or False, |
| "title": "A String", # The stream's title. The value must be between 1 and 128 characters long. |
| }, |
| }, |
| ], |
| "prevPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code> |
| # parameter to retrieve the previous page in the result set. |
| "etag": "A String", # Etag of this resource. |
| "tokenPagination": { # Stub token pagination template to suppress results. |
| }, |
| "nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code> |
| # parameter to retrieve the next page in the result set. |
| "kind": "youtube#liveStreamListResponse", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#liveStreamListResponse"</code>. |
| "pageInfo": { # Paging details for lists of resources, including total number of items |
| # available and number of resources returned in a single page. |
| "resultsPerPage": 42, # The number of results included in the API response. |
| "totalResults": 42, # The total number of results in the result set. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| <pre>Updates an existing stream for the authenticated user. |
| |
| Args: |
| part: string, The <code><strong>part</strong></code> 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.<br><br>The <code>part</code> properties that you can include in |
| the parameter value are <code>id</code>, <code>snippet</code>, |
| <code>cdn</code>, and <code>status</code>.<br><br>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) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A live stream describes a live ingestion point. |
| "cdn": { # Brief description of the live stream cdn settings. # The <code>cdn</code> 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. |
| "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The <code>ingestionInfo</code> object contains information that YouTube |
| # provides that you need to transmit your RTMP or HTTP stream to YouTube. |
| "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of |
| # <code>backupIngestionAddress</code> in order to stream via RTMPS. Not |
| # applicable to non-RTMP streams. |
| "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream. |
| "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 <code>ingestionAddress</code> to this URL. |
| "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to |
| # YouTube. You must stream video to this URL.<br><br> |
| # 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:<br><pre><strong>STREAM_URL/STREAM_NAME</strong></pre> |
| "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of |
| # <code>ingestionAddress</code> in order to stream via RTMPS. Not applicable |
| # to non-RTMP streams. |
| }, |
| "format": "A String", # The format of the video stream that you are sending to Youtube. <br><br> |
| "frameRate": "A String", # The frame rate of the inbound video data. |
| "resolution": "A String", # The resolution of the inbound video data. |
| "ingestionType": "A String", # The method or protocol used to transmit the video stream. |
| }, |
| "etag": "A String", # Etag of this resource. |
| "contentDetails": { # Detailed settings of a stream. # The <code>content_details</code> object contains information about the |
| # stream, including the closed captions ingestion URL. |
| "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.<br><br> |
| # If you set this value to <code>false</code>, 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: |
| # <ul> |
| # <li>A non-reusable stream can only be bound to one broadcast.</li> |
| # <li>A non-reusable stream might be deleted by an automated process |
| # after the broadcast ends.</li> |
| # <li>The <code><a href="/youtube/v3/live/docs/liveStreams/list"> |
| # liveStreams.list</a></code> method does not list non-reusable streams |
| # if you call the method and set the <code>mine</code> parameter to |
| # <code>true</code>. The only way to use that method to retrieve the |
| # resource for a non-reusable stream is to use the <code>id</code> |
| # parameter to identify the stream.</li> |
| # </ul> |
| "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent. |
| }, |
| "status": { # Brief description of the live stream status. # The <code>status</code> object contains information about |
| # live stream's status. |
| "healthStatus": { # The health status of the stream. |
| "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds) |
| "status": "A String", # The status code of this stream |
| "configurationIssues": [ # The configurations issues on this stream |
| { |
| "type": "A String", # The kind of error happening. |
| "description": "A String", # The long-form description of the issue and how to resolve it. |
| "reason": "A String", # The short-form reason for this issue. |
| "severity": "A String", # How severe this issue is to the stream. |
| }, |
| ], |
| }, |
| "streamStatus": "A String", |
| }, |
| "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#liveStream"</code>. |
| "id": "A String", # The ID that YouTube assigns to uniquely identify the stream. |
| "snippet": { # The <code>snippet</code> object contains basic details about the |
| # stream, including its channel, title, and description. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # is transmitting the stream. |
| "description": "A String", # The stream's description. The value cannot be longer than 10000 |
| # characters. |
| "publishedAt": "A String", # The date and time that the stream was created. The value is specified in |
| # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "isDefaultStream": True or False, |
| "title": "A String", # The stream's title. The value must be between 1 and 128 characters long. |
| }, |
| } |
| |
| onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| href="/youtube/v3/guides/authentication">authorized request</a>. |
| <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwnerChannel</strong></code> 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 |
| <code>onBehalfOfContentOwner</code> 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 |
| <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| specifies must be linked to the content owner that the |
| <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>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. |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> 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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A live stream describes a live ingestion point. |
| "cdn": { # Brief description of the live stream cdn settings. # The <code>cdn</code> 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. |
| "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The <code>ingestionInfo</code> object contains information that YouTube |
| # provides that you need to transmit your RTMP or HTTP stream to YouTube. |
| "rtmpsBackupIngestionAddress": "A String", # This ingestion url may be used instead of |
| # <code>backupIngestionAddress</code> in order to stream via RTMPS. Not |
| # applicable to non-RTMP streams. |
| "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream. |
| "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 <code>ingestionAddress</code> to this URL. |
| "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to |
| # YouTube. You must stream video to this URL.<br><br> |
| # 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:<br><pre><strong>STREAM_URL/STREAM_NAME</strong></pre> |
| "rtmpsIngestionAddress": "A String", # This ingestion url may be used instead of |
| # <code>ingestionAddress</code> in order to stream via RTMPS. Not applicable |
| # to non-RTMP streams. |
| }, |
| "format": "A String", # The format of the video stream that you are sending to Youtube. <br><br> |
| "frameRate": "A String", # The frame rate of the inbound video data. |
| "resolution": "A String", # The resolution of the inbound video data. |
| "ingestionType": "A String", # The method or protocol used to transmit the video stream. |
| }, |
| "etag": "A String", # Etag of this resource. |
| "contentDetails": { # Detailed settings of a stream. # The <code>content_details</code> object contains information about the |
| # stream, including the closed captions ingestion URL. |
| "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.<br><br> |
| # If you set this value to <code>false</code>, 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: |
| # <ul> |
| # <li>A non-reusable stream can only be bound to one broadcast.</li> |
| # <li>A non-reusable stream might be deleted by an automated process |
| # after the broadcast ends.</li> |
| # <li>The <code><a href="/youtube/v3/live/docs/liveStreams/list"> |
| # liveStreams.list</a></code> method does not list non-reusable streams |
| # if you call the method and set the <code>mine</code> parameter to |
| # <code>true</code>. The only way to use that method to retrieve the |
| # resource for a non-reusable stream is to use the <code>id</code> |
| # parameter to identify the stream.</li> |
| # </ul> |
| "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent. |
| }, |
| "status": { # Brief description of the live stream status. # The <code>status</code> object contains information about |
| # live stream's status. |
| "healthStatus": { # The health status of the stream. |
| "lastUpdateTimeSeconds": "A String", # The last time this status was updated (in seconds) |
| "status": "A String", # The status code of this stream |
| "configurationIssues": [ # The configurations issues on this stream |
| { |
| "type": "A String", # The kind of error happening. |
| "description": "A String", # The long-form description of the issue and how to resolve it. |
| "reason": "A String", # The short-form reason for this issue. |
| "severity": "A String", # How severe this issue is to the stream. |
| }, |
| ], |
| }, |
| "streamStatus": "A String", |
| }, |
| "kind": "youtube#liveStream", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#liveStream"</code>. |
| "id": "A String", # The ID that YouTube assigns to uniquely identify the stream. |
| "snippet": { # The <code>snippet</code> object contains basic details about the |
| # stream, including its channel, title, and description. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that |
| # is transmitting the stream. |
| "description": "A String", # The stream's description. The value cannot be longer than 10000 |
| # characters. |
| "publishedAt": "A String", # The date and time that the stream was created. The value is specified in |
| # <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "isDefaultStream": True or False, |
| "title": "A String", # The stream's title. The value must be between 1 and 128 characters long. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
