Obtains the stream pushing status of a specified LiveChannel.

Request syntax

GET /ChannelName?live&comp=stat HTTP/1.1
Date: GMT date
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Authorization: SignatureValue

Response element

Element Type Description
LiveChannelStat Container Specifies the container used to store the response to the GetLiveChannelStat request.

Sub-node: Status, ConnectedTime, Video, and Audio

Parent node: None

Status Enumerated string Indicates the current stream pushing status of the LiveChannel.

Sub-node: None

Parent node: LiveChannelStat

Valid value: Disabled, Live, and Idle

ConnnectedTime String If the value of Status is Live, this parameter indicates the time when the current client start to push streams. The value of this parameter is in the ISO8601 format.

Sub-node: None

Parent node: LiveChannelStat

RemoteAddr String If the value of Status is Live, this parameter indicates the IP address of the current client that pushes streams.

Sub-node: None

Parent node: LiveChannelStat

Video Container If the value of Status is Live, this parameter specifies the container that stores the infomration about the video stream.

Sub-node: Width, Heigth, FrameRate, Bandwidth, and Codec

Parent node: LiveChannelStat

Width String Indicates the width (in pixels) of the current video stream.

Sub-node: None

Parent node: Video

Height String Indicates the height (in pixels) of the current video stream

Sub-node: None

Parent node: Video

FrameRate String Indicates the frame rate of the current video stream.

Sub-node: None

Parent node: Video

Bandwidth String Indicates the bit rate (bit/s) of the current video stream.

Sub-node: None

Parent node: Video

Codec Enumerated string Indicates the codec of the current video stream.

Sub-node: None

Parent node: Video

Audio Container If the value of Status is Live, this parameter specifies the container that stores the information about the audio stream.

Sub-node: SampleRate, Bandwidth, and Codec

Parent node: LiveChannelStat

SampleRate String Indicates the sampling rate of the current audio stream.

Sub-node: None

Parent node: Audio

Bandwidth String Indicates the bit rate (bit/s) of the current audio stream.

Sub-node: None

Parent node: Audio

Codec Enumerated string Indicates the codec of the current audio stream.

Sub-node: None

Parent node: Audio

Detail analysis

  • The Video and Audio containers are only returned when the value of Status is Live. However, they may not be returned even if the value of Status is Live. For example, the Video and Audio containers are not returned when the client is connected to the LiveChannel but does not start to send video and audio data.
  • Bandwidth indicates the average bit rate of the video or audio stream in the recent period. The value of Bandwidth may be 0 immediately after the Status of the LiveChannel is switched to Live.

Examples

Request exampe 1

GET /test-channel?live&comp=stat HTTP/1.1
Date: Thu, 25 Aug 2016 06:22:01 GMT
Host: test-bucket.oss-cn-hangzhou.aliyuncs.com
Authorization: OSS YJjHKOKWDWINLKXv:fOzwkAgVTVSO1VKLPIInQ0JYyOA=

Response exmample 1

HTTP/1.1 200
content-length: 100
server: AliyunOSS
connection: close
x-oss-request-id: 57BE8E89B92475920B002164
date: Thu, 25 Aug 2016 06:22:01 GMT
content-type: application/xml
<?xml version="1.0" encoding="UTF-8"?>
<LiveChannelStat>
  <Status>Idle</Status>
</LiveChannelStat>

Request example 1

GET /test-channel?live&comp=stat HTTP/1.1
Date: Thu, 25 Aug 2016 06:25:26 GMT
Host: test-bucket.oss-cn-hangzhou.aliyuncs.com
Authorization: OSS YJjHKOKWDWINLKXv:WeC5joEaRzfSSS8xK0tlo7WTK1I=

Response example 2

HTTP/1.1 200
content-length: 469
server: AliyunOSS
connection: close
x-oss-request-id: 57BE8F56B92475920B002187
date: Thu, 25 Aug 2016 06:25:26 GMT
content-type: application/xml
<?xml version="1.0" encoding="UTF-8"?>
<LiveChannelStat>
  <Status>Live</Status>
  <ConnectedTime>2016-08-25T06:25:15.000Z</ConnectedTime>
  <RemoteAddr>10.1.2.3:47745</RemoteAddr>
  <Video>
    <Width>1280</Width>
    <Height>536</Height>
    <FrameRate>24</FrameRate>
    <Bandwidth>0</Bandwidth>
    <Codec>H264</Codec>
  </Video>
  <Audio>
    <Bandwidth>0</Bandwidth>
    <SampleRate>44100</SampleRate>
    <Codec>ADPCM</Codec>
  </Audio>
</LiveChannelStat>