初始化接口

获取SDK实例

static Future<BaiduRtcCloud?> getInstance(BRTCInitParams params);

静态方法，获取BaiduRtcCloud 实例。

参数

BRTCInitParams 结构

返回

BaiduRtcCloud 实例对象

销毁SDK实例

static Future<void> destroyInstance();

静态方法，销毁BaiduRtcCloud 实例。

参数

无

返回

Void

注册监听器

void registerListener(ListenerValue func);

注册事件回调。

参数

ListenerValue 结构

void Function(BaiduRTCRoomDelegate type, int event, P? params);

BaiduRTCRoomDelegate 结构

enum BaiduRTCRoomDelegate {
    onRoomEventUpdate,
    onPeerConnectStateUpdate,
    onStreamInfoUpdate,
    onErrorInfoUpdate,
    onEngineStatisticsInfo,
    onRoomDataMessage,
}

BaiduRTCRoomDelegate 通知回调描述，查看通知相关接口

返回

Void

取消注册监听器

void unRegisterListener(ListenerValue func);

取消注册事件回调。

参数

返回

Void

房间相关接口

登录房间

 Future<bool?> loginBRtcRoom(BRTCLoginParams params);

登录房间。

登录成功后同一个房间的的成员能够互相看到和听到。

参数

BRTCLoginParams结构

返回

true 成功，false 失败

注意

如果失败，会通过错误信息更新回调返回错误信息。

登出房间

Future<bool?> logoutRtcRoom();

退出房间。

执行logoutRtcRoom后，会停止音视频采集，断开与房间服务器的连接，取消音视频的传输，销毁音视频传输通道以及释放其他资源。

返回

true 成功，false 失败

设置媒体参数

 Future<void> setParamSettings(BRTCCommonParam param);

音视频参数设置。

设置音视频相关的参数。该函数在登录房间前调用，主要用于设置音视频采集，编解码相关的参数。

参数

BRTCCommonParam 结构

• 通用属性

• 扩展属性

扩展属性推荐使用默认值，您也可以根据具体应用场景选择性使用。

启动跨房间通信

Future<void> startRoomMediaRelay(String destRoomName, int userId, String token);

启动跨房间通信。

注意 默认情况下，SDK允许同一房间内的用户间进行通信，若要与其它房间的用户进行通信，则需要需要该接口进行跨房间通信。

参数

停止跨房间通信

Future<void> stopRoomMediaRelay(String destRoomName, int userId);

停止跨房间通信。

参数

停止所有跨房间通信

Future<void> stopRoomMediaRelayAll();

停止所有跨房间通信。

解散房间

Future<void> disbandRoom();

解散房间。 房间管理员有权利解散整个房间，解散后，房间中的每个用户都被动退出房间。

踢出某成员

Future<void> kickOffUserWithId(int userId); 

踢出某用户。

房管／主播／会议主持 把某用户踢出聊天室。

参数

禁言某成员

Future<void> shutUpUserWithId(int userId);

禁言某人。

房管/主播／会议主持 禁止某人发言。

参数

解除禁言某成员

Future<void> unShutUpUserWithId(int userId);

解除禁言某成员。

房管/主播／会议主持 解除禁止某成员发言。

参数

发布/订阅相关接口

开始直播推流

Future<void> startPublish();

开始直播推流。

发布媒体流，开始推流。
调用时机：接收到房间登录成功事件 BRtcEvents.BRTC_ROOM_EVENT_LOGIN_OK之后；

注意 该接口仅直播场景使用。与stopPublish接口配对使用。

停止直播推流

Future<void> stopPublish();

停止直播推流。

停止发布流，结束直播。

注意 该接口仅直播场景使用。与startPublish接口配对使用。

订阅某成员媒体流 (1/2)

Future<void> subscribeStreaming(int userId);

订阅远端成员订阅流。

仅当BRTCCommonParam.autoSubscribe设置为false（非自动订阅）时，手动订阅远端用户媒体流。

参数

订阅某成员媒体流 (2/2)

Future<void> subscribeStreamingWithViewId(int videoviewidx, int userId);

订阅远端成员订阅流，同时绑定View用于渲染。

仅当BRTCCommonParam.autoSubscribe设置为false（非自动订阅）时，手动订阅远端用户媒体流。

参数

停止订阅某成员媒体流

Future<void> stopSubscribeStreaming(int userId);

停止订阅。

停止订阅流。

参数

消息相关接口

向某成员发送消息

Future<void> sendMessageToUser(String msg, int userId);

发送消息。

参数

设置用户属性

Future<void> setUserAttribute(String attribute);

用户属性设置。

设置用户属性。

参数

获取用户属性

Future<void> getUserAttribute(String userId);

用户属性获取。

获取用户属性。

参数

发送数据

Future<void> sendData(String data);

发送Data数据。

Data 数据通道保证顺序性和完整性。 使用数据通道能够同时传输音视频之外的相关数据。

参数

注意 发送Data 数据， 需要先打开datachannel 功能，设置BRTCCommonParam 的hasData 字段为true。

视频相关接口

开启本地预览

Future<void> startPreview();

本地预览。

打开camera，开始预览。

停止本地预览

Future<void> stopPreview();

停止预览。

关闭camera, 停止本地预览。

设置本地渲染窗口

Future<void> setLocalDisplay(int viewId);

设置本地视频预览窗口。

设置本地相机预览窗口。 外部采集模式下勿需调用。 调用时机：登录房间之前。

参数

设置远端渲染窗口

Future<void> setRemoteDisplay(int viewId);

设置远端显示窗口。

适用于1v1场景下，使用一个BRTCCloudVideoView 拉取一个远端用户视频流。

调用时机： 登录房间之前。

参数

设置远端渲染窗口，并绑定View

Future<void> setRemoteDisplayWithUserId(int viewId, int userId);

设置指定远端用户，绑定显示窗口。

可适用于1 v 1、1 v N等多种场景，支持BRTCCloudVideoView与userId绑定。 调用时机：推荐在 BRtcEvents.BRTC_ROOM_EVENT_REMOTE_COMING事件回调处调用。

参数

更新远端渲染窗口

Future<void> updateDisplay(int viewId, int userId);

更新远端用户显示窗口。

参数

移除远端用户渲染窗口

Future<void> removeRemoteDisplay(int userId);

移除远端用户渲染窗口。

移除并释放远端用户所对应的渲染窗口，可通过setRemoteDisplayWithUserId(int viewId, int userId) 接口再次设置渲染窗口。若不主动调用该接口释放渲染,则相应的渲染视图将在远端用户退出或本端登出房间时释放。

注意

窗口视图不见时，通过该接口释放渲染视图可优化系统资源占用。

参数

更新渲染窗口Surface尺寸

Future<void> changeSurfaceSize(int width, int height);

BRTCVideoViewController 类成员方法，可控制 BRTCCloudVideoView 显示视频的宽高。

参数

指定远端画面暂停/恢复播放

Future<void> setRemoteVideoPlayState(bool stats, int userId);

指定远端用户 视频流暂停 / 恢复播放。如暂停则不下发视频流。

参数

摄像头相关接口

切换摄像头

Future<void> switchCamera();

切换摄像头。

前/后摄像头切换。

设置摄像头ID

Future<void> setCameraID(int cameraId);

设置指定的摄像头ID。 调用时机： 登录房间之前。

参数

关闭/开启本地视频采集

Future<void> muteCamera(bool muted);

关闭/打开摄像头。

在关闭摄像头后，本地无法预览，且不传输本地视频数据给对方。

参数

音频相关接口

关闭/开启麦克风静音

Future<void> muteMicphone(bool muted);

开启/关闭 麦克风静音（不关闭手机麦克风设备）。

如果需要关闭麦克风设备，请查看enableMicCapture接口。

参数

关闭/开启麦克风采集

Future<void> enableMicCapture(bool enableMic);

开启/关闭 麦克风采集（关闭手机麦克风设备）。

参数

切换扬声器/听筒

Future<void> switchLoundSpeaker();

开关扬声器。

听筒与扬声器切换(免提功能)

预置听筒/扬声器

Future<void> presetLoudSpeaker(bool isPresetLoudSpeaker);

预置听筒/扬声器。

参数

禁止/开启音频输出

Future<void> muteSpeaker(bool muted);

开启/关闭音频输出。

参数

设置远端用户音频播放音量

Future<void> setUserPlaybackVolume(int userId, int volume);

设置远端用户音频播放音量。

参数

查询扬声器是否开启

 Future<bool?> isSpeakerOn();

查询扬声器是否开启。

设置音频输出设备

Future<void> setSoundMod(int soundMod);

设置音频输出设备，扬声器/听筒。

参数

开启默认音频自动增益

Future<void> enableAgc(bool isAgc);

开启音频自动增益。

参数

开启默认音频自动噪声抑制

Future<void> enableAns(bool isAns);

开启默认音频自动噪声抑制。

参数

开启默认音频回声消除

Future<void> enableAec(bool isAec);

开启默认音频回声消除。

参数

开启/关闭混音

Future<void> enableAudioMix(bool isEnable)；

开启/关闭混音。

参数

通知相关接口

房间事件更新回调

public void onRoomEventUpdate(int roomEvents, long data, String extra_info);

房间用户状态信息通知。

包含本端登录、远端用户进出房间、房间管理、房间消息、房间通信质量等相关状态回调事件。

参数

BRtcEvents 房间事件定义

实现源码可参考Rtc Flutter Demo;

连接状态更新回调

public void onPeerConnectStateUpdate(boolean uplink, int state, String extinfo);

server连接状态通知。

当与server端连接状态变化时，通知业务层做后续处理。

• uplink 标记上行和下行
• state 代表不同状态
• extinfo 根据不同state 表示不同含义

参数

BRtcEvents 连接状态事件定义

媒体流信息更新回调

public abstract void onStreamInfoUpdate(String [] streamId);

媒体流信息通知。

当有远端或本地流信息到来时，通知业务层做后续处理。

参数

回调事件

媒体流ID。

错误信息更新回调

public abstract void onErrorInfoUpdate(int errorInfo);

错误信息通知。

RTC通信过程中，错误信息的反馈。

参数

BRtcEvents 错误事件定义

房间数据接收回调

public abstract void onRoomDataMessage(ByteBuffer data);

数据接收。

该callback返回当前RTC Engine收到的数据消息。

参数

其他接口

返回

返回当前SDK版本号

开启/关闭调试信息输出

Future<void> setVerbose(bool bOnVerbose); 

是否打开调试信息。

建议在初始化 SDK 前调用。建议在调试阶段打开此开关，打开此开关后，将打开日志信息，方便调试。

参数

开启/关闭质量数据上报

Future<void> enableStatsToServer(bool isEnable, String qualityMonitorEnv);

RTC质量监控数据上报。

预置接口，监控信息上报开关 当打开开关时，上报帧率、码率、分辨率、丢包率等监控信息到服务端，console可查。

参数