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

接口行为

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

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

调用接口

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

请求方式

使用 Get 方式发起请求。

请求参数

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

Query

字段名	字段类型	必填	示例值	描述
Action	String	是	`ListRelayStream`	接口名称，本接口取值：`ListRelayStream`
Version	String	是	`2020-12-01`	接口版本，本接口取值：`2020-12-01`
AppId	string	是	`Your_AppId`	应用的唯一标志。
RoomId	string	是	`Your_RoomId`	要查询房间的 ID
Offset	int	否	`0`	起始位置，默认值为 `0`。
Limit	int	否	`10`	页大小，取值范围为[1-100]，默认值为 `10`
Order	int	否	`0`	接口调用时间顺序。 `0`：倒序。 `1`：正序。默认值为`0`

请求示例代码

https://rtc.volcengineapi.com?Action=ListRelayStream&Version=2020-12-01&AppId=Your_AppId&RoomId=Your_RoomId&Offset=0&Limit=10&Order=0
postscript

返回调用结果

返回参数说明

返回结果参看 BaseResponse。

其中 Result 的结构如下：

参数名	类型	示例值	描述
Task	array of Task		任务列表
Total	int	`1`	当前页大小
Offset	int	`0`	下一页索引
Limit	int	`10`	页大小

Task

字段名	字段类型	示例值	描述
AppId	string	`Your_AppId`	应用的唯一标志
RoomId	string	`Your_RoomId`	房间 ID，是房间的唯一标志
UserId	string	`Your_UserId`	在线媒体流对应的 UserId
TaskId	string	`Your_TaskId`	任务 ID
Status	int	`1`	任务当前状态。 `1`：任务启动中。 `2`：任务运行中。 `3`：任务已结束
CreateTime	int	`1656332552`	任务开始时间，Unix 时间戳，单位为秒
StreamUrl	string	`rtmp://xxx`	在线媒体流地址
StreamMode	int	`0`	流处理模式。 0：转码 1：转封装
MediaType	int	`0`	媒体类型。 0：音视频 1：音频 2：视频
VideoWidth	int	`640`	视频宽度。单位为 px，范围为 [16, 1920]。
VideoHeight	int	`480`	视频高度，单位为 px，范围为 [16, 1920]。
FrameRate	int	`15`	发送帧率，值的范围为[1，60]，默认值为`15`，转码时生效。

正常返回示例

{
    "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