Query Live Channel List

Last updated: 2020-06-07 19:10:09

    Note:

    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new LVB API 3.0 which is standardized and faster.

    1. API Description

    Domain name: live.api.qcloud.com

    This API (DescribeLVBChannelList) is used to obtain all LVB channel information of a user, including channel ID, current status, name, and creation time.

    2. Input Parameters

    Parameter Name Required Type Description
    channelStatus No Unsigned integer Channel status, used to filter channel list (0: without input stream; 1: with input stream; 2: exception; 3: closed; 4: incomplete configuration)
    ascDesc No Unsigned integer Order the results are in. By default, the results are sorted by creation time. 0: by time in an ascending order; 1: by time in a descending order.
    pageNo No Unsigned integer Page number. For example, to view the list in page 3, set the value to 3.
    pageSize No Unsigned integer The number of channels displayed on each page.
    orderBy No String By default, the results are sorted by the channel creation time.

    3. Output Parameters

    Parameter Name Type Description
    code Int Error code. 0: Successful; other values: Failed
    message String Error message
    all_count int Total number of channels
    channelSet Array Channel list

    4. Example

    Input 1

    https://domain/v2/index.php?Action=DescribeLVBChannelList&channelStatus=0&ascDesc=1&pageNo=1&pageSize=10&Common request parameters
    
    

    Output 1

    {
        "code": 0,
        "message": "",
        "all_count": "2",
        "channelSet": [
            {
                "channel_id": "96171715553394811",
                "channel_name": "World Table Tennis Championships 3",
                "channel_status": "0",
                "create_time": "2015-07-23 20:05:52"
            },
            {
                "channel_id": "96171715553394810",
                "channel_name": "World Table Tennis Championships 2",
                "channel_status": "0",
                "create_time": "2015-07-23 19:54:05"
            }
        ]
    }
    

    5. Standard Parameter Definitions

    Channel status definitions:

    Value Status
    0 No input stream
    1 LVB in progress
    2 Exception
    3 Disable

    Receiver type definitions:

    Type Description
    1 RTMP output
    2 HLS output
    3 RTMP and HLS output
    LVB stream protocol definitions:
    Type Description
    1 RTMP push
    2 RTMP pull
    3 HLS pull

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help