文档

主调接口

更新时间:

主调接口是供业务主动调用的接口,封装于 ArtvcRoom 类中。

重要

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

Connect

建立通话连接。

  • 参数:

    请求参数

    类型

    说明

    config(JSON)

    uid

    String

    用户 ID 标识

    biz_name

    String

    业务标识

    appId

    String

    业务标识

    workspaceId

    String

    业务标识

    server_url

    String

    房间服务器的地址

  • 回调接口异步返回:

    • OnConnect(data)

    • OnError(data)

CreateRoom

创建通话房间。

  • 参数:

    请求参数

    类型

    说明

    config(JSON)

    roomId

    String

    房间号

    rtoken

    String

    房间密码

  • 回调接口异步返回:

    • OnCreateRoom(data)

    • OnError(data)

JoinRoom

加入通话房间。

  • 参数:

    请求参数

    类型

    说明

    config(JSON)

    roomId

    String

    房间号

    rtoken

    String

    房间密码

  • 回调接口异步返回:

    • OnJoinRoom(data)

    • OnError(data)

Publish

推送通话信息。

  • 参数:

    请求参数

    类型

    说明

    config(JSON)

    resolution

    String

    分辨率

    fps

    int

    帧率

    maxBitrate

    int

    最大码率

    tag

    String

    自定义标识

  • 回调接口异步返回:

    • OnPublish(data)

    • OnError(data)

Subscribe

订阅通话信息。

  • 参数:无。

  • 回调接口异步返回:

    • OnSubscribe(data)

    • OnError(data)

LeaveRoom

退出通话房间。

  • 参数:无。

  • 回调接口异步返回:

    • OnLeaveRoom(data)

    • OnError(data)

Disconnect

断开通话连接。

参数:无。

SendTxtMessage

发送文本信息。

参数:

请求参数

类型

说明

config(JSON)

uids

list

接收信息的所有用户 ID

timestamp

number

时间戳

msg

String

文本信息的内容

ReportClientEvents

说明

此接口的相关逻辑已在 demo 中实现,由于事件是跟 UI 相关,逻辑是写在业务 UI 层的,因此需要业务侧把该上报逻辑复制到自己的项目中去,方便日常排查及功能扩展。

上报通话事件相关状态码。请求参数(code),类型(int)。

参数:

请求参数

类型

说明

code

int

事件类型:

301:{ desc:"ACTIVITY_PAUSE" },// 小程序后台运行

302:{ desc:"ACTIVITY_RESUME" },// 小程序恢复前台

321:{ desc:"DISABLE_LOCAL_VIDEO" },// 关闭摄像头

322:{ desc:"ENABLE_LOCAL_VIDEO" },// 开启摄像头

323:{ desc:"DISABLE_LOCAL_AUDIO" },// 关闭麦克风

324:{ desc:"ENABLE_LOCAL_AUDIO" },// 开启麦克风

329:{ desc:"CHANGE_TO_EARPIECE" },// 转听筒

330:{ desc:"CHANGE_TO_SPEAKER_PHONE" },// 转外放

363:{ desc:"ERROR_CAMERA_PERMISSION" },// 相机权限错误

364:{ desc:"ERROR_MIC_PERMISSION" },// mic 权限错误

366:{ desc:"ERROR_OPEN_CAMERA" },// 打开摄像头错误-1007

367:{ desc:"ERROR_OPEN_MIC" },// 打开麦克风错误/麦克风采集异常

503:{ desc:"VIDEO_FIRST_FRAME", extra:true }// 订阅到视频首帧

extra

Object

上述事件类型包含 extra 字段,需要携带额外的信息。

SendInvite

邀请。

说明

该邀请功能要求被邀请者连接在线。

请求参数

类型

描述

uid

string

  • uid:想要邀请的用户 ID

回调接⼝异步返回:

  • OnInviteSucc()

  • OnInviteFail(code,msg)

ReplyInviteToJoinRoom

回复邀请。

请求参数

类型

说明

roomId

待加入房间号码

inviter

发送邀请的 UID

join

int

0:同意加入

2:拒绝

inviteId

邀请的 ID

inviteInfo

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

回调接⼝异步返回:

  • OnReplyInviteOK()

  • OnReplyInviteFail(code,msg)

  • 本页导读 (0)