跳到主要内容

接口概览

全局接口

函数名描述
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::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接收截图事件结果回调