如果你已经输入了在线媒体流,你可以查询指定 AppId 下指定房间内所有输入的媒体流任务。你可以使用 ListRelayStream 这个 OpenAPI 实现这一功能。

接口行为

你可以调用 ListRelayStream 接口,指定 AppId 和 RoomId查询该房间内输入的所有的媒体流任务。

单次查询最多可以查到 10000 条输入媒体流任务。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用OpenAPI。

请求方式

使用 Get 方式发起请求。

请求参数

以下是接口特有的请求参数。关于其他公共请求参数,参看请求参数。

Query
字段名字段类型必填示例值描述
ActionString是ListRelayStream接口名称,本接口取值:ListRelayStream
VersionString是2020-12-01接口版本,本接口取值:2020-12-01
AppIdstring是Your_AppId应用的唯一标志。
RoomIdstring是Your_RoomId要查询房间的 ID
Offsetint否0起始位置,默认值为 0。
Limitint否10页大小,取值范围为[1-100],默认值为 10
Orderint否0接口调用时间顺序。
  • 0:倒序。
  • 1:正序。
  • 默认值为0
    返回参数
    Body
    参数名类型示例值描述
    Taskarray of Task任务列表
    Totalint1当前页大小
    Offsetint0下一页索引
    Limitint10 页大小

    Task

    字段名字段类型示例值描述
    AppIdstringYour_AppId应用的唯一标志
    RoomIdstringYour_RoomId房间 ID,是房间的唯一标志
    UserIdstringYour_UserId在线媒体流对应的 UserId
    TaskIdstringYour_TaskId任务 ID
    Statusint1任务当前状态。
  • 1:任务启动中。
  • 2:任务运行中。
  • 3:任务已结束
  • createTimeint1656332552任务开始时间,Unix 时间戳,单位为秒
    StreamUrlstringrtmp://xxx在线媒体流地址
    StreamModeint0流处理模式。
  • 0:转码
  • 1:转封装
  • MediaTypeint0媒体类型。
  • 0:音视频
  • 1:音频
  • 2:视频
  • VideoWidthint640视频宽度。单位为 px,范围为 [16, 1920]。
    VideoHeightint480视频高度,单位为 px,范围为 [16, 1920]。
    FrameRateint15发送帧率,值的范围为[1,60],默认值为15,转码时生效。
    请求示例代码

    请求路径:

    https://rtc.volcengineapi.com?Action=ListRelayStream&Version=2020-12-01&AppId=Your_AppId&RoomId=Your_RoomId&Offset=0&Limit=10&Order=0
    
    postscript
    返回调用结果
    正常返回示例
    {
        "Result": {
            "Task": [
                {
                    "AppId": "Your_AppId",
                    "RoomId": "Your_RoomId",
                    "TaskId": "Your_TaskId",
                    "StreamUrl": "rtmp://xxx",
                    "MediaType": 0,
                    "StreamMode": 0,
                    "VideoWidth": 1920,
                    "VideoHeight": 1080,
                    "FrameRate": 30,
                    "Bitrate": 6000,
                    "Loop": true,
                    "UserId": "Your_UserId",
                    "Status": 2,
                    "CreateTime": 1656332552
                }
            ],
            "Offset": 0,
            "Limit": 10,
            "Total": 1
        },
        "ResponseMetadata": {
            "RequestId": "Your_RequestId",
            "Action": "ListRelayStream",
            "Version": "2020-12-01"
        }
    }
    
    json