概述

本文档主要介绍如何将RTC Andriod SDK集成到您的项目中，并介绍各类功能的使用方法。在使用本文档前，您需要先了解RTC的一些基本知识，并已经开通了RTC服务。若您还不了解RTC，可以参考产品描述。

RTC Andriod SDK 能够帮助您实现登录音视频通信房间并开始通信，并可以对发布/订阅、音视频参数、设备参数进行设置。

接口概览

RTC Android SDK提供以下接口。

初始化接口

API	描述
initWithAppID	初始化SDK
setParamSettings	设置媒体参数
setAudioProfile	设置音频编码配置
setBaiduRtcEventHandler	设置回调代理
setEngineStateStatistics	开启/关闭引擎统计信息

房间相关接口

API	描述
loginRtcRoomWithRoomName	登录房间
loginRtcRoomWithRoomName:isCompulsive	强制登录房间
logoutRtcRoom	登出房间
startRoomMediaRelay	启动跨房间通信
stopRoomMediaRelay	停止跨房间通信
stopRoomMediaRelayAll	停止所有跨房间通信
disbandRoom	解散房间
kickOffUserWithId	踢出某成员
shutUpUserWithId	禁言某成员
queryUserListOfRoom	获取房间成员ID列表

 

发布/订阅流相关接口

API	描述
startPublish	开始直播推流
stopPublish	停止直播推流
publishStreaming	发布媒体流
stopPublish	停止直播推流
subscribeStreaming	订阅某成员媒体流
stopSubscribeStreaming	停止订阅某成员媒体流

 

消息相关接口

API	描述
sendMessageToUser	向某成员发送消息
setUserAttribute	设置用户属性
getUserAttribute	获取用户属性
sendDataMessage	发送数据

 

视频相关接口

API	描述
startPreview	开启本地预览
stopPreview	停止本地预览
setLocalDisplay	设置本地渲染窗口
setRemoteDisplay	设置远端渲染窗口
removeRemoteDisplay	移除远端用户渲染窗口
enableExternalVideoCapturer	设置本地视频采集器
addExternalRenderer	设置某成员外部渲染器
removeExternalRenderer	移除某成员外部渲染器
setExternalSurface	设置某成员外部渲染Surface
changeSurfaceSize	更新外部渲染Surface尺寸
destroyExternalSurface	销毁指定用户对应的外部渲染surface
setRemoteVideoPlayState	设置是否拉取某成员视频流
getRemoteVideoDimension	获取远端视频尺寸

 

摄像头相关接口

API	描述
switchCamera	切换摄像头
muteCamera	关闭/开启本地视频采集
setCameraID	设置摄像头ID

 

音频相关接口

API	描述
muteMicphone	设置是否静音采集麦克风数据（不关闭麦克风）
enableMicCapture	设置是否使用麦克风采集音频（关闭麦克风）
switchLoundSpeaker	切换扬声器/听筒
presetLoudSpeaker	预置听筒/扬声器
muteSpeaker	禁止/开启音频输出
setUserPlaybackVolume	设置远端用户音频播放音量
isSpeakerOn	查询扬声器是否开启
getRemoteAudioLevels	获取房间成员语音激励列表
setRemoteAudioPlayState	设置是否拉取某成员音频流
setSoundMod	设置音频输出设备
setAuidoSamplesReadyCallback	设置本地音频数据回调
enableAgc	开启默认音频自动增益
enableAns	开启默认音频自动噪声抑制
enableAec	开启默认音频回声消除

 

转推配置相关接口

API	描述
configLiveServerWithUrl	转推配置接口

 

通知相关接口

API	描述
onLoginSuccess	用户登录成功
onError	错误信息更新回调
onConnectionStateChanged	链接状态变更
onRoomDataMessage	房间数据接收回调

 

其它接口

API	描述
version	获取SDK版本
setVerbose	开启/关闭调试信息输出
enableStatsToServer	开启/关闭质量数据上报