接口概览

全局接口

函数名	描述
init	库初始化
release	库销毁
createRtcInstance	创建RTC客户端实例
destroyRtcInstance	销毁RTC客户端实例
getDeviceManager	获取设备管理器类实例
getVersion	获取版本号

注册相关接口

函数名	描述
RtcClient::login	登录
RtcClient::logout	登出

房间相关接口

函数名	描述
RtcClient::joinRoom	加入房间
RtcClient::leaveRoom	离开房间
RtcClient::replyCall	响应平台呼叫

发布订阅相关接口

函数名	描述
RtcClient::publishMainVideoStream	发布视频主流
RtcClient::publishDualVideoStream	发布视频辅流
RtcClient::publishAudioStream	发布音频流
RtcClient::unpublishStream	取消发布流
RtcClient::subscribeStream	订阅码流
RtcClient::unsubscribeStream	取消订阅流
RtcClient::pausePublishStream	暂停/恢复发布流
RtcClient::pauseSubscribeStream	暂停/恢复订阅流
RtcClient::updateStreamLayer	设置优选分辨率
RtcClient::snapshotVideo	视频画面截图
RtcClient::setAudioControlPlayoutMute	设置终端静音状态
RtcClient::setAudioControlRecordMute	设置终端哑音状态

视频相关接口

函数名	描述
RtcClient::startLocalPreview	启用本地图像预览
RtcClient::stopLocalPreview	停用本地图像预览
RtcClient::setMirrorMode	设置预览图像时镜像模式

设备管理相关接口

函数名	描述
RtcDeviceManager::getDeviceList	获取设备（麦克风、扬声器、摄像头）列表
RtcDeviceManager::setCurrentDevice	设置当前设备
RtcDeviceManager::getCurrentDevice	获取当前设备
RtcDeviceManager::switchCamera	切换前后摄像头
RtcDeviceManager::isFrontCamera	判断当前置摄像头是否为前置摄像头
RtcDeviceManager::startCameraDeviceTest	开始摄像头测试
RtcDeviceManager::stopCameraDeviceTest	停止摄像头测试
RtcDeviceManager::setCameraOrientation	设置摄像头装配方向
RtcDeviceManager::startMicDeviceTest	开始麦克风测试
RtcDeviceManager::stopMicDeviceTest	停止麦克风测试

高级自定义接口

函数名	描述
RtcClient::setMainVideoStreamParam	自定义主视频流参数
RtcClient::setDualVideoStreamParam	自定义辅视频流参数
RtcClient::sendVideoFrameData	发送自定义视频采集数据
RtcClient::sendEncodedVideoData	发送自定义视频编码数据
RtcClient::requestKeyFrame	请求视频流关键帧
RtcClient::sendAudioFrameData	发送自定义音频采集数据
RtcClient::enableLocalAudioCallback	启用音频采集数据回调
RtcClient::enableRemoteAudioCallback	启用远端混音前音频数据回调
RtcClient::enableRemoteMixedAudioCallback	启用远端混音后音频数据回调
RtcClient::setAudioDeviceCapability	设置音频设备能力

事件回调

函数名	描述
KRtcCallback::onWarning	警告事件
KRtcCallback::onError	错误事件
KRtcCallback::onRelease	库释放成功回调
KRtcCallback::onLogin	登录成功回调
KRtcCallback::onLogout	登出成功回调
KRtcCallback::onJoinRoom	加入房间成功回调
KRtcCallback::onLeaveRoom	离开房间回调
KRtcCallback::onIncomingCall	收到平台呼叫回调
KRtcCallback::onCancelCall	平台取消呼叫回调
KRtcCallback::onReplyCall	响应平台呼叫回调
KRtcCallback::onPublishStream	发布流成功回调
KRtcCallback::onSubscribeStream	订阅流成功回调
KRtcCallback::onUnpublishStream	取消发布流成功回调
KRtcCallback::onUnsubscribeStream	取消订阅流成功回调
KRtcCallback::onPausePublishStream	暂停发布流成功回调
KRtcCallback::onPauseSubscribeStream	暂停订阅流成功回调
KRtcCallback::onAudioLevelIndication	本地音频能量回调
KRtcCallback::onRemoteUserJoinRoom	其他用户加入房间通知
KRtcCallback::onRemoteUserLeaveRoom	其他用户离开房间通知
KRtcCallback::onRemoteUserPublishStream	其他用户发布流通知
KRtcCallback::onRemoteUserUnPublishStream	其他用户取消发布流通知
KRtcCallback::onRecommendEncodingParam	推荐编码参数回调
KRtcCallback::onLocalStatistics	本地统计信息
KRtcCallback::onLocalVideoStatistics	本地发送视频流状态信息
KRtcCallback::onLocalAudioStatistics	本地发送音频流状态信息
KRtcCallback::onRemoteVideoStatistics	本地接收视频流状态信息
KRtcCallback::onRemoteAudioStatistics	本地接收音频流状态信息
KRtcCallback::onLocalAudioFrame	本地音频采集数据回调
KRtcCallback::onRemoteAudioFrame	远端混音前音频数据回调
KRtcCallback::onRemoteMixedAudioFrame	远端混音后音频数据回调
KRtcCallback::onSnapshotVideo	接收截图事件结果回调
KRtcCallback::onAudioControlPlayoutMute	用于接收静音事件的回调
KRtcCallback::onAudioControlRecordMute	用于接收哑音事件的回调