DingRTC

接口列表

事件列表

DingRTC 全局事件

接口详情

createClient()

创建一个客户端实例以进行 RTC 通信

类型签名

createClient(): DingRTCClient;

返回

DingRTCClient

getCameras()

枚举可用的视频输入设备，比如摄像头。 调用成功后 SDK 会通过 MediaDeviceInfo 对象返回可用的视频输入设备。

类型签名

getCameras(): Promise<MediaDeviceInfo[]>;

返回

返回MediaDeviceInfo[]，本地所有可用视频输入设备列表

getPlaybackDevices()

枚举可用的音频播放设备，比如扬声器。 调用成功后 SDK 会通过 MediaDeviceInfo 对象返回可用的音频播放设备。

类型签名

getPlaybackDevices(): Promise<MediaDeviceInfo[]>;

返回

返回MediaDeviceInfo[]，本地所有可用的音频播放设备列表

getScreenCaptureSources()

获取可共享的屏幕和窗口对象列表。

类型签名

getScreenCaptureSources(includeScreen?: boolean): ScreenCaptureSourceInfo[]

返回

返回ScreenCaptureSourceInfo[]，本地所有屏幕信息列表

getDevices()

枚举可用的媒体输入和输出设备，比如麦克风、摄像头、耳机等。 调用成功后 SDK 会通过 MediaDeviceInfo 对象返回可用的媒体设备。

类型签名

getDevices(): Promise<MediaDeviceInfo[]>;

返回

返回MediaDeviceInfo[]，本地所有可用的媒体设备列表

getMicrophones()

枚举可用的音频输入设备，比如麦克风。 调用成功后 SDK 会通过 MediaDeviceInfo 对象返回可用的音频输入设备。

类型签名

getMicrophones(): Promise<MediaDeviceInfo[]>;

返回

返回MediaDeviceInfo[]，本地所有可用的音频输入设备列表

createCameraVideoTrack()

通过摄像头采集的视频创建一个视频轨道。

类型签名

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

返回

Promise<CameraVideoTrack>

摄像头轨道

createMicrophoneAudioTrack()

通过麦克风采集的音频创建一个音频轨道。

类型签名

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

参数

返回

Promise<MicrophoneAudioTrack>

音频轨道

createPlaybackAudioTrack()

创建用于处理扬声器相关操作的音频轨道。

类型签名

createPlaybackAudioTrack(
    config?: PlaybackAudioTrackConfig,
): Promise<PlaybackAudioTrack>

参数

返回

Promise<PlaybackAudioTrack>

音频轨道

createCustomVideoTrack()

创建一个自定义的视频轨道。 你可以使用这个方法将自己维护的 MediaStreamTrack 转换成一个可以用于 SDK 的视频轨道。

类型签名

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

参数

返回

Promise<LocalVideoTrack>

自定义视频轨道

createCustomAudioTrack()

创建一个自定义的音频轨道。 你可以使用这个方法将自己维护的 MediaStreamTrack 转换成一个可以用于 SDK 的音频轨道。

类型签名

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

参数

返回

Promise<LocalAudioTrack>

自定义音频轨道

createScreenVideoTrack()

创建用于屏幕共享的视频轨道。

类型签名

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

参数

返回

Promise<LocalVideoTrack[]>

返回一个数组，只有一个元素，即屏幕共享的视频轨道。

createMicrophoneAndCameraTracks()

同时创建麦克风音频轨道和摄像头视频轨道。 通过麦克风采集的音频创建一个音频轨道，同时通过摄像头采集的视频创建一个视频轨道。

类型签名

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

参数

返回

Promise<(CameraVideoTrack|MicrophoneAudioTrack)[]>

创建的音频轨道和视频轨道

setClientConfig()

设置sdk 集成选项设置

类型签名:

setClientConfig(config: GlobalClientConfigInfo): void;

参数

返回:

void

setLogDirPath()

设置SDK日志文件保存路径。

类型签名

setLogDirPath(logDirPath: string): void

参数

返回

void

setLogLevel()

设置 SDK 的日志输出级别。

类型签名

setLogLevel(level: LogLevel): void;

参数

返回

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

事件详情

"autoplay-failed"

音频自动播放失败

类型签名

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

示例

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

"camera-changed"

视频采集设备状态变化

类型签名

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

示例

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

"microphone-changed"

音频采集设备状态变化

类型签名

'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);
});