实时音视频 > API 文档 > Web >QNRTC

QNRTC

最近更新时间: 2023-07-05 12:41:36

QNRTC 是 SDK 的入口，提供了 SDK 配置，创建本地音视频轨道，创建房间对象等一系列方法。

Index

Properties

VERSION

Callbacks

Core Methods

Properties

VERSION

VERSION: string
获取 SDK 版本号

Callbacks

onCameraChanged

onCameraChanged: undefined | (info: QNDeviceInfo) => void
摄像头变化回调，提示有摄像头被添加或移除
```
QNRTC.onCameraChanged = function(info) {
    console.log('camera changed!', info);
};
```
Parameters
- info: QNDeviceInfo
  
  设备信息

onMicrophoneChanged

onMicrophoneChanged: undefined | (info: QNDeviceInfo) => void

麦克风变化回调，提示有麦克风被添加或移除

QNRTC.onMicrophoneChanged = function(info) {
    console.log('microphone changed!', info);
};

Parameters

info: QNDeviceInfo

设备信息

onPlaybackDeviceChanged

onPlaybackDeviceChanged: undefined | (info: QNDeviceInfo) => void
播放设备变化回调，提示有音频播放设备被添加或移除
```
QNRTC.onPlaybackDeviceChanged = function(info) {
    console.log('speaker changed!', info);
};
```
Parameters
- info: QNDeviceInfo
  
  设备信息

Core Methods

isBrowserSupported

isBrowserSupported(): boolean
当前浏览器是否支持 QNRTC SDK

Returns boolean

checkSystemRequirements

checkSystemRequirements(): Promise<QNSystemRequirementsTestResult>
系统兼容检测。

Returns Promise<QNSystemRequirementsTestResult>

setLogLevel

setLogLevel(level: QNLogLevel): void
设置日志打印等级。

Parameters
- level: QNLogLevel
  
  日志等级
Returns void

isChromeExtensionAvailable

isChromeExtensionAvailable(): Promise<boolean>
检查 Chrome 浏览器插件是否已安装。

Returns Promise<boolean>

createClient

createClient(): QNRTCClient
创建QNRTCClient对象

Returns QNRTCClient

getCameras

getCameras(skipPermissionCheck = false): Promise<MediaDeviceInfo[]>
枚举可用的视频输入设备，比如摄像头

Parameters
- Optional skipPermissionCheck: boolean
  
  将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
  
  🔹 true: 跳过权限检查
  
  🔹 false:（默认）不跳过权限检查。
Returns Promise<MediaDeviceInfo[]>

getMicrophones

getMicrophones(skipPermissionCheck = false): Promise<MediaDeviceInfo[]>
枚举可用的音频输入设备，比如麦克风

Parameters
- Optional skipPermissionCheck: boolean
  
  将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
  
  🔹 true: 跳过权限检查
  
  🔹 false:（默认）不跳过权限检查。
Returns Promise<MediaDeviceInfo[]>

getPlaybackDevices

getPlaybackDevices(skipPermissionCheck = false): Promise<MediaDeviceInfo[]>
枚举可用的音频播放设备，比如扬声器

Parameters
- Optional skipPermissionCheck: boolean
  
  将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
  
  🔹 true: 跳过权限检查
  
  🔹 false:（默认）不跳过权限检查。
Returns Promise<MediaDeviceInfo[]>

getDevices

getDevices(skipPermissionCheck?: boolean): Promise<MediaDeviceInfo[]>
枚举可用的媒体输入和输出设备，比如麦克风、摄像头、耳机等

Parameters
- Optional skipPermissionCheck: boolean
  
  将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
  
  🔹 true: 跳过权限检查
  
  🔹 false:（默认）不跳过权限检查。
Returns Promise<MediaDeviceInfo[]>

createCameraVideoTrack

createCameraVideoTrack(config?: QNCameraVideoTrackConfig): Promise<QNCameraVideoTrack>
通过摄像头采集的视频创建一个视频轨道。

默认 tag 为 ' '、前置摄像头、传输优化模式 DEFAULT、编码配置 480p。

Parameters
- Optional config: QNCameraVideoTrackConfig
  
  摄像头视频采集的配置信息。
Returns Promise<QNCameraVideoTrack>

createMicrophoneAudioTrack

createMicrophoneAudioTrack(config?: QNMicrophoneAudioTrackConfig): Promise<QNMicrophoneAudioTrack>
通过麦克风采集的音频创建一个音频轨道。

默认 tag 为 ' '、传输优化模式 DEFAULT、开启自动增益、开启回声消除、开启降噪、编码配置 STANDARD。

Parameters
- Optional config: QNMicrophoneAudioTrackConfig
  
  麦克风音频采集的配置信息。
Returns Promise<QNMicrophoneAudioTrack>

createScreenVideoTrack

createScreenVideoTrack(config?: QNScreenVideoTrackConfig, withAudio?: string): Promise<[QNScreenVideoTrack, QNLocalAudioTrack] | QNScreenVideoTrack>
创建用于屏幕共享的视频轨道。

默认 screenVideoTag 为 ' 'screenAudioTag 为 ' '、传输优化模式 DEFAULT、编码配置 720p。

Parameters
- Optional config: QNScreenVideoTrackConfig
  
  采集屏幕共享视频的配置信息。
- Optional withAudio: string
  
  屏幕共享时是否同时采集系统声音。
  
  🔹 enable: 采集系统声音，如果采集失败，抛出错误
  
  🔹 disable: （默认）不采集系统声音
  
  🔹 auto: 采集系统声音，如果采集失败，不抛出错误，无音频轨道返回
Returns Promise<[QNScreenVideoTrack, QNLocalAudioTrack] | QNScreenVideoTrack>

createMicrophoneAndCameraTracks

createMicrophoneAndCameraTracks(audioConfig?: QNMicrophoneAudioTrackConfig, videoConfig?: QNCameraVideoTrackConfig): Promise<[QNMicrophoneAudioTrack, QNCameraVideoTrack]>
同时采集麦克风音频和摄像头视频轨道。

视频配置默认 tag 为 ' '、前置摄像头、传输优化模式 DEFAULT、编码配置 480p。

音频配置默认 tag 为 ' '、传输优化模式 DEFAULT、开启自动增益、开启回声消除、开启降噪、编码配置 STANDARD。

Parameters
- Optional audioConfig: QNMicrophoneAudioTrackConfig
  
  麦克风音频采集的配置信息。
- Optional videoConfig: QNCameraVideoTrackConfig
  
  摄像头视频采集的配置信息。
Returns Promise<[QNMicrophoneAudioTrack, QNCameraVideoTrack]>

createBufferSourceAudioTrack

createBufferSourceAudioTrack(config: QNBufferSourceAudioTrackConfig): Promise<QNBufferSourceAudioTrack>
通过外部音频数据源创建一个音频轨道。

Parameters
- config: QNBufferSourceAudioTrackConfig
  
  关于外部音频数据源的配置等信息。
Returns Promise<QNBufferSourceAudioTrack>

createCanvasVideoTrack

createCanvasVideoTrack(config: QNCanvasVideoTrackConfig): QNCanvasVideoTrack
创建画布视频 track

Parameters
- config: QNCanvasVideoTrackConfig
  
  配置画布宽高、内容等信息。
Returns QNCanvasVideoTrack

createCustomAudioTrack

createCustomAudioTrack(config: QNCustomAudioTrackConfig): QNCustomAudioTrack
创建一个自定义的音频轨道。

Parameters
- config: QNCustomAudioTrackConfig
  
  通过该配置指定码率、音源等信息。
Returns QNCustomAudioTrack

createCustomVideoTrack

createCustomVideoTrack(config: QNCustomVideoTrackConfig): QNCustomVideoTrack
创建一个自定义的视频轨道。

Parameters
- config: QNCustomVideoTrackConfig
  
  通过该配置指定码率、视频源等信息。
Returns QNCustomVideoTrack

checkAudioTrackIsActive

checkAudioTrackIsActive(track: QNLocalAudioTrack | QNRemoteAudioTrack, timeout?: number): Promise<boolean>
检测音频轨道是否活跃

在一定时间内检测音频轨道声音是否有变化或者是否低于正常值。

可以在开始通话前对音频输入设备进行可用性检测。

当音频轨被 muted 的时候返回 false

如果传入的音频轨道在处于极度安静的情况下，该接口可能会误报。

Parameters
- track: QNLocalAudioTrack | QNRemoteAudioTrack
  
  需要检测的本地或远端音频 Track
- Optional timeout: number
  
  sdk 最低检测事件为200 ms，若传入值小于200，则 sdk 会自动调整为 200ms。
Returns Promise<boolean>

checkVideoTrackIsActive

checkVideoTrackIsActive(track: QNLocalVideoTrack | QNRemoteVideoTrack, timeout?: number): Promise<boolean>
检测视频轨道是否活跃

在一定时间内检测视频轨道画面是否有变化。

可以在开始通话前对视频输入设备进行可用性检测。

当视频轨被 muted 的时候返回 false。

Parameters
- track: QNLocalVideoTrack | QNRemoteVideoTrack
  
  需要检测的本地或远端视频 Track
- Optional timeout: number
  
  sdk 最低检测事件为60 ms，若传入值小于60，则 sdk 会自动调整为 60ms。
Returns Promise<boolean>

setTransportPolicy

setTransportPolicy(policy: QNTransportPolicy): void
设置传输模式

Parameters
- policy: QNTransportPolicy
  
  传输策略，默认值为 preferUdp。
Returns void

getElectronScreenSources

getElectronScreenSources(type?: QNElectronScreenSourceType): Promise<QNElectronScreenSource[]>
Electron 环境下枚举屏幕共享源

Parameters
- type: QNElectronScreenSourceType
  
  屏幕共享类型选择
Returns Promise<QNElectronScreenSource[]>

createDeviceManger

createDeviceManger(): QNDeviceManager
创建设备管理类

Returns QNDeviceManager

以上内容是否对您有帮助？