返回 SDK 实例,nil 表示初始化失败
业务变更时,动态设置RTC代理对象。
接口类采用Delegate方法用于向App发送回调通知。未设置代理对象,或对象设置错误,可能导致无法正常收到相关回调。
该函数在 loginRtcRoomWithRoomName 前调用,用于设置音视频采集,编解码相关的参数。
|
设置参数包括分辨率、帧率、码率、视频方向等
|
参数类型,可指定设置某一项,或设置所有参数
|
获取当前设置的音视频相关参数,如分辨率、帧率、码率、视频方向等。
开启/关闭引擎统计信息
登录房间成功,在同一个房间的人能进行相互音视频聊天,如果失败,会通过onErrorInfoUpdate call back 返回错误信息。
|
房间名,长度不可超过 255 byte
|
用户 id,每个房间的用户 ID 必须唯一
|
|
登录房间成功,在同一个房间的人能进行相互音视频聊天,如果失败,会通过onErrorInfoUpdate call back 返回错误信息。此接口会踢出当前房间内同一userID用户,建议在断网重连或者初次登录失败时调用。
|
房间名,长度不可超过 255 byte
|
用户 id,每个房间的用户 ID 必须唯一
|
|
|
执行 logoutRtcRoom 后,会停止音视频采集,断开与房间服务器的连接,取消音视频的传输,销毁音视频传输通道以及释放其他资源。
|
|
加入目标房间时使用的userId,必须在加入房间中是唯一的
|
派发的token字符串
|
|
|
加入目标房间时使用的userId,必须在加入房间中是唯一的
|
停止所有启动的跨房间通信。
房管/主播/会议主持 把某人踢出聊天室。
房管/主播/会议主持 禁止某人发言。
房间管理员有权利解散整个房间,解散后,房间中的每个人都退出房间。
查询房间用户信息,获取房间中所有媒体用户列表。
查询房间用户信息,获取房间中 所有用户列表及用户流状态信息,是否可订阅,是否禁言,禁画中
动态配置server端推流参数。
若需要通话过程中,停止转推,调用该接口。
流发布在 roomId 指定的房间,在同一房间 joined 的用户可以相互订阅流,默认在发布流的同时, listening/subscriber 在该房间其他用户的流。
用于订阅同一房间的其他用户的流.
|
用户要订阅的其他用户的流id列表(即其他用户id列表)
|
该接口停止已经订阅的流.
当enable数据通道后,可通过该接口发送文本消息给在同一房间的其他用户。
-1 发送失败,0 发送成功
通过信令信道 该接口发送文本消息给在同一房间的其他用户。
-1 发送失败,0 发送成功
发送文本消息给在同一房间的指定用户。
-1 发送失败,0 发送成功
-1 设置失败,0 设置成功
-1 获取失败,0 获取成功
外部采集设置。若开启视频外部采集,则sdk内部不打开拍摄头采集视频。
设置外部采集模块。必须在登录房间前调用,并且不能置空。
设置外部渲染回调对象。使用外部渲染功能,需要设置代理对象。未设置代理对象,或对象设置错误,可能导致无法正常收到相关回调
打开camera,开始预览。
关闭camera, 停止本地预览。
本地显示view设置。
|
本地显示view,用于显示camera采集的视频数据
|
设置本地指定类型流渲染窗口
设置本地关联指定媒体目标类型的显示view。
|
本地显示view,用于显示camera采集的视频数据
|
|
两人通话模式,设置远端view显示。
|
远端画面显示view, 用于显示远端用户传输过来的视频数据
|
设置指定远端用户渲染窗口
多人模式设置指定用户远端 view。
|
远端画面显示 view, 用于显示远端用户传输过来的视频数据
|
|
设置指定远端用户指定类型流渲染窗口
两人通话模式,设置远端指定用户关联指定媒体目标类型的显示 view。
|
远端画面显示view, 用于显示远端用户传输过来的视频数据
|
|
|
更新指定用户的远端显示view。
|
远端画面显示 view, 用于显示远端用户传输过来的视频数据
|
|
设置是否拉取某成员视频流
指定远端画面暂停/恢复播放。
通过控制远端视频流是否拉取,指定远端画面暂停/恢复播放。
切换摄像头,前后摄像头切换。
在关闭摄像头后,不传输本地视频数据给对方
关闭/开启本地视频采集
在关闭摄像头后,不传输本地视频数据给对方,默认打开。
摄像头对焦功能,支持手动和自动对焦。
音频录制回调对象设置。
设置音频录制回调代理对象。开启音频录制功能,需要设置代理对象。未设置代理对象,或对象设置错误,可能导致无法正常收到相关回调。
设置音频会话代理对象。
设置音频外部采集代理对象
设置音频外部采集代理对象。
接收音频外部采集的回调功能。
关闭音频采集,停止音频的采集
关闭/开启本地音频采集
关闭/开启本地音频采集。
关闭音频采集,停止音频的采集。
|
true:开启本地音频采集;false:关闭本地音频采集
|
-1 关闭/开启本地音频采集失败,0 关闭/开启本地音频采集成功
关闭扬声器,停止音频播放。
关闭音频采集,停止音频的采集,默认开启。
切换扬声器/听筒(1/2)
开关扬声器,听筒与扬声器切换(免提功能)。
切换扬声器/听筒(2/2)
获取房间成员语音激励列表
获取用户语音激励列表。
是否开启音频自动增益。
开启默认音频自动噪声抑制
是否开启音频噪声抑制。
设置声音输出方式,可选值:speaker(扬声器)或 ear(听筒)。
|
可选值:speaker(扬声器)或 ear(听筒)
|
设置是否拉取某成员音频流
指定远端音频暂停/恢复播放。
通过控制是否拉取远端音频流,控制指定远端用户声音暂停/恢复播放。
设置远端用户音频播放音量
指定用户音量. 音量设置只在本端有效,其他订阅者无影响。
该接口用于配置server推流的参数,聊天室模式:在同一个rtc房间的所有参与者在混流后,直接转推到一个指定的直播房间; 主播转推模式:主播推向不同的直播房间。
|
主次平铺, 分辨率 480x360 (固定码率、帧率)
|
主次平铺, 分辨率 480x360 (自定义码率、帧率) 下面模板也可以设置
|
|
|
|
|
|
|
|
|
|
|
|
|
平铺模式(大小相等), 分辨率
|
|
|
|
|
|
|
|
主次平铺, 分辨率480x854(竖屏)
|
主次平铺, 分辨率540*960(竖屏)
|
主次平铺, 分辨率544*960(竖屏)
|
主次平铺, 分辨率720*1280(竖屏)
|
主次平铺, 分辨率(竖屏)
|
平铺模式, 分辨率480x854(竖屏)
|
平铺模式, 分辨率540*960(竖屏)
|
平铺模式,分辨率544*960(竖屏)
|
平铺模式,分辨率720*1280(竖屏)
|
平铺模式,分辨率(竖屏)
|
画中画模式, 分辨率480x854(竖屏)
|
画中画模式,分辨率540*960(竖屏)
|
画中画模式,分辨率544*960(竖屏)
|
画中画模式,分辨率720*1280(竖屏)
|
画中画模式,分辨率(竖屏)
|
房间中用户加入或离开时,通知房间中其他用户,其他用户可接收到房间中他人离开的信息。
SDK 内部暂不提供重连接口,重连逻辑可在用户业务层实现,推荐重连策略:
- 重连逻辑可通过调用登出房间后再调用登录房间实现;接口调用间隔时间建议2S以上;
- 通信错误大多与网络连接异常引起,可在重连逻辑内可判断网络连接状态;
- 重连间隔1S以上,可设置最大重连次数小于10次;
与server连接状态通知。与server端的连接状态信息更新,包括信令/媒体/数据通道,如开始建连,连接成功,连接失败等
媒体流信息通知。当有远端或本地流信息到来时,通知app层做后续处理
媒体流ID,表时属于某一用户的流
错误信息通知。RTC通信过程中,错误信息的反馈
开启/关闭引擎统计信息
RTC引擎状态信息统计。该callback返回当前rtc engine的一些参数和性能信息,如传输fps,码率,网络状况,cpu等信息给app
接收到房间成员的消息回调(1/2)
当房间的其他用户发消息时,会收到该通知(数据通道)
接收到房间成员的消息回调(2/2)
当房间的其他用户发消息时,会收到该通知(信令通道)
接收到获取用户属性回调
开始应用内屏幕分享。仅抓取宿主应用的屏幕内容,仅支持 iOS 11 及以上系统可用
开始系统屏幕分享。支持抓取整个 iOS 系统的屏幕,详细接入流程及注意事项可参考 SDK 集成文档
|
开启屏幕分享的结果,0: 开启成功; 1: rtc 当前不可用; 2: 系统录屏功能当前不可用; 3: 系统版本不支持;
|
本地屏幕分享已停止。在屏幕分享过程中,当您通过 stopShareScreen, logoutRtcRoom 等方法停止屏幕分享后,会回调该事件
在扩展进程中,需要通过以下类和接口进行对接
屏幕分享扩展进程停止回调。在系统屏幕分享过程中,当通过系统控制、主 App 停止分享、主 App 退出房间等行为停止分享,会在扩展中回调该方法
如果接入 BRTC 的业务开启了业务鉴权,那么在登录房间的过程中,需要使用业务生成的 token 值。该扩展回调为系统屏幕分享进程的用户提供了业务鉴权对接能力,
在对接系统屏幕分享时,如果开启了业务鉴权,则需要实现该方法,并在 completion 中回调 token 值;如果没有开启业务鉴权,需要在 completion 中回调一个任意内容的非空字符串作为 token。
|
|
用于生成鉴权 token 的房间号
|
用于生成鉴权 token 的用户名
|
用于给扩展类返回生成 token 值的回调
|
开启/关闭启用测试环境
建议在初始化 SDK 前调用。建议开发者在开发阶段设置为测试环境,使用由百度提供的测试环境。上线前需切换为正式环境运营。
|
是否启用测试环境,true 启用,false 不启用。默认为 false
|
开启/关闭调试信息输出
建议在初始化 SDK 前调用。建议在调试阶段打开此开关,方便调试。
|
是否打开调试信息,true 打开,false 不打开。默认为 false
|
上传日志到后台便于分析问题。在初始化SDK成功后调用。
把log通过微信等工具共享给技术开发,便于分析解决问题。
业务变更需要调整appId、tokenStr时,调用此api可以设置。在初始化sdk前后都可以调用。
开启/关闭RTC质量监控数据上报
RTC质量监控数据上报。
预置接口,监控信息上报开关 当打开开关时,上报帧率、码率、分辨率、丢包率等监控信息到服务端,console可查。
|
是否打开rtc质量监控数据上报,true 打开,false不打开。默认为 false
|
|
开启/关闭RTC异常信息上报
RTC异常信息上报开关。
上报异常信息,方便问题排查