查看会议播放器列表
查看会议播放器列表
1. 接口描述
接口名称:
/confopenapi/player/list
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
Http Header
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
token | 是 | string | 接口调用凭证 |
HttpBody
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
title | string | 会议名称 |
传参示例
{
"title" : "212222"
}
4. 返回参数
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
msg | string | 消息 |
result | Object | 数据内容 |
request_id | string | 请求ID |
result 参数说明
参数名 | 类型 | 说明 |
---|---|---|
list | Array | 播放器数组 |
list 单个对象说明
参数名 | 类型 | 说明 |
---|---|---|
playerId | string | 播放器ID |
title | string | 会议名称 |
attendeeName | string | 参会者名称 |
playerName | string | 云端播放器的名称 |
streamUrl | string | 云端播放器所使用的在线媒体流地址 |
playTs | int | 云端播放器开始播放媒体流时的 Unix 时间戳(秒),假设云端播放器创建时的 Unix 时间戳是 T,playTs 取值为 S 当S = T或0时,云端播放器在创建成功时自动播放在线媒体流 当 S > T 时,云端播放器会在 S 时刻开始播放在线媒体流, 这种取值方式适用于定时播放 |
idleTimeout | int | 云端播放器处于空闲状态的最大时长(秒), 即媒体流为非播放状态的最大时长。空闲状态超过设置的idleTimeout后, 该播放器会自动销毁。取值范围为 5 到 600。默认值为 300 |
repeatTime | string | 播放媒体流次数。1:(默认)播放媒体流一次, -1:循环播放媒体流, n:自定义播放媒体流次数,不可设置为 0 |
seekPosition | int | 指定点播文件的播放位置(秒), 默认值为 0,表示从点播文件起始位置播放,必须小于音视频时长 |
dataStreamOptions | string | 数据流配置,用于设置视频帧携带的 SEI 信息 |
返回示例
{
"status": 0,
"msg": "delete success",
"result": {
"list": [
{
"playerId": "212222",
"title": "测试会议",
"attendeeName": "Mike",
"playerName": "播放器001",
"streamUrl": "https://www.mp4us.com/1022.mp4",
"playTs": 0,
"idleTimeout": 300,
"repeatTime": 1,
"seekPosition": 20,
"dataStreamOptions": {
"enable": false
}
}
]
},
"request_id": "confopenapiserver-172.10.5.218-1715148682.395825076.563"
}
备注
- 更多返回错误代码请看首页的错误代码描述