主调接口

Connect

• 说明
  建立连接。建立连接时会回调 OnGetSign(bizName,subBiz,uid) 来获取签名。
• 参数

• 回调接口异步返回
  • OnConnectOK()
  • OnConnectFailed(err_code, err_msg)

Disconnect

• 说明
  断开连接。调用 Disconnect() 接口，会触发离开房间，离开房间之前会关闭发布和订阅的流。即：断开连接 > 离开房间 > 关闭房间所有流。
• 参数
  无。
• 回调接口异步返回
  • OnConnectClose()

InitRoomConfig

• 说明
  初始化。

  请求参数	类型	描述
  config_param	{}	auto_publish_subscribe：int 类型，必填，发布订阅模式   1：自动订阅。   2：自动发布。   3：自动订阅 + 自动发布。   4：全都不自动,由业务自己操作。 need_volume_analyser：boolean 类型，默认为 false，是否需要实时音量值。 defaultRecord：boolean 类型，非必填，服务端是否默认录制，默认为 false。 recordStrongDepend：boolean 类型，是否强依赖录制，默认为 true。若为 true，则录制如果没启动成功，音视频通话也不能成功。 recordParam：json 类型，录制参数，非必填。 width=640 height=360 fps=15 帧率 sampleRate=48000 音频采样率 channels=1 单声道 audioCodeRate=32000 音频码率 startTimeout=10 录制开启超时时间，默认为 10s recordTotalStream=0 最小成功开启录制流的条数，默认为 0 splitType：int   0：音视频（默认）   1：纯音频 + 音视频   2：纯视频 + 音视频 filePath：String 类型，非必填，服务端录制路径（若指定 filePath，则需指定 defaultRecord 为 true） 若 auto_publish_subscribe=1，需要以下参数： initSubscribe：Array 类型，订阅参数。 subscribe_video_id：必填，订阅视频控制标签 ID，用于展示视频流。 例如：<video id=&quot;video1&quot; width=&quot;auto&quot; height=&quot;auto&quot;> video</video> subscribe_audio_id：必填，⽤于展示订阅⾳频流。 例如：<audio id=&quot;audio1&quot; autoplay>音频</audio> feedId_id：必填，label 标签，用于展示 feedId。 例如：<label id=&quot;feedId&quot; &nbsp;type=&quot;text&quot;></label> subscribe_streamId_id：必填，label 标签，用于展示 streamId。 例如：<label id=&quot;streamId&quot; &nbsp;type=&quot;text&quot;></label> 例如： initSubscribe = [            {                subscribe_video_id: "video1",                subscribe_audio_id: "audio1",                subscribe_streamId_id: "streamId",                feedId_id: "feedId"            },{},{}]; 若 auto_publish_subscribe=2，需要以下参数： media_type：int 类型，必填，音视频类型。   1：音视频;   2：纯音频;   3：纯视频。 publish_device：int 类型，必填，发布类型。   1：摄像头;   2：共享桌面   3：发布文件（图片和视频）   4：发布自定义页面区域 当 publish_device=1 时： videoSource：String 类型，可选，摄像头的 ID，用于发布指定摄像头。 audioSource：String 类型，可选，麦克风的 ID，用于发布指定麦克风。 aspectRatioStrongDepend：boolean 类型，可选，默认为 false，是否强制指定横纵比。 aspectRatio：String 类型，可选（当 aspectRatioStrongDepend=true 时必填）   1：4:3   2：16:9 video_profile_type：int 类型，可选，本地视频清晰度档位。   1：720p(HD), 1280x720, 16:9   2：VGA, 640x480, 4:3   3：360p(nHD), 640x360, 16:9 initPublish：Array 类型，必填，发布参数。 publish_video_id：根据 media_type 选填，发布视频控制标签，用于展示视频流。 publish_streamId_id：必填，label 标签，用于展示 streamId。 publish_tag:必填，业务自定义。 initPublish = [           {publish_video_id: "publish_video1", publish_streamId_id: "publish_streamId1", publish_tag: "tag1"},            {publish_video_id: "publish_video2", publish_streamId_id: "publish_streamId2", publish_tag: "tag2"},            {publish_video_id: "publish_video3", publish_streamId_id: "publish_streamId3", publish_tag: "tag3"}        ]; 若 auto_publish_subscribe=3，需要以下参数： media_type：int 类型，必填，音视频类型。   1：音视频;   2：纯音频;   3：纯视频。 publish_device：int 类型，必填，发布类型。   1：摄像头   2：共享桌面   3：发布文件（图片和视频）   4：发布自定义页面区域 video_profile_type：int 类型，可选，本地视频清晰度档位。   1：720p(HD), 1280x720, 16:9   2：VGA, 640x480, 4:3   3：360p(nHD), 640x360, 16:9 initPublish：Array 类型，必填，发布参数。 publish_video_id：根据 media_type 选填，发布视频控制标签，用于展示视频流。 publish_streamId_id：必填，label 标签，用于展示 streamId。 publish_tag：必填，业务自定义。 例如： initPublish = [            {publish_video_id: "publish_video1", publish_streamId_id: "publish_streamId1", publish_tag: "tag1"},            {publish_video_id: "publish_video2", publish_streamId_id: "publish_streamId2", publish_tag: "tag2"},            {publish_video_id: "publish_video3", publish_streamId_id: "publish_streamId3", publish_tag: "tag3"}        ]; initSubscribe：Array 类型，订阅参数。 subscribe_video_id：必填，订阅视频控制标签，用于展示视频流。 subscribe_audio_id：必填，用于展示订阅音频流 feedId_id：必填，label 标签，用于展示 feedId。 subscribe_streamId_id：必填，label 标签，用于展示 streamId。 例如： initSubscribe = [            {                subscribe_video_id: "video1",                subscribe_audio_id: "audio1",                subscribe_streamId_id: "subscribe_streamId1",                feedId_id: "feedId1"            },{},{}]; 若 auto_publish_subscribe=4，则只需传 auto_publish_subscribe。
  bizName	String	业务名
  subBiz	String	子业务
  uid	String	用户 ID

• 回调接口异步返回

  • OnInitRoomConfigOK()
  • OnInitRoomConfigFail(err_code, err_msg)

CreateRoom

• 说明
  创建房间。
• 参数
  无。
• 回调接口异步返回
  • OnCreateRoomSucc(room_id, rtoken)
  • OnCreateRoomFailed()

JoinRoom

• 说明
  加入房间。
• 参数

• 回调接口异步返回
  • OnJoinRoomSucc()
  • OnJoinRoomFailed(err_code, err_msg)

Invite

• 说明
  邀请加⼊房间。
• 参数

• 回调接口异步返回
  • OnInviteOK()
  • OnInviteFail(err_code, err_msg)

ReplyInvite

• 说明
  回复邀请加⼊房间。
• 参数

• 回调接口异步返回
  • OnReplyInviteOK()
  • OnReplyInviteFail(err_code, err_msg)

LeaveRoom

• 说明
  退出房间。
• 参数
  无。
• 回调接口异步返回
  • OnLeaveRoom()

Publish

• 说明
  发布媒体流。
• 参数

• 调接⼝异步返回：
  • OnPublishSucc(sid)
  • OnPublishFailed(sid,err_code, err_msg)

Subscribe

• 说明
  订阅某路媒体流。
• 参数

• 回调接口异步返回
  • OnSubscribeSucc(feedId,sid)
  • OnSubscribeFailed(sid,err_code, err_msg)

SetLocalAudioEnable

• 说明
  开启/关闭本地⻨克风。
• 参数

SetLocalVideoEnable

• 说明
  开启/关闭本地摄像头。
• 参数

SetLocalCodecType

• 说明
  设置视频编码格式。
• 参数

3.1.14 SetLocalProtoType

• 说明
  设置⾳视频传输协议。
• 参数

TakePicture

• 说明
  截图。
• 参数

StartRecord

• 说明
  开启浏览器录制。
  • 浏览器录制：指在客户端上做录制（近端录制），浏览器录制不支持录制点播机器人。
  • 服务端录制：指在媒体服务器上录制（远端录制）。
• 参数

• 回调接口异步返回
  • OnClientStartRecordSuccess(clientRecordId)
  • OnClientStartRecordFailed(clientRecordId, code, msg)

StopRecord

• 说明
  停⽌浏览器录制，与 StartRecord 接⼝配合使⽤。
• 参数

• 回调接口异步返回
  • OnClientStopRecordSuccess(videoURL, clientRecordBlob, clientRecordId)
  • OnClientStopRecordFailed(clientRecordId, code, msg)

PauseRecord

• 说明
  暂停浏览器录制，与 ResumeRecord 接⼝配合使⽤。
• 参数

• 回调接口异步返回
  • OnClientPauseRecordSuccess(clientRecordId)
  • OnClientPauseRecordFailed(clientRecordId, code, msg)

ResumeRecord

• 说明
  继续浏览器录制，与 PauseRecord 接⼝配合使⽤。
• 参数

• 回调接口异步返回
  • OnClientResumeRecordSuccess(clientRecordId)
  • OnClientResumeRecordFailed(clientRecordId, code, msg)

DownloadRecord

• 说明
  下载浏览器录制音视频，与 PauseRecord 接⼝配合使⽤。
• 参数

• 回调接口异步返回
  • OnClientDownloadRecordSuccess(clientRecordId)
  • OnClientDownloadRecordFailed(clientRecordId, code, msg)

StartRemoteRecord

• 说明
  开始服务端录制，与 StopRemoteRecord 接⼝配合使⽤。
• 参数

• 回调接口异步返回
  • OnStartRecordSucc(recordId)
  • OnStartRecordFailed(recordId,err_code, err_msg)

StopRemoteRecord

• 说明
  结束服务端录制，与 StartRemoteRecord 接⼝配合使⽤。
• 参数

• 回调接口异步返回
  • OnStopRecordSucc(recordId)
  • OnStopRecordFailed(recordId,err_code, err_msg)

GetRecordInfo

• 说明
  获取服务端录制结果。
• 参数

• 回调接口异步返回
  • OnRecordInfoSucc(recordInfo)
  • OnRecordInfoFailed(recordId,err_code, err_msg)

UnPublish

• 说明
  取消发布媒体流。
• 参数

• 回调接口异步返回
  • OnUnPublishSucc(sid)

UnSubscribe

• 说明
  取消订阅某路媒体流。
• 参数

• 回调接口异步返回
  • OnUnSubscribeSucc(sid)

SendTextMsg

• 说明
  发送文本消息。
• 参数

SetPublishWeakBitrateLimit

• 说明
  设置发布弱网码率告警下限，在 初始化（InitRoomConfig） 时调用此接口。
• 参数

SetSubscribeWeakBitrateLimit

• 说明
  设置订阅弱网码率告警下限，在 初始化（InitRoomConfig） 时调用此接口。
• 参数

StartAsr(config)

• 说明
  开始语音识别。
• 参数

StopAsr(sid)

• 说明
  停止语音识别。
• 参数

StartVod(vodParams)

• 说明
  开始语音点播。
• 参数

• 回调接口异步返回
  • OnStartVodSuccess(file, vod_id)
  • OnStartVodFail(file, vod_id, err_code, err_msg)

StopVod(vod_id)

• 说明
  停止语音点播。
• 参数

• 回调接口异步返回
  • OnStopVodSuccess(vod_id)
  • OnStopVodFail(vod_id, err_code, err_msg)

DownloadLog()

• 说明
  日志上报，调用此接口可下载控制台日志到 PC 本机（默认最长 10000 行日志）。
• 参数
  无。

StartTts(config)

• 说明
  开始语音合成。
• 参数
  无。

• 回调接口异步返回
  • OnStartTtsSuccess(sessionId)
  • OnStartTtsFailed(err_code, err_msg)

StopTts()

• 说明
  停止语音合成。
• 参数
  无。

ChangeMediaStream()

• 说明
  自定义切流。
• 参数

• 回调接口异步返回
  • OnChangeMediaStreamSuccess(sid)
  • OnChangeMediaStreamFailed(sid,code, msg)

ChangeProfile()

• 说明
  动态切换（分辨率、摄像头麦克风、横纵比）
• 参数

• 回调接口异步返回
  • OnChangeMediaStreamSuccess(sid)
  • OnChangeMediaStreamFailed(sid,code, msg)

GetDevices()

• 说明
  获取设备信息。
• 参数
  无。
• 回调接口异步返回
  • OnGetDevicesSuccess(devicesInfo)
  • OnGetDevicesFailed(code, msg)