文档反馈
文档反馈

创建推流任务

重要通知

网易云信新版文档中心现已正式上线!

音视频通话2.0互动直播2.0多人语音聊天室PK 直播等产品和场景方案已迁移至新版文档中心维护,欢迎体验!

当需要使用互动直播功能时,必须要设置推流任务。创建推流任务可以调用服务端接口进行设置,也可以调用客户端接口进行设置。

限制说明

URL

URL 中参数说明:

参数名称 类型 是否必选 示例 描述
cid int64 6207760637435905 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。

请求参数

参数名称 类型 是否必选 示例 描述
taskId String 必选 stream_1 自定义的推流任务ID。请保证此ID唯一。字母数字下划线组成的 64 位以内的字符串
streamUrl String 必选 rtmp://test.url 推流地址,例如rtmp://test.url。
此处的推流地址可设置为网易云信直播产品中服务端API创建频道的返回参数pushUrl。
layout Json 必选 - 互动直播中的布局相关参数。
详细参数说明请参考layout。布局参数的配置方式及典型配置示例请参考旁路推流画面布局
record Boolean 可选 true 旁路推流是否需要进行音视频录制。
version Integer 必选 1 推流任务版本,此处请设置为1。
hostuid Integer 可选 111 主播的 UID。
config Json 可选 - 音视频流配置。
详细参数说明请参考config
extraInfo String 可选 abc 自定义的媒体补充增强信息。

返回参数

参数名称 类型 示例 描述
code int 200 状态码。
errmsg String invalid params 错误详情。仅在状态码为 200 以外的其他状态中返回。errmsg 仅供参考,请勿基于 errmsg 实现业务逻辑。

示例

请求示例

{
    "version": 1"taskId" : "stream_1",  
    "streamUrl": "rtmp://test.url", 
    "record":true, 
    "hostUid": 123,
    "layout":{
        "canvas": {
             "width": 720,
             "height": 640,
             "color": 16777215
                },
        "users": [{
            "uid": 66601,
            "x": 0,
            "y": 0,
            "width": 360,
            "height": 640,
            "adaption": 1,
            "pushAudio": true,
            "pushVideo": true
        },
         {
            "uid": 66602,
            "x": 360,
            "y": 0,
            "width": 360,
            "height": 640,
            "adaption": 1,
            "pushAudio": true,
            "pushVideo": true
        }
    ],
         "images": [{
            "url": "www.163.com/test.jpg",
            "x": 360,
            "y": 0,
            "width": 360,
            "height": 640,
            "adaption": 1
        }]
},
    "config": { 
        "singleVideoNoTrans": true, 
        "audioParam": {                 
            "bitRate": 64, 
        }
    }                                  
}

正常返回示例

{
    "code": 200     
}      

错误码

该接口在 HTTP Body 中返回错误码,错误码列表请参考业务错误码

×

反馈成功

非常感谢您的反馈,我们会继续努力做得更好。