Query Live Channel Details

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

    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 (DescribeLVBChannel) is used to enter the ID number of a channel to be queried to get its current status, name, description, LVB source, and output source information.

    2. Input Parameters

    Parameter Name Required Type Description
    channelId Yes Unsigned integer Channel ID

    3. Output Parameters

    Parameter Name Type Description
    code Int Error code. 0: Successful; other values: Failed
    message String Error message
    channelInfo Array Channel information, such as its current status, name, description, LVB source, and output source information.

    4. Example

    Input 1

    https://domain/v2/index.php?Action=DescribeLVBChannel&channelId=96171715553394807&Common request parameters
    

    Output 1

    {
        "code": 0,
        "message": "",
        "channelInfo": [
            {
                "channel_id": "XXX",
                "channel_name": "XXX",
                "channel_describe": "XXX",
                "channel_status": "1",
                "upstream_list": [
                    {
                        "sourceName": "RTMP",
                        "sourceID": "YYYYYYYYYYY",
                        "sourceType": "1",
                        "sourceAddress": "rtmp://2000.livepush.myqcloud.com/live/YYYYYYYYYYYYYYYYYY?bizid2000"
                    }
                ],
                "hls_downstream_address": "",
                "rtmp_downstream_address": "rtmp://2000.liveplay.myqcloud.com/live/XXX",
                "player_id": "226",
                "resolution": null,
                "password": null
            }
        ]
    }

    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