You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /实时音视频/服务端 OpenAPI 参考/输入在线媒体流/查询输入媒体流任务 ListRelayStream
查询输入媒体流任务 ListRelayStream
最近更新时间：2024.07.16 15:31:21首次发布时间：2024.01.03 20:25:16
我的收藏

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

在实时音视频通话场景中，如需获取特定房间内所有在线媒体流的任务列表，你可通过调用此接口实现。

通过指定应用标识和房间标识，你可查询相关任务，单次查询可返回多达 10000 条任务信息。返回的信息包括任务当前状态、创建时间、媒体流地址等。

注意事项

请求频率：QPS 不得超过 150。

请求说明

  • 请求方式：GET
  • 请求地址：https://rtc.volcengineapi.com?Action=ListRelayStream&Version=2023-11-01

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数
类型
是否必选
示例值
描述
Action
String
是
ListRelayStream
接口名称。当前 API 的名称为 ListRelayStream。
Version
String
是
2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
AppId
String
是
661e****543cf
应用的唯一标志。
RoomId
String
是
Room1
要查询房间的 ID
Offset
Integer
否
0
起始位置，取值范围为[0,9999]，默认值为 0。
Limit
Integer
否
10
页大小，取值范围为[1,100]，默认值为 10。
Order
Integer
否
0

接口调用时间顺序。

  • 0：倒序。
  • 1：正序。
默认值为0。

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

参数
类型
示例值
描述
Task
Object[]
-
任务列表
AppId
String
661e****543cf
你的音视频应用的唯一标志。
RoomId
String
Room1
房间 ID，是房间的唯一标志
UserId
String
User1
在线媒体流对应的 UserId
TaskId
String
Task1
任务 ID
Status
Integer
1
任务当前状态。
  • 1：任务启动中。
  • 2：任务运行中。
  • 3：任务已结束。
    • CreateTime
    Integer
    1656332552
    任务开始时间，Unix 时间戳，单位为秒
    StreamUrl
    String
    rtmp://xxx
    在线媒体流地址
    StreamMode
    Integer
    0
    流处理模式。
  • 0：转码
  • 1：转封装
    • MediaType
    Integer
    0
    媒体类型。
  • 0：音视频
  • 1：音频
  • 2：视频
    • VideoWidth
    Integer
    640
    视频宽度，取值范围为 [16, 1920]，单位为像素。
    VideoHeight
    Integer
    480
    视频高度，取值范围为 [16, 1920]，单位为像素。
    FrameRate
    Integer
    15
    发送帧率，取值范围为[1，60]，默认值为 15，转码时生效。
    Total
    Integer
    1
    当前页大小
    Offset
    Integer
    0
    下一页索引
    Limit
    Integer
    10
    页大小

    请求示例

    GET https://rtc.volcengineapi.com?Action=ListRelayStream&Version=2023-11-01&AppId=661e****543cf&RoomId=Room1&Offset=0&Limit=10&Order=0

    返回示例

    {
    "Result": {
        "Task": [
            {
                "AppId": "661e****543cf",
                "RoomId": "Room1",
                "TaskId": "Task1",
                "StreamUrl": "rtmp://xxx",
                "MediaType": 0,
                "StreamMode": 0,
                "VideoWidth": 1920,
                "VideoHeight": 1080,
                "FrameRate": 30,
                "Bitrate": 6000,
                "Loop": true,
                "UserId": "user1",
                "Status": 2,
                "CreateTime": 1656332552
            }
        ],
        "Offset": 0,
        "Limit": 10,
        "Total": 1
    },
    "ResponseMetadata": {
        "RequestId": "20230****10420",
        "Action": "ListRelayStream",
        "Version": "2023-11-01"
    }
}

    错误码

    您可访问公共错误码，获取更多错误码信息。