创建云端播放任务

更新时间: 2025/04/01 15:52:24

调用此接口提交云端播放任务后,虚拟播放器通过虚拟身份加入音视频房间。您可以通过 RESTful API 控制虚拟播放器,以实现对该媒体流的控制。

一个房间内最多可以创建 10 个云端播放任务。

接口地址

  • 请求方法:POST
  • URL:https://rtc.yunxinapi.com/v2/api/task/create

请求频率

默认上限为 50 次/秒,若请求频率超出限制,可能会返回 429 错误码。
若您需要上调上限,请参考 如何处理调用服务端 RESTful API 超出频率限制

请求参数

  • 请求中 Header 的设置请参考 请求结构 描述。

  • 请求中 Body 须为 JSON 格式,参数说明如下:

参数名称 类型 是否必选 示例 说明
cname String meeting_name111 房间名称。
requestId String f8f274c1-0e9f-4583-a243-c61c06a19475 随机字符串。用于问题排查。
taskType Int 2 服务器任务类型。固定为 2。
data JSON 数组 - 云端播放任务信息。具体请参考 data 结构

返回参数

参数名称 类型 示例 说明
cid Number 1144707127429101 房间 ID。
taskId String 2a784467d647bb87b60b719f6fa56333 任务唯一标识符,房间内唯一。

示例

请求示例

JSON{
    "cname":"cname",
    "requestId": "随机字符串用作问题排查",
    "taskType": 2, // 常量 2
    "data":{
        "streamUrl": "rtmp://example.yunxin.io/live/class32/101",
        "token": "2a784467d6",
        "uid": 101,
        "idleTimeout": 300,
        "playTs": 1575508644,
        "mediaType":0, // 0 音频,1 视频,2 音视频
        "volume":100, //设置音量大小,取值范围为[0,200],默认值为 100,表示播放原始声音,大于 100 表示增大音量,小于 100 表示减小音量
        "repeatTime":1 //重复播放次数,默认值为 1,如果填-1 表示无限循环,直到任务停止为止
    }
}

返回示例

JSON{
    "code": 200,
    "requestId": "712b07430ebd49ce9beb205bbb2828f1",
    "cid": 1345452022450142,
    "result": {
        "taskId": "8a2c4e64-6865-4944-acb2-b616374a7e14"
    }
}

状态码

返回内容中,code 为 200 表示调用正常。

若 code 为其他值,请根据 code 与 errmsg 在 在线媒体流状态码 中查看问题原因。

此文档是否对你有帮助?
有帮助
去反馈
  • 接口地址
  • 请求频率
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例
  • 返回示例
  • 状态码