跳到主要内容
版本：4.0

实时音视频控制

liveCtrl​

function liveCtrl(params: LiveStrmCtrlReq): Promise<ApiReply<any>> {
}

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

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

参数​

参数名数据类型必要说明
paramsLiveStrmCtrlReqY实时音视频控制参数

LiveStrmCtrlReq 实时音视频控制参数​

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

返回值​

Promise<ApiReply<any>>