回调接口

更新时间:
复制 MD 格式

回调接口主要是作为主调接口的回调反馈和返回业务上通知的接口,封装在 ArtvcRoom 的类中。

说明

目前 uid 只支持英文字母、数字、下划线的组合,且长度不超过 128 个字符。

OnConnect(data)

建立连接回调。

回调参数

类型

说明

data

JSON

OnGetSign(bizName, appId, uid,workspaceId)

说明

此接口的值需要返回给 SDK。

获取签名。

回调参数

类型

说明

bizName

String

对应 Connect 的 biz_name

appId

String

对应 Connect 的 appId

uid

String

对应 Connect 的 UID

workspaceId

String

对应 Connect 的 workspaceId

OnError(data)

错误信息回调通知。

回调参数

类型

说明

data

JSON

OnCreateRoom(data)

创建房间成功回调。

回调参数

类型

说明

data

JSON

OnJoinRoom(data)

加入房间成功回调。

回调参数

类型

说明

data

JSON

OnPublish(data)

发布媒体流成功回调。

回调参数

类型

说明

data

JSON

  • pushUrl:推流 URL

OnSubscribe(data)

订阅媒体流成功回调。

回调参数

类型

说明

data

JSON

  • liveUrl:推流 URL

OnLeaveRoom(data)

离开房间回调。

回调参数

类型

说明

data

JSON

  • leaveType

    • 1:正常退出

    • 2:异常退出

OnParticipantLeaveRoom(data)

通知对端离开房间回调。

回调参数

类型

说明

data

JSON

  • participant:用户 UID

  • exitType

    • 1:正常退出

    • 2:异常退出

OnSendTxtMessageSucc(data)

发送文本信息成功回调。

回调参数

类型

说明

msgId

number

已发送文本信息的 ID

OnGetTxtMessage(data)

获取文本信息成功回调。

回调参数

类型

说明

mgsId

int

文本信息的 ID

uid

int

发送文本信息的 UID

msg

String

文本信息的内容

OnGetFeedIdsD(Array)

获取当前房间的所有用户信息成功回调。

回调参数

类型

值

值类型

说明

Array

Array

feedId

String

订阅流需要的 ID

uid

String

用户 ID

tag

String

自定义标签

OnClientJoin(Data)

通知有用户加入房间回调。

回调参数

类型

值

值类型

说明

Data

JSON

feedId

String

订阅流需要的 ID

uid

String

用户 ID

tag

String

自定义标签

OnInviteRequest(roomId, rtoken, inviter, extra, inviteId, inviteInfo)

接受到加入房间邀请 。

回调参数

类型

说明

roomId

待加入房间号码

rtoken

待加入房间 token

inviter

发送邀请的 ID

extra

额外信息

inviteId

邀请的 ID

inviteInfo

邀请着视频,音频是否打开