QNRTC
- configRTC
- createAudioEffectMixer
- createAudioMusicMixer
- createCameraVideoTrack
- createClient
- createMicrophoneAudioTrack
- createScreenVideoTrack
- deinit
- enableFileLogging
- init
- isScreenCaptureSupported
- off
- on
- requestPermission
- setAudioRouteToSpeakerphone
- setAudioScene
- setLogConfig
- setSpeakerphoneMuted
- uploadLog
- configRTC(config: QNRTCConfiguration): void
-
初始化 SDK
必须在使用其它接口前调用
Parameters-
config: QNRTCConfiguration
初始化配置项
Returns void -
- createAudioEffectMixer(): QNAudioEffectMixer
-
创建音效混音控制器对象
音效混音支持同时混合多路音效文件
Returns QNAudioEffectMixer
- createAudioMusicMixer(url: string): QNAudioMusicMixer
-
创建背景音乐混音控制器对象
仅支持在线文件,支持的文件格式为:aac、mp3、mp4、ogg、opus、wav、m4a、flac 1.背景音乐混音仅支持同时混合一路背景音乐,若需要切换背景音乐,重新调用本接口创建 {@link QNAudioMusicMixer} 即可 2.建议使用本地文件进行混音,以避免网络环境差引起的混音异常 3.若您希望在混合背景音乐的同时添加音效,可参考音效混音相关接口({@link QNAudioEffectMixer})
Parameters-
url: string
音频文件路径
Returns QNAudioMusicMixer -
- createCameraVideoTrack(config: QNCameraVideoTrackConfig): QNCameraVideoTrack
-
创建摄像头视频轨
默认 tag 为 ""
Parameters-
config: QNCameraVideoTrackConfig
摄像头 Track 的配置,可设置视频的采集配置、编码配置等
Returns QNCameraVideoTrack -
- createClient(config: QNClientConfig): QNRTCClient
-
创建 QNRTCClient 对象
全局只可存在一个
Parameters-
config: QNClientConfig
Returns QNRTCClient -
- createMicrophoneAudioTrack(config: QNMicrophoneAudioTrackConfig): QNMicrophoneAudioTrack
-
创建麦克风音频轨
默认 tag 为 ""
Parameters-
config: QNMicrophoneAudioTrackConfig
采集音频的配置,可指定音频质量等级与开关通讯模式
Returns QNMicrophoneAudioTrack -
- createScreenVideoTrack(config: QNScreenVideoTrackConfig): QNScreenVideoTrack
-
创建屏幕录制轨
默认 tag 为 ""
Parameters-
config: QNScreenVideoTrackConfig
屏幕录制 Track 的配置,可设置视频的编码配置与开关大小流功能
Returns QNScreenVideoTrack -
- deinit(): void
-
反初始化操作
在确认不再使用实时音视频后调用此接口释放其占用的资源,此后如果再使用需要再次调用 configRTC 方法
Returns void
- enableFileLogging(): void
-
设置是否开启本地日志保存
设置是否开启本地日志保存
Returns void
- init(config: QNRTCConfiguration): void
-
初始化 SDK
必须在使用其它接口前调用
Parameters-
config: QNRTCConfiguration
初始化配置项
Returns void -
- isScreenCaptureSupported(): number
-
判断屏幕录制功能是否可用
建议创建 QNScreenVideoTrack 前先调用次接口确认是否支持录屏
Returns number
- off(name: event, listener: QNRTCEngineEvent[event]): void
-
取消监听对应的事件
Parameters-
name: event
事件名
-
listener: QNRTCEngineEvent[event]
事件句柄
Returns void -
- on(name: event, listener: QNRTCEngineEvent[event]): void
-
监听对应的事件
支持多次调用同一事件
Parameters-
name: event
事件名
-
listener: QNRTCEngineEvent[event]
事件句柄
Returns void -
- requestPermission(callback: QNScreenPermissionResultCallback): void
-
请求录屏权限
只支持安卓,创建 QNScreenVideoTrack 前安卓需要调用此接口获取对应权限
Parameters-
callback: QNScreenPermissionResultCallback
请求录屏权限后回调
Returns void -
- setAudioRouteToSpeakerphone(audioRouteToSpeakerphone: boolean): void
-
音频路由切换
设置是否将音频路由切换到扬声器,默认音频路由为扬声器
Parameters-
audioRouteToSpeakerphone: boolean
初始化配置项
Returns void -
- setAudioScene(audioScene: QNAudioScene): void
-
切换音频场景
音频场景包括 DEFAULT、VOICE_CHAT 和 SOUND_EQUALIZE 三种,不同场景下,设备的音量类型存在差异,其中: 1. DEFAULT 场景会根据发布和订阅的情况自动切换音频模式,仅发布或仅订阅时,SDK 使用媒体模式;同时发布和订阅时,SDK 将自动切换到通话模式 2. VOICE_CHAT 场景恒定使用通话模式,调节的音量类型为通话音量 3. SOUND_EQUALIZE 场景恒定使用媒体模式,调节的音量类型为媒体音量 4. 佩戴蓝牙耳机的场景,将恒定使用通话模式,在蓝牙通话过程中修改的音频场景将会在蓝牙连接断开后生效 5. 佩戴有线耳机的场景,将恒定使用媒体模式,在通话过程中修改的音频场景将会在耳机拔出后生效
Parameters-
audioScene: QNAudioScene
Returns void -
- setLogConfig(): void
-
设置日志
Returns void
- setSpeakerphoneMuted(muted: boolean): void
-
设置是否静音扬声器
静音后将听不到远端用户的声音。默认为 false
Parameters-
muted: boolean
是否静音扬声器
Returns void -
- uploadLog(): void
-
上传日志
Returns void