概述

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

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

接口概览

RTC iOS SDK 提供以下接口

初始化接口

API	描述
initSDKWithAppID	初始化SDK
setBaiduRtcRoomDelegate	设置RTC回调代理
setParamSettings	设置媒体参数
getParamSettings	获取媒体参数
setEngineStateStatistics	开启/关闭引擎统计信息

 

房间相关接口

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

 

发布/订阅流相关接口

API	描述
startLiveServerStreaming	开始直播推流
stopLiveServerStreaming	停止直播推流
publishStreaming	发布媒体流
stopPublishStreaming	停止发布媒体流
subsribeStreaming	订阅某成员媒体流
stopSubscribeStreaming	停止订阅某成员媒体流

 

消息相关接口

API	描述
sendMessage	广播消息（数据通道）
sendMessage2	广播消息（信令通道）
sendMessage2WithUserId	向某成员发送消息
setUserAttribute	设置用户属性
getUserAttribute	获取用户属性

 

视频相关接口

API	描述
setVideoCaptureFactory	设置本地视频采集器
setRenderDelegate	设置外部渲染回调对象
startPreview	开启本地预览
stopPreview	停止本地预览
setLocalDisplay	设置本地渲染窗口
setRemoteDisplay	设置远端渲染窗口
setRemoteDisplay: userId:	设置指定远端用户渲染窗口
updateDisplay: userId:	更新远端用户渲染窗口
setRemoteVideoPlayState	设置是否拉取某成员视频流

 

摄像头相关接口

API	描述
switchCamera	切换摄像头
muteCamera	关闭摄像头
muteCamera:	关闭/开启本地视频采集
setCameraFace	设置前后摄像头
cameraFocusWithPoint	设置摄像头对焦

 

音频相关接口

API	描述
setAudioRecordDelegate	设置音频录制回调对象
setAudioSessionDelegate	设置音频会话代理对象
setAudioExternalDeviceDelegate	设置音频外部采集代理对象
muteMicphone	关闭音频采集
enableLocalAudio:	关闭/开启本地音频采集
muteSpeaker:	关闭/开启扬声器
muteMicphone:	关闭/开启音频采集
switchLoundSpeaker	切换扬声器/听筒
switchAudioCategaryWithSpeaker:	切换扬声器/听筒
presetLoudSpeaker	预置听筒/扬声器
getRemoteAudioLevels	获取房间成员语音激励列表
setAudioSessionMode	设置音频会话模式
enableAgc	开启默认音频自动增益
enableAns	开启默认音频自动噪声抑制
setSoundMode	设置音频输出设备
setRemoteAudioPlayState	设置是否拉取某成员音频流
setRemoteAudioPlayVolume	设置远端用户音频播放音量

 

转推配置相关接口

API	描述
configLiveServerWithUrl	配置媒体转推参数

 

通知相关接口

API	描述
onLoinSuccess	登录成功回调
onError	错误信息更新回调
onConnectionStateChanged	链接状态变更
onEngineStatisticsInfo	开启/关闭引擎统计信息
onTextMessageArrival	消息通知（信令通道）
onTextMessageArrival2	消息通知（数据通道）
onTextMessageAttribute	接收到获取用户属性回调

 

其他接口

API	描述
version	获取SDK版本号
setVerbose	开启/关闭调试信息输出
queryEngineStatisticsInfo	查询RTC统计信息
enableStatsToServer	开启/关闭RTC质量监控数据上报
enableErrorInfoReprot	开启/关闭RTC异常信息上报