概述

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

RTC Flutter SDK 能够帮助您实现登录音视频通信房间并开始通信，当前可支持Android/ iOS接入。

接口概览

RTC Flutter SDK 提供以下接口。

初始化接口

API	描述
getInstance	静态方法，获取Future<BaiduRtcCloud?> 实例
destroyInstance	静态方法，销毁Future<BaiduRtcCloud?> 实例
registerListener	注册监听器，用于事件回调
unRegisterListener	取消注册监听器

 

房间相关接口

API	描述
loginBRtcRoom	登录房间
logoutRtcRoom	登出房间
setParamSettings	设置房间参数
startRoomMediaRelay	启动跨房间通信
stopRoomMediaRelay	停止跨房间通信
stopRoomMediaRelayAll	停止所有跨房间通信
disbandRoom	解散房间
kickOffUserWithId	踢出某成员
shutUpUserWithId	禁言某成员
unShutUpUserWithId	解除禁言成员

 

发布/订阅流相关接口

API	描述
startPublish	开始实时音视频推流
stopPublish	停止实时音视频推流
subscribeStreaming	订阅某成员媒体流
subscribeStreamingWithViewId	订阅实时音视频流，同时绑定View用于渲染
stopSubscribeStreaming	停止订阅某成员媒体流

 

消息相关接口

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

 

视频相关接口

API	描述
startPreview	开启本地预览
stopPreview	停止本地预览
setLocalDisplay	设置本地渲染窗口
setRemoteDisplay	设置远端渲染窗口
setRemoteDisplayWithUserId	设置远端渲染窗口，同时绑定UserId，BRTCVideoViewController类控制
updateDisplay	更新远端渲染窗口，BRTCVideoViewController类控制
removeRemoteDisplay	移除远端用户渲染窗口
changeSurfaceSize	更新外部渲染Surface尺寸，BRTCVideoViewController类控制
setRemoteVideoPlayState	设置是否拉取某成员视频流

 

摄像头相关接口

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

 

音频相关接口

API	描述
muteMicphone	设置是否静音采集麦克风数据（不关闭麦克风）
enableMicCapture	设置是否使用麦克风采集音频（关闭麦克风）
switchLoundSpeaker	切换扬声器/听筒
presetLoudSpeaker	预置听筒/扬声器
muteSpeaker	禁止/开启音频输出
setUserPlaybackVolume	设置远端用户音频播放音量
isSpeakerOn	查询扬声器是否开启
setSoundMod	设置音频输出设备
enableAgc	开启默认音频自动增益
enableAns	开启默认音频自动噪声抑制
enableAec	开启默认音频回声消除
enableAudioMix	开启/关闭 音频混音

 

通知相关接口

API	描述
onRoomEventUpdate	房间事件更新回调
onPeerConnectStateUpdate	连接状态更新回调
onStreamInfoUpdate	媒体流信息更新回调
onErrorInfoUpdate	错误信息更新回调
onRoomDataMessage	房间数据接收回调

 

其它接口

API	描述
setVerbose	开启/关闭调试信息输出
enableErrorInfoToServer	开启/关闭错误数据上报
enableStatsToServer	开启/关闭质量数据上报