Documentation

Namespaces

Classes

Audio
Chatroom
ChatroomInfo
ChatroomMember
ChatroomMessage
Client
File
Friend
Geo
Image
IMMessage
LoginPort
Netcall
NetcallWeixin
NIM
NIMError
NRTC
Relation
Session
Signaling
Stream
SuperTeam
SuperTeamMember
SystemMessage
Team
TeamMember
User
Video
WebRTC
WebRTC2
WebRTC/NRTC
WhiteBoard

Namespaces

blob
support
util

Events

client-role-changed

本地用户角色发生了变化

Type: object
Properties:
Name Type Description
role 'host' | 'audience'

变化后的角色

addTrack

addTrack 添加轨道事件-高级用法 WebRTC适用

Type: object

audioVolume

audioVolume 当前所有参与通话者的音量大小实时回调通知 WebRTC适用

Type: object

auidoMixingEnd

auidoMixingEnd 伴音播放完成 WebRTC适用

Type: object

deviceAdd

deviceAdd 新增设备的通知 WebRTC适用

Type: array
Properties:
Name Type Description
device object

设备信息

Properties
Name Type Description
deciveId string

设备ID
type string

设备类型 audioIn audioOut video
label string

设备名

deviceRemove

deviceRemove 设备移除的通知 WebRTC适用

Type: array
Properties:
Name Type Description
device object

设备信息

Properties
Name Type Description
deciveId string

设备ID
type string

设备类型 audioIn audioOut video
label string

设备名

deviceStatus

deviceStatus 设备状态变化通知 WebRTC适用

Type: array
Properties:
Name Type Description
device object

设备信息

Properties
Name Type Description
deciveId string

设备ID
type string

设备类型 audioIn audioOut video
label string

设备名

error

error 错误事件

Type: object
Properties:
Name Type Description
code number

错误码
name string

错误名
desc string

错误原因

gatewayClosed

gatewayClosed 网关连接断开，等待重连/断开 WebRTC适用

Type: object

joinChannel

joinChannel 收到自己加入频道的通知 WebRTC适用

Type: void

leaveChannel

leaveChannel 收到用户离开频道的通知 WebRTC适用

Type: void

recordStopped

recordStopped 音视频录制完成 WebRTC适用

Type: object
Properties:
Name Type Description
id number
name string

音视频录制名称
status string

音视频录制状态
type string

音视频录制类型
uid string

音视频录制的uid

remoteTrack

remoteTrack 收到用户媒体流-高级用法 WebRTC适用

Type: object

removeTrack

removeTrack 删除轨道事件-高级用法 WebRTC适用

Type: object

streamEnded

streamEnded 媒体流停止通知 WebRTC适用

Type: array
Properties:
Name Type Description
device object

设备信息

Properties
Name Type Description
deciveId string

设备ID
type string

设备类型 audioIn audioOut video
label string

设备名

userJoined

userJoined 有用户加入频道的通知 WebRTC适用

Type: object
Properties:
Name Type Description
channelId number

加入频道ID
account number

用户账号(WebRTC有意义)
uid string

用户uid
label string

事件说明

userLeft

userLeft 有用户离开频道的通知 WebRTC适用

Type: object
Properties:
Name Type Description
channelId number

加入频道ID
account number

用户账号(WebRTC有意义)
uid string

用户uid
label string

事件说明
code number

用户离开原因
name string

用户离开原因

userStateUpdated

userStateUpdated 对方音视频状态更新，如开关音视频设备等 WebRTC适用

Type: object

beCalling

beCalling 收到呼叫请求

Type: object
Properties:
Name Type Description
channelId number

加入频道ID
account number

用户账号(WebRTC有意义)
uid string

用户uid

callAccepted

callAccepted 主叫收到被叫应答通知: 接受

Type: object

callerAckSync

callerAckSync 其他端已处理的通知

Type: object

callRejected

callRejected 主叫收到被叫应答通知: 拒绝

Type: object

control

control 通话进行中收到对端的控制通知

Type: object

hangup

hangup 收到挂断通知

Type: object

sessionDuration

sessionDuration 通话计时完成的通知

Type: object