文档使用 API 汇总
更新时间：2021-05-26
基础功能
此分类下主要包括 初始化 SDK 和 基本音视频通信 的方法，适用于语音通话、视频通话、语音/视频直播等应用场景
初始化
| 方法名 | 说明 |
|---|---|
| getInstance | 获取 LVRTCEngine 单例 |
| initSDK | 初始化SDK，使用 SDK 前请先初始化 SDK |
| unInitSDK | 卸载SDK，资源释放 |
| setISOCountryCode | 设置国家码，SDK 辅助信息，可以不传 |
| setLogLevel | 设置日志级别 |
| setUseTestEnv | 设置是否使用测试环境 |
| setUseInternationalEnv | 是否使用国际服务器环境（默认使用中国环境） |
| setDebugServerIp | 设置调试服务 url，可以不传 |
| setLiveRoomCallback | 设置引擎回调 |
鉴权、登录和登出
| 方法名 | 说明 |
|---|---|
| auth | SDK 鉴权，使用 SDK 时必须确保鉴权成功才能使用 |
| loginRoom | 登录房间接口，发布资源、连麦、开始播放视频流之前需要先登录房间，同时为 RTC 引擎设置监听回调 |
| logoutRoom | 登出房间、清理资源 |
推流和推流参数设置
| 方法名 | 说明 |
|---|---|
| startPublishing | 开始推流 |
| stopPublishing | 停止推流 |
| startCapture | 开始视频采集 |
| stopCapture | 停止视频采集 |
| addDisplayView | 为特定用户设置预览视图 |
| enableMic | 设置推流是否静音 |
| switchCamera | 切换摄像头 |
| enableVideoAutoRotation | 设置是否允许 SDK 自动根据设备的方向调整视频的输出方向，默认是true |
| setOutputVideoRotation | 设置视频输出方向，需要将自动旋转方向关闭才能生效 |
| setAVConfig | 设置Video采集、编码推流等参数 |
| getAVConfig | 获取Video采集、编码、推流等参数配置 |
| setVideoEncoderMode | 设置视频编码器模式 |
| setLVRenderCallback | 设置视频渲染回调 |
| setPublishQualityMonitorCycle | 设置推流质量信息统计回调频率 |
拉流和播放、停止拉流
| 方法名 | 说明 |
|---|---|
| startPlayingStream | 开始拉流 |
| stopPlayingStream | 停止拉流 |
| enableSpeakerphone | 打开和关闭扬声器 |
| isSpeakerphoneOn | 扬声器是否开启 |
| setAudioRecordFlag | 设置音频录制模式，可同时设置多种录制模式 |
| startSoundLevelMonitor | 开启音量变化通知 |
| stopSoundLevelMonitor | 停止音量变化的监听 |
| getSoundLevelByUserId | 获取用户音量大小 |
| setVideoDecoderMode | 设置视频解码器模式 |
| setPlayQualityMonitorCycle | 设置拉流质量信息统计回调频率 |
| setPlayVolume | 控制远端音频流音量, 加入房间成功后调用 |
| setPlayVolume | 控制所有远端音频流音量, 加入房间成功后调用 |
版本
| 方法名 | 说明 |
|---|---|
| versionNumber | 获取 SDK 主版本号 |
| versionName | 获取 SDK 主版本名称 |
| buildVersion | 获取 SDK 编译版本号 |
进阶功能
混音功能
| 方法名 | 说明 |
|---|---|
| startAudioMixing | 开始播放音乐文件及混音 |
| stopAudioMixing | 停止播放音乐文件及混音 |
| pauseAudioMixing | 暂停播放音乐文件及混音 |
| resumeAudioMixing | 恢复播放音乐文件及混音 |
| getAudioMixingVolume | 获取当前伴奏音量 |
| adjustAudioMixingVolume | 调节音乐文件的播放音量 |
| getAudioMixingTotalLength | 获取当前伴奏文件总时长，单位毫秒。请在房间内调用该方法 |
| getAudioMixingCurrentPosition | 获取音乐文件的播放进度。单位毫秒。请在房间内调用该方法。 |
| setAudioMixingPosition | 设置音乐文件的播放位置。请在房间内调用该方法。 |
外置音视频采集
本组方法为开发者提供自定义视频采集源的功能，适用于直播场景。
| 方法名 | 说明 |
|---|---|
| enableExternalAudioInput | 打开或关闭外置音频采集 |
| setExternalAudioConfig | 设置外置音频采集参数 |
| getExternalAudioConfig | 获取外部音频采集参数配置 |
| sendAudioFrame | 发送外置音频数据 |
| sendVideoFrame | 发送外置视频数据，外部输入byte格式视频数据，目前只支持I420格式 |
| sendVideoFrame | 发送外置视频数据，外部输入texture格式视频数据 |
音视频混流
| 方法名 | 说明 |
|---|---|
| mixStream | 开始服务端混流 |
| stopMixStream | 停止服务端混流 |
场景功能
房间 PK，跨房间连麦
| 方法名 | 说明 |
|---|---|
| linkRoom | 跨房间连麦 |
| unlinkRoom | 取消跨房间连麦 |
视频显示视图设置(本地视频视图和远端视频视图)
| 方法名 | 说明 |
|---|---|
| addDisplayView | 设置视频显示视图 |
| removeDisplayView | 移除显示视图 |
| removeDisplayView | 根据uid移除显示视图 |
房间内事件
| 方法名 | 说明 |
|---|---|
| onRoomReconnected | 房间重连成功 |
| onRoomDisconnected | 房间断开的通知，网络异常时 SDK 会自动进行重连 |
| onAddRemoter | 有成员加入的通知 |
| onDeleteRemoter | 有成员离开的通知 |
| onMixComplete | 远端混流完成的回调，用户可以通过调用混流方法在远端进行音视频混流，参考 mixStream |
| onAudioMixStream | 混音录音数据回调，该方法需要打开录音功能才会触发回调 setAudioRecordFlag: |
| onPublishQualityUpdate | 发布资源质量状态变化的通知 |
| onPlayQualityUpdate | 播放质量变化的通知 |
| onPublishStateUpdate | 发布资源状态变更的通知 |
| onPlayStateUpdate | 播放状态变化的通知 |
| onAudioVolumeUpdate | 音量变化回调 |
| onMediaSideInfoInPublishVideoFrame | 是否需要在视频帧上附加其他媒体信息 |
| onDrawFrame | 收到远端视频数据回调，如果为 SDK 设置了渲染视图，SDK 内部会自动将该视频帧渲染出来 |
| onExitRoomComplete | 房间退出成功回调 |
| onKickOff | 用户被踢出房间 |