首页 移动开发平台 mPaaS 音视频通话 API 参考 Web API 回调接口

回调接口

更新时间: 2022-04-28 11:08:45

本文介绍音视频通话 API 在接入 Web 端时涉及的回调接口。

OnMediaCallSucc(sid)

初始化音视频成功。

OnMediaCallFail(err_code, err_msg)

初始化音视频失败。

参数说明：

回调参数

类型

说明

err_code

int

初始化音视频失败返回：

  • 5101：视频启动失败

  • 5102：音频启动失败

  • 5103：浏览器不支持

  • 5104：房间状态不正确

  • 5105：共享桌面启动失败

  • 5106：发布获取文件流失败

  • 5107：发布文件不存在

  • 5108：发布区域不存在

  • 5109：背景虚化图片未提供

  • 5110：自定义流未提供

  • 5111：自定义分辨率、帧率、码率参数未提供

err_msg

String

状态信息

OnInviteRequest(roomId, rtoken, inviter, extra)

被邀请者收到“加入房间”的邀请消息。

参数说明：

回调参数

类型

说明

roomId

String

房间 ID

rtoken

String

房间 token

inviter

String

邀请方的 UID

extra

String

业务透传字段

OnInviteReply(invitee, reply)

邀请者收到“邀请加入房间”的回复消息。

参数说明：

回调参数

类型

说明

invitee

String

被邀请方的 UID

reply

int

  • 0：接听

  • 1：离线

  • 2：拒绝

OnRoomAttendanceList(participants)

推送“房间与会者列表”给新加入者。

参数说明：

回调参数

类型

值

值类型

说明

participants

jsonarray

uid

String

房间与会者的 UID

userType

int

与会者的用户类型：

  • 0：普通用户

  • 101：rtcvod 点播服务器

publish

jsonarray

发布流

feedId

String

房间与会者的发布流 ID

tag

String

feedId 对应的 tag

OnNewJoinerIn(participant)

推送“新加入房间者”给与会者。

参数说明：

回调参数

类型

说明

participant

String

新加入房间者的 UID

OnNewPublish(feed)

推送“有新发布”给与会者。

参数说明：

回调参数

类型

说明

feed

JSON

新发布的流信息：

  • uid：流所属的用户

  • feedId：发布流

  • tag：标签

  • mediaSource：媒体源

OnNewSubscribe(subscriber,feed)

将“有新订阅”的消息推送给与会者。

参数说明：

回调参数

类型

说明

subscriber

String

新订阅者 ID

feed

JSON

新订阅的流信息：

  • uid：流所属的用户 ID

  • feedId：被订阅流 ID

OnUnSubscribe(unsubscriber,feed)

推送“取消订阅”给与会者。

参数说明：

回调参数

类型

说明

unsubscriber

String

取消订阅者 ID

feed

JSON

取消订阅的流信息：

  • uid：流所属的用户 ID

  • feedId：被订阅流 ID

OnMediaClose(code，sid)

音视频关闭通知。

参数说明：

回调参数

类型

说明

code

int

正常状态：

  • 5001：取消发布/订阅触发关闭流

  • 5002：对端离开房间，被动关闭流

  • 5006：对端取消发布，被动关闭流

  • 5008：退出房间触发关闭流

异常状态：

  • 5003：启动流失败（信令阶段）

  • 5004：流建立连接超时

  • 5005：流建立连接成功，但房间状态异常

  • 5007：媒体链路连接关闭

  • 5009：媒体服务器通过信令通道发出关闭指令

  • 5010：媒体链路断开连接超时

  • 5011：媒体链路连接失败

  • 5012：发布初始化媒体源失败

sid

int

流 ID

OnReceiveTextMsg(uid, msg)

推送文本消息。

参数说明：

回调参数

类型

说明

uid

String

文本消息发送人

msg

String

消息文本

OnParticipantLeaveRoom(participant,exitType)

推送“退出房间者”给与会者。

参数说明：

回调参数

类型

说明

participant

String

退出者 ID

exitType

int

退出类型：

  • 1：正常退出

  • 2：异常退出

OnNetworkWeak(bpsSend, bpsRecv,sid)

弱网回调。

参数说明：

回调参数

类型

说明

bpsSend

String

每秒发送数据，单位为 bit

bpsRecv

String

每秒接收数据，单位为 bit

sid

int

流 ID，便于区分哪一路流出现弱网

OnVodOver(vod_id)

语音点播结束通知。

参数说明：

回调参数

类型

说明

vod_id

String

点播 ID

OnVolumeAnalyser(sid, analyser)

实时音量数据回调。

参数说明：

回调参数

类型

说明

sid

String

流 ID

analyser

AnalyserNode

返回 AnalyserNode 对象

OnClientRecordBlob(clientRecordId, blob)

浏览器录制推送录制 blob 数据。

参数说明：

回调参数

类型

说明

clientRecordId

String

浏览器录制 ID

blob

Blob

通过 Blob 对象将数据保存成多媒体文件

OnRemoteRecordOver(record_id)

服务端录制结束通知。

参数说明：

回调参数

类型

说明

record_id

String

录制 ID

OnRemoteRecordingFailed(recordId, feedId, code, msg)

服务端录制失败通知。

参数说明：

回调参数

类型

说明

recordId

String

录制 ID

feedId

String

与事件相关的流 ID

code

int

服务端录制失败通知返回：

  • -12481：eventCode 值为 1

  • -12482：eventCode 值为 2

msg

String

状态信息

OnReceiveData

接收 Channel 数据。

参数说明：

回调参数

类型

说明

data

String

回调参数接收信息

StreamFilterHandler

业务自定义处理流。

说明

StreamFilterHandler 需要是异步的函数或者返回 Promise 对象，SDK 使用 then() 接收处理后的 Stream。

参数说明：

回调参数

类型

说明

publish_tag

String

业务自定义的标记内容

stream

MediaStream

需要处理的流

stream_type

String

发布类型：publish（发布流）或者 subscribe（订阅流）

publish_device

int

当 stream_type 的值为 publish 才涉及此参数，参考 InitRoomConfig。

media_type

String

回调参数接收信息

OnDesktopDisplayClosed

共享屏幕关闭回调。

回调参数：无。

OnFileStreamClosed

OnFileStreamClosed 中的共享文件关闭回调。

回调参数：无。

OnParticipantEvent

对端发送事件回调。

参数说明：

回调参数

类型

说明

uid

String

对端用户

eventType

int

事件类型

eventDescription

String

事件描述

eventExtra

Object

事件数据（可选）

阿里云首页 移动开发平台 mPaaS 相关技术圈