接口列表

事件列表

DingRTC 全局事件

接口詳情

createClient()

創(chuàng)建一個客戶端實例以進行 RTC 通信

類型簽名

createClient(): DingRTCClient;

返回

DingRTCClient

checkSystemRequirements()

該方法必須在創(chuàng)建客戶端對象 createClient 之前調(diào)用。

檢查 DingRTC Web SDK 對正在使用的瀏覽器的適配情況。

類型簽名

checkSystemRequirements(): boolean;

返回

是否支持當前瀏覽器。

getCameras()

枚舉可用的視頻輸入設備，比如攝像頭。 調(diào)用成功后 SDK 會通過 MediaDeviceInfo 對象返回可用的視頻輸入設備。

類型簽名

getCameras(): Promise<MediaDeviceInfo[]>;

返回

返回MediaDeviceInfo[]，本地所有可用視頻輸入設備列表

getPlaybackDevices()

枚舉可用的音頻播放設備，比如揚聲器。 調(diào)用成功后 SDK 會通過 MediaDeviceInfo 對象返回可用的音頻播放設備。

類型簽名

getPlaybackDevices(): Promise<MediaDeviceInfo[]>;

返回

返回MediaDeviceInfo[]，本地所有可用的音頻播放設備列表

getDevices()

枚舉可用的媒體輸入和輸出設備，比如麥克風、攝像頭、耳機等。 調(diào)用成功后 SDK 會通過 MediaDeviceInfo 對象返回可用的媒體設備。

類型簽名

getDevices(): Promise<MediaDeviceInfo[]>;

返回

返回MediaDeviceInfo[]，本地所有可用的媒體設備列表

getMicrophones()

枚舉可用的音頻輸入設備，比如麥克風。 調(diào)用成功后 SDK 會通過 MediaDeviceInfo 對象返回可用的音頻輸入設備。

類型簽名

getMicrophones(): Promise<MediaDeviceInfo[]>;

返回

返回MediaDeviceInfo[]，本地所有可用的音頻輸入設備列表

createCameraVideoTrack()

通過攝像頭采集的視頻創(chuàng)建一個視頻軌道。

類型簽名

createCameraVideoTrack(config: CameraVideoTrackConfig): Promise<CameraVideoTrack>;

返回

Promise<CameraVideoTrack>

攝像頭軌道

createMicrophoneAudioTrack()

通過麥克風采集的音頻創(chuàng)建一個音頻軌道。

類型簽名

createMicrophoneAudioTrack(config?: MicrophoneAudioTrackConfig): Promise<MicrophoneAudioTrack>;

參數(shù)

返回

Promise<MicrophoneAudioTrack>

音頻軌道

createCustomVideoTrack()

創(chuàng)建一個自定義的視頻軌道。 你可以使用這個方法將自己維護的 MediaStreamTrack 轉(zhuǎn)換成一個可以用于 SDK 的視頻軌道。

類型簽名

createCustomVideoTrack(config: CustomVideoTrackConfig): Promise<LocalVideoTrack>;

參數(shù)

返回

Promise<LocalVideoTrack>

自定義視頻軌道

createCustomAudioTrack()

創(chuàng)建一個自定義的音頻軌道。 你可以使用這個方法將自己維護的 MediaStreamTrack 轉(zhuǎn)換成一個可以用于 SDK 的音頻軌道。

類型簽名

createCustomAudioTrack(config: CustomAudioTrackConfig): Promise<LocalAudioTrack>;

參數(shù)

返回

Promise<LocalAudioTrack>

自定義音頻軌道

createScreenVideoTrack()

創(chuàng)建用于屏幕共享的視頻軌道。

類型簽名

createScreenVideoTrack(config: ScreenVideoTrackConfig): Promise<LocalVideoTrack[]>;

參數(shù)

返回

Promise<LocalVideoTrack[]>

返回一個數(shù)組，只有一個元素，即屏幕共享的視頻軌道。

createMicrophoneAndCameraTracks()

同時創(chuàng)建麥克風音頻軌道和攝像頭視頻軌道。 通過麥克風采集的音頻創(chuàng)建一個音頻軌道，同時通過攝像頭采集的視頻創(chuàng)建一個視頻軌道。

類型簽名

createMicrophoneAndCameraTracks(videoConfig: CameraVideoTrackConfig, audioConfig: MicrophoneAudioTrackConfig): Promise<(CameraVideoTrack | MicrophoneAudioTrack)[]>;

參數(shù)

返回

Promise<(CameraVideoTrack|MicrophoneAudioTrack)[]>

創(chuàng)建的音頻軌道和視頻軌道

setClientConfig()

設置sdk 集成選項設置

類型簽名:

setClientConfig(config: GlobalClientConfigInfo): void;

參數(shù)

返回:

void

setLogLevel()

設置 SDK 的日志輸出級別。

類型簽名

setLogLevel(level: LogLevel): void;

參數(shù)

返回

void

getSupportedCodec()

獲取 DingRtc Web SDK 對正在使用的瀏覽器支持的編解碼格式。部分華為手機h264與其他平臺存在無法互通問題，后續(xù)會優(yōu)化解決。

類型簽名:

getSupportedCodec(): Promise<{
 audio: string[];
 video: string[];
 }>;

Returns:

Promise<{ audio: string[]; video: string[]; }>

支持的音視頻編解碼格式

on()

監(jiān)聽一個指定事件并設置回調(diào)函數(shù)

類型簽名

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

參數(shù)

返回

void

off()

取消一個指定事件的監(jiān)聽回調(diào)函數(shù)

類型簽名

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

參數(shù)

返回

void

once()

監(jiān)聽一個指定事件一次，回調(diào)函數(shù)觸發(fā)后移除

類型簽名

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

參數(shù)

返回

void

removeAllListeners()

取消該對象指定事件或所有事件上的監(jiān)聽回調(diào)

類型簽名

removeAllListeners(event?: string): void;

參數(shù)

返回

void

事件詳情

"autoplay-failed"

音頻自動播放失敗

類型簽名

'autoplay-failed': (track: LocalTrack|RemoteTrack) => void;

示例

DingRTC.on('autoplay-failed', (track) => {
 console.log(track);
});

"camera-changed"

視頻采集設備狀態(tài)變化

類型簽名

'camera-changed': (info: DeviceInfo) => void;

示例

DingRTC.on('camera-changed', (info) => {
 console.log(info);
})

"microphone-changed"

音頻采集設備狀態(tài)變化

類型簽名

'microphone-changed': (info: DeviceInfo) => void;

示例

DingRTC.on('microphone-changed', (info) => {
 console.log(info);
})

"playback-device-changed"

音頻播放設備變化

類型簽名

'playback-device-changed': (info: DeviceInfo) => void;

示例

DingRTC.on('playback-device-changed', (info) => {
 console.log(info);
});