文档使用 API 汇总
更新时间：2021-05-26
基础功能
此分类下主要包括 初始化SDK 和 基本音视频通信 的方法，适用于语音通话、视频通话、语音/视频直播等应用场景。
初始化
| 方法名 | 说明 |
|---|---|
| sharedInstance | 获取 LVRTCEngine 单例 |
| initSdk | 使用 SDK 前请先初始化 SDK |
| unInitSDK | 卸载SDK，资源释放 |
| setISOCountryCode | 设置国家码，SDK 辅助信息，可以不传 |
| setLogLevel: | 设置日志级别 |
| setUseTestEnv: | 设置是否使用测试环境 |
| setUseInternationalEnv: | 是否使用国际版本（SDK 默认使用中国版本，国内用户请不要调用） |
| setDebugServerIp: | 设置调试服务 IP，可以不传 |
| setDecoderPixelType: | 设置解码像素格式 |
| setEncoderPixelType: | 设置编码像素格式，预先设置时可提高视频首次编码速度 |
鉴权、登录和登出
| 方法名 | 说明 |
|---|---|
| auth:skStr:userId:completion | SDK 鉴权接口，使用 SDK 时必须确保鉴权成功才能使用 |
| loginRoom:roomId:isHost:isOnlyAudio:delegate | 登录房间接口，推流、连麦、拉流之前需要先登录房间，同时为RTC引擎设置代理回调 |
| logoutRoom: | 登出房间、清理资源 |
推流相关
| 方法名 | 说明 |
|---|---|
| startPublishing | 开始推流，观众也可以调用该接口和主播进行连麦，注意该接口需要配合 startCapture 来使用 |
| stopPublishing | 停止推流 |
| startCapture | 开始视频采集 |
| stopCapture | 停止视频采集 |
| addDisplayView: | 为特定用户设置预览视图 |
| enableMic: | 打开和关闭麦克风 |
| switchCamera: | 切换摄像头 |
| enableVideoAutoRotation: | 是否打开视频方向随设备方向自动变化，默认打开 |
| setOutputVideoRotation: | 设置视频输出方向，需要将自动旋转方向关闭才能生效 |
| setAVConfig | 设置视频采集、编码参数 |
| getAVConfig | 获取视频采集、编码参数 |
| setPublishQualityMonitorCycle | 设置推流质量信息统计回调频率 |
拉流相关
| 方法名 | 说明 |
|---|---|
| startPlayingStream: | 开始拉流 |
| stopPlayingStream: | 停止拉流 |
| enableSpeakerphone: | 打开和关闭扬声器 |
| setAudioRecordFlag: | 设置音频数据回调方式 |
| startSoundLevelMonitor: | 开启音量变化的监听 |
| stopSoundLevelMonitor | 停止音量变化的监听 |
| getSoundLevelByUserId: | 获取用户音量数据 |
| setPlayQualityMonitorCycle: | 设置拉流质量信息统计回调频率 |
版本
| 方法名 | 说明 |
|---|---|
| versionNumber | 获取 SDK 版本号 |
| versionName | 获取 SDK build 版本号 |
| buildVersion | 获取 SDK 编译版本号 |
进阶功能
混音
| 方法名 | 说明 |
|---|---|
| startAudioMixing:mode:loop | 开启混音、并设置混音和循环播放模式 |
| setAudioMixingMode: | 动态调整混音模式 |
| stopAudioMixing | 停止混音 |
| pauseAudioMixing | 暂停混音 |
| resumeAudioMixing | 恢复混音 |
| getAudioMixingVolume | 获取混音音量 |
| adjustAudioMixingVolume | 调整混音音量 |
| getAudioMixingTotalLength | 获取当前伴奏文件总时长，单位毫秒。请在房间内调用该方法 |
| getAudioMixingCurrentPosition | 获取音乐文件的播放进度，单位毫秒。请在房间内调用该方法 |
| setAudioMixingPosition | 设置音乐文件的播放位置，请在房间内调用该方法。 |
外置音视频采集
本组方法为开发者提供自定义视频采集源的功能，适用于直播场景。
| 方法名 | 说明 |
|---|---|
| enableExternalAudioInput | 打开和关闭外置音频采集功能 |
| setExternalAudioConfig: | 设置外置音频采集参数 |
| getExternalAudioConfig | 获取外部音频采集参数 |
| sendAudioFrame:length | 发送外置音频数据 |
| sendVideoFrame: | 发送外置视频数据 |
| sendVideoFrame:sei: | 发送外置视频数据并携带附加信息 |
视频混流
| 方法名 | 说明 |
|---|---|
| mixStream: | 开始混流并设置混流参数 |
| stopMixStream | 停止混流 |
场景功能
房间内连麦，跨房间PK
| 方法名 | 说明 |
|---|---|
| linkRoom: | 开始房间 PK，已废弃 |
| unlinkRoom: | 取消房间 PK 已废弃 |
| linkRoom:linkUserId: | 开始房间 PK |
| unlinkRoom:unlinkUserId: | 取消房间 PK |
预览视图设置（本地视图和远端视图）
| 方法名 | 说明 |
|---|---|
| addDisplayView: | 添加预览视图 |
| removeDisplayView: | 移除预览视图 |
房间内事件回调
| 方法名 | 说明 |
|---|---|
| OnRoomReconnected | 房间重连成功 |
| OnEnterRoomComplete:users | 进入房间成功 |
| OnExitRoomComplete | 退出房间成功 |
| OnRoomDisconnected: | 房间断开的通知，网络异常时 SDK 会自动进行重连 |
| OnAddRemoter: | 有成员加入的通知 |
| OnDeleteRemoter: | 有成员离开的通知 |
| OnMixComplete: | 远端混流完成的回调，用户可以通过调用混流方法在远端进行音视频混流，参考 mixStream |
| OnAudioData:audio_data:bits_per_sample:sample_rate:number_of_channels:number_of_frames | 单路音频流回调 |
| OnAudioMixStream:samples:nchannel:flag | 混音录音数据回调，该方法需要打开录音功能才会触发回调 setAudioRecordFlag: |
| OnPublishQualityUpdate: | 推流质量变化的通知 |
| OnPlayQualityUpate:userId: | 拉流质量变化的通知 |
| OnPublishStateUpdate: | 推流状态变更的通知 |
| OnPlayStateUpdate:userId: | 拉流状态变化的通知 |
| OnAudioVolumeUpdate: | 远端用户音量变化的通知 |
| OnMediaSideInfoInPublishVideoFrame: | 是否需要在视频帧上附加其他媒体信息 |
| OnDrawFrame:uid:sei | 收到远端视频数据回调，如果为 SDK 设置了渲染视图，SDK 内部会自动将视频帧渲染出来 |
| OnKickOff | 用户被踢出房间 |
| OnCaptureVideoFrame: | 当前采集视频数据回调，调用 startCapture 会触发此方法 |
| AudioMixerCurrentPlayingTime | 当前混音器播放进度时间回调 |
| AudioMixerPlayerDidFinished | 当前混音器播放结束回调 |