跳到主要内容
版本:3.4.4

实时音视频控制

POST /strm/live/ctrl

本接口对请求ID(reqId)对应的实时音视频流进行控制。

  • 如果控制命令(ctrl)为关闭音视频传输(0),则接口调用返回后,对应的reqId将不可再使用。
  • 关闭音视频传输时,如果当前有其它用户正在使用通道,将返回错误码 -25,调用者可以忽略此错误码。

请求

POST https://n11.gratour.info:7011/v1/strm/live/ctrl
Content-Type: application/json
X-Auth-Token: HrWwReOAQ9WdLnJQ1JYivA

{
"reqId": "AbctuB9sSJe8bbBzv-yr9g",
"ctrl": 0,
"closeAction": 0
}

请求实体属性

属性数据类型必要说明
reqIdstringY实时音视频请求ID
ctrlintY控制命令:
  • 0: 关闭音视频传输。成功执行该命令后,服务端向相关客户端推送actclosed的流媒体状态通知
  • 1: 切换码流。成功执行该命令后,服务端向相关客户端推送actchangeCodeStrm的流媒体状态通知
  • 2: 暂停流。成功执行该命令后,服务端向相关客户端推送actpaused的流媒体状态通知
  • 3: 恢复流。成功执行该命令后,服务端向相关客户端推送actresumed的流媒体状态通知
  • 4: 关闭双向对讲。成功执行该命令后,服务端向相关客户端推送actclosed的流媒体状态通知
closeActionint关闭动作:
  • 0: 关闭音视频
  • 1: 仅关闭音频(暂不支持)
  • 2: 仅关闭视频(暂不支持)
仅当ctrl==0时有效
codeStreamint新的码流类型:
  • 0: 主码流
  • 1: 子码流
仅当ctrl==1时有效

应答

{
"errCode": 0,
"message": "OK."
}

应答实体属性

属性数据类型必要说明
errCodeintY错误码:
  • 如果当前有其它共享用户正使用流,返回错误码:-25,调用者可以忽略此错误码
  • 如果reqId无效,返回错误码:-8
  • 如果错误使用远程录像回放的reqId调用本接口,将返回错误码:-6
messagestringY错误信息