屬性列表

接口列表

事件列表

接口詳情

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;