创建云播放器
更新时间:2024-02-28
接口描述
- 云播放器功能现阶段是内测功能,如需开通请联系技术人员。
通过创建云播放器,可以实现向百度智能云 RTC 房间输入在线媒体流的能力。云播放器会将媒体流推送到指定的房间内,房间内其它用户可以观看该媒体流。
创建成功后,百度智能云 RTC 服务会返回云播放器 ID,作为 App 范围内云播放器的唯一标识。
请求(Request)
请求URI
POST /v1/cloudplayer HTTP/1.1
请求头域
除公共头域外,无其它特殊头域。
请求体
参数名 | 类型 | 是否必需 | 描述 |
---|---|---|---|
playerName | String | 是 | 云播放器名称 |
appId | String | 是 | 应用 ID |
roomName | String | 是 | 房间名 |
userId | Long | 是 | 云播放器流在房间中 uid |
streamUrl | String | 是 | 流地址,现阶段只支持 http/https/rtmp/rtmps |
display | String | 否 | 云播放器流在房间中昵称 |
streamType | String | 否 | 流的类型,0表示点播,1表示直播。 |
streamMode | String | 否 | 输出流的模式,0表示音频+视频,1表示纯音频,2表示纯视频,默认值为0。 |
playTs | Long | 否 | 云端播放器开始播放输入的在线媒体流时间,单位秒,默认值为 0。 playTs=0,表示创建后立即播放。 playTs>0,则表示秒级别播放时间,且最大值为:当前秒级时间+600。 |
repeatTimes | Integer | 否 | 循环播放次数,仅对点播类型有效。取值范围[1,100],默认值为 1。 |
maxIdleTime | Integer | 否 | 最大无流状态的超时时间,单位秒。取值范围[5,60],默认值为 30。 |
audioOptions | AudioOptions | 否 | 音频输出配置(音频输出编码统一为 opus,暂不支持配置) |
+bitrate | Integer | 否 | 音频码率,默认值为 50 kb/s。 |
+channel | Integer | 否 | 音频声道,支持取值 1 和 2。 |
videoOptions | VideoOptions | 否 | 视频输出配置(视频输出编码统一为 h264,暂不支持配置) |
+width | Integer | 否 | 视频宽,默认值为 1280。 |
+height | Integer | 否 | 视频高,默认值为 720。 |
+bitrate | Integer | 否 | 视频码率,默认值为 500kb/s |
dataStreamOptions | DataStreamOptions | 否 | 数据流配置 |
+enable | Boolean | 否 | 是否传入 DataStream 类型的 SEI 信息,默认值为 false。 |
+interval | Integer | 否 | 传输 StreamData 数据的 SEI 信息发送频率(毫秒),默认值为 1000,表示每隔 1 秒发送 1 个携带 StreamData 数据的 SEI 信息。 |
响应(Response)
响应头域
除公共头域外,无其它特殊头域。
响应体
字段名 | 类型 | 描述 |
---|---|---|
playerId | String | 云播放 ID,用于在 App 下标识唯一的云播放器实例 |
示例
请求示例
POST /v1/cloudplayer HTTP/1.1
host: rtc.baidubce.com
content-type: application/json
authorization: {bce-authorization-string}
x-bce-request-id: {bce-request-id}
{
"playerName":"player1",
"appId":"testAppId",
"roomName":"123456",
"userId":123123,
"streamUrl":"http://****/**",
"display":"Jack",
"streamType":"1",
"streamMode":"0",
"playTs":0,
"repeatTimes":1,
"maxIdleTime":30,
"audioOptions":{
"bitrate":50,
"channel":1
},
"videoOptions":{
"width":1280,
"height":720,
"bitrate":500
},
"dataStreamOptions":{
"enable":false,
"interval":1000
}
}
响应示例
HTTP/1.1 200 OK
x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
date: Mon, 05 Sep 2022 03:25:43 GMT
transfer-encoding: chunked
content-type: application/json;charset=UTF-8
cache-control: no-cache
{
"playerId": "testPlayerId"
}