模块列表
为了方便理解和使用,对于 SDK 的接口设计,我们遵循了如下每一个连麦接口类,均以 QN 开头。
核心接口类
| 接口类名 | 功能 | 备注 |
|---|---|---|
| QNRTCEnv | 初始化连麦相关资源 | 初始化连麦相关资源 |
| QNRTCEngine | 提供连麦的各种接口 | 提供连麦的各种接口 |
| QNAudioDevice | 声音输出设备枚举 | 声音输出设备枚举 |
| QNMergeJob | 合流任务状态 | 合流任务状态 |
| QNStretchMode | 合流填充模式枚举 | 合流填充模式枚举 |
| QNMergeTrackOption | Track 合流设置 | Track 合流设置 |
| QNWatermark | 水印设置 | 水印设置相关 |
| QNBeautySetting | 美颜设置 | 美颜设置相关 |
| QNLogLevel | 日志等级枚举 | 日志等级枚举 |
| QNRTCSetting | 连麦配置相关 | 连麦配置相关 |
| QNRTCUser | 用户信息类 | 用户信息相关 |
| QNSourceType | Track 资源类型枚举 | Track 资源类型枚举 |
| QNTrackInfo | Track 信息相关 | Track 信息相关 |
| QNTrackInfoBuilder | TrackInfo 的构造类 | TrackInfo 的构造类 |
| QNTrackKind | Track 类别枚举 | Track 类别枚举 |
| QNVideoFormat | 视频编码格式信息 | 视频编码格式信息 |
| QNVideoFrame | 视频帧信息 | 视频帧信息 |
| QNScreenCaptureUtil | 屏幕采集工具类 | 屏幕采集相关 |
| QNAudioMixingManager | 音乐混音控制类 | 音乐混音控制相关 |
| QNUtil | 内部工具类 | SDK 提供的相关工具类,可用于截帧功能 |
回调相关接口类
| 接口类名 | 功能 | 备注 |
|---|---|---|
| QNRTCEngineEventListener | 提供连麦相关的所有回调 | 包括但不限于远端连麦者加入(离开)房间、发布(取消发布)音视频以及连麦状态等回调 |
| QNCameraSwitchResultCallback | 提供了切换摄像头的结果回调 | 包括了切换摄像头的结果回调 |
| QNCaptureVideoCallback | 提供了预览画面的数据回调 | 可用来对接外部第三方美颜或者滤镜 |
| QNAudioSourceCallback | 提供了音频数据回调 | 可用于对音频数据进行处理 |
| QNMicrophoneAudioSourceCallback | 麦克风音频回调 | 混音时原麦克风数据回调 |
| QNRemoteAudioCallback | 提供了远端音频数据回调 | 可用于对音频数据进行处理 |
| QNRenderVideoCallback | 提供了在渲染视频帧前回调视频数据 | 可用来对接外部第三方美颜或者滤镜 |
| QNStatisticsReport | 提供了连麦过程中的统计信息 | 包括但不限于连麦过程中实时的音视频码率、帧率等回调信息 |
| QNAudioMixingListener | 提供了混音过程中的状态回调 | 可用来监听音乐混音的状态变化 |
| QNRoomState | 定义了房间的状态信息 | 包括但不限于重连以及断开连接等状态 |
| QNErrorCode | 定义了连麦过程中的错误信息 | 包括但不限于 token 错误、房间不存在等错误信息,详见错误代码 |