DingRTCClient

属性列表

接口列表

事件列表

接口详情

getLocalAudioStats()

获取本地音频相关信息。

类型签名

getLocalAudioStats(): LocalAudioStates;

返回

LocalAudioStates

getLocalVideoStats()

获取本地视频相关信息。

类型签名

getLocalVideoStats(): LocalVideoStatesMap;

返回

LocalVideoStatesMap

getRemoteVideoStats()

获取远端用户的视频统计信息。

类型签名

getRemoteVideoStats(): RemoteVideoStatesMap;

返回

RemoteVideoStatesMap

getRemoteNetworkQuality()

获取远端用户的网络统计信息，远端用户也需要在3.3.0版本及以上时才能获取到信息。

类型签名

getRemoteNetworkQuality(): {
  [uid: string]: {
    downlinkNetworkQuality: NetworkQuality,
    uplinkNetworkQuality: NetworkQuality,
  }
};

返回

{

[uid: string]: {

downlinkNetworkQuality: NetworkQuality,

uplinkNetworkQuality: NetworkQuality,

}

};

join()

加入频道,在同一个频道内的用户可以互相通话。

调用该方法加入频道时，本地会触发 "connection-state-change" 回调。

本端加入频道成功后，远端会触发 "user-joined" 回调。

类型签名

join(joinInfo: JoinParam): Promise<{
  remoteUsers: RemoteUser[];
  timeLeft: number;
}>;

入参：

返回：

返回

Promise<{ remoteUsers: RemoteUser[]; timeLeft: number }>

leave()

离开频道，即挂断或退出通话。

调用该方法离开频道时，本地会触发 "connection-state-change" 回调。

远端会触发 "user-left" 回调。

类型签名

leave(): void;

返回

void

publish()

发布本地音视频轨道至频道中。

发布音视频轨道之后，远端会触发 "user-published" 回调。

类型签名

publish(tracks: LocalTrack | LocalTrack[]): Promise<void>;

返回

Promise<void>

setRemoteDefaultVideoStreamType()

设置订阅所有远端用户的视频类型。

如果远端用户开启了双流模式，本地用户调用 subscribe 后会直接订阅本方法中 streamType 参数所指定的流类型。如不设置，默认订阅大流

类型签名

setRemoteDefaultVideoStreamType(streamType: RemoteStreamType): void;

返回

void

setRemoteVideoStreamType()

设置订阅特定远端用户的视频类型。

类型签名

setRemoteVideoStreamType(uid: string, streamType: RemoteStreamType): Promise<void>;

返回

Promise<void>

subscribe()

订阅远端用户的音视频轨道。

类型签名

subscribe(uid: string, mediaType: TrackMediaType, auxiliary?: boolean): Promise<RemoteAudioTrack | RemoteVideoTrack>;

返回

Promise<RemoteAudioTrack|RemoteVideoTrack>

batchSubscribe()

批量订阅远端用户的音视频轨道。

类型签名

batchSubscribe(batchSubscribeParam: SubscribeParam[]): Promise<SubscribeResult[]>;

返回

Promise<SubscribeResult[]>

unpublish()

取消发布本地音视频轨道。

取消发布音视频轨道之后，远端会触发 "user-unpublished" 回调。

类型签名

unpublish(tracks?: LocalTrack | LocalTrack[]): Promise<void>;

返回

Promise<void>

unsubscribe()

取消订阅远端用户的音视频轨道。

类型签名

unsubscribe(uid: string, mediaType?: TrackMediaType, auxiliary?: boolean): Promise<void>;

返回

Promise<void>

batchUnsubscribe()

批量订阅远端用户的音视频轨道。

类型签名

batchSubscribe(batchUnsubscribeParam: UnsubscribeParam[]): Promise<void>;

返回

Promise<void>

on()

监听一个指定事件并设置回调函数

类型签名

on(event: string, fn: Function): void;

参数

返回

void

off()

取消一个指定事件的监听回调函数

类型签名

off(event: string, fn: Function): void;

参数

返回

void

once()

监听一个指定事件一次，回调函数触发后移除

类型签名

once(event: string, fn: Function): void;

参数

返回

void

removeAllListeners()

取消该对象指定事件或所有事件上的监听回调

类型签名

removeAllListeners(event?: string): void;

参数

返回

void

joinGroup()

加入指定音频分组

类型签名

joinGroup(config?: JoinGroupConfig): Promise<void>;

参数

返回

Promise<void>;

leaveGroup()

离开指定音频分组

类型签名

leaveGroup(groupId: string): Promise<void>;

参数

返回

Promise<void>

dismissGroup()

解散指定音频分组

类型签名

dismissGroup(groupId: string): Promise<void>;

参数

返回

Promise<void>

subscribeGroup()

订阅指定音频分组

类型签名

subscribeGroup(groupId: string): Promise<RemoteAudioTrack>;

参数

返回

Promise<RemoteAudioTrack>

unsubscribeGroup()

解散指定音频分组

类型签名

unsubscribeGroup(groupId: string): Promise<void>;

参数

返回

Promise<void>

mixAudioToGroup()

将指定音频轨道混音/取消混音到对应分组或频道

类型签名

mixAudioToGroup(track: LocalAudioTrack, mixed: boolean, groupId?: string): Promise<void>;

参数

返回

Promise<void>

事件列表

"connection-state-change"

SDK 与服务器的连接状态发生改变回调。

类型签名

'connection-state-change': (curState: ConnectionState, revState: ConnectionState, reason?: DisconnectedReason) => void;

"media-reconnect-end"

SDK 重新建立媒体连接（用于发布和订阅）结束的回调。

类型签名

'media-reconnect-end': (uid: string) => void;

"media-reconnect-start"

SDK 开始尝试重新建立媒体连接（用于发布和订阅）的回调。

类型签名

'media-reconnect-start': (uid: string) => void;

"stream-type-changed"

订阅的视频流类型发生改变回调。 视频流类型改变指视频大流（高码率、高分辨率）变为视频小流（低码率、低分辨率），或视频小流变为视频大流。

类型签名

'stream-type-changed': (uid: string, streamType: RemoteStreamType) => void;

"user-info-updated"

该回调用于提示用户状态变化。

在大部分情况下，你只需要监听 user-published 和 user-unpublished 就可以完成订阅、取消订阅、展示远端用户是否打开了摄像头和麦克风等工作，无需特别关注实际用户状态的变化，SDK 会自动处理用户状态变化。

类型签名

'user-info-updated': (uid: string, msg: 'mute-audio' | 'mute-video' | 'unmute-audio' | 'unmute-video') => void;

"user-joined"

远端用户加入频道回调。

类型签名

'user-joined': (user: RemoteUser) => void;

"user-left"

远端用户离开频道回调。

类型签名

'user-left': (user: RemoteUser) => void;

"user-published"

该回调通知远端用户发布了新的音频轨道或者视频轨道。

你可以在该回调中订阅并播放远端用户的音视频轨道。

类型签名

'user-published': (user: RemoteUser, mediaType: TrackMediaType, auxiliary?: boolean) => void;

"user-unpublished"

该回调通知远端用户取消发布音频轨道或者视频轨道。

类型签名

'user-unpublished': (user: RemoteUser, mediaType: TrackMediaType, auxiliary?: boolean) => void;

"volume-indicator"

提示频道内正在说话的远端用户列表，当有三人及以上时自动开启。

uids 正在说话人的uid，第一个为音量最高的人，列表为空时代表无人在说话。

类型签名

'volume-indicator': (uids: string[]) => void;

"network-quality"

客户端侧网络质量报告回调，加入频道后每2秒触发一次，仅用作参考值。

类型签名

'network-quality': (uplinkNetworkQuality: NetworkQuality, downlinkNetworkQuality: NetworkQuality) => void;

"group-add"

分组添加事件

类型签名

'group-add': (group: Group) => void;

"group-remove"

分组移除事件

类型签名

'group-remove': (group: Group) => void;

"group-user-join"

分组成员加入事件

类型签名

'group-user-join': (groupId: string, groupUser: GroupUser) => void;

"group-user-leave"

分组成员离开事件

类型签名

'group-user-leave': (groupId: string, groupUser: GroupUser) => void;