API
初始化接口
initSDKWithAppID
- (instancetype)initSDKWithAppID:(NSString *)appId
tokenStr:(NSString *)tokenStr
delegate:(id<BaiduRtcRoomDelegate>)delegate;
介绍
初始化SDK。
初始化SDK时调用。设置 AppID、TokenStr 等。
参数
参数 | 类型 | 描述 |
---|---|---|
appId | NSString* | RTC 基础业务单元的唯一标识 |
tokenStr | NSString* | RTC Server 端鉴权使用的字符串 |
delegate | id<BaiduRtcRoomDelegate> | 遵循 BaiduRtcRoomDelegate 协议的对象 |
返回
返回 SDK 实例,nil 表示初始化失败
setParamSettings
- (void)setParamSettings:(RtcParameterSettings *)paramSettings paramType:(RtcParamSettingType)paramType;
介绍
音视频相关参数设置。
该函数在 loginRtcRoomWithRoomName 前调用,用于设置音视频采集,编解码相关的参数。
参数
参数 | 类型 | 描述 |
---|---|---|
paramSettings | RtcParameterSettings* | 设置参数包括分辨率、帧率、码率、视频方向等 |
paramType | RtcParamSettingType | 参数类型,可指定设置某一项,或设置所有参数 |
RtcParameterSettings
@property (nonatomic, assign) BOOL hasAudio; // 是否采集音频数据
@property (nonatomic, assign) BOOL isCreatingAecDump; // 是否开启aecdump
@property (nonatomic, assign) BOOL isUsingLevelControl; // 是否开启等级控制
@property (nonatomic, assign) BOOL isUsingManualConfig; // 是否开启手动配置
@property (nonatomic, assign) BOOL isExportAudioRecord; // 是否开启外部采集
@property (nonatomic, assign) BOOL isExportAudioPlayout; // 是否开启外部播放
@property (nonatomic, assign) BOOL isExportAudioRecordPlayoutMix; // 是否开启外部混音
@property (nonatomic, assign) BOOL hasVideo; // 是否开启视频采集
@property (nonatomic, assign) int videoFps; // 视频帧率
@property (nonatomic, assign) int videoWidth; // 视频宽
@property (nonatomic, assign) int videoHeight; // 视频高
@property (nonatomic, assign) int videoBitrate; // 视频码率(bps)
@property (nonatomic, copy) NSString* videoCodecType; // 编码类型
@property (nonatomic, assign) BOOL isEnableExternalCapturer; // 是否开启外部采集
@property (nonatomic, assign) BOOL isEnableExternalRender; // 是否开启外部渲染
@property (nonatomic) BOOL isAutoPublish; // 是否自动发布流
@property (nonatomic) BOOL isAutoSubscribe; // 是否自动订阅流
@property (nonatomic, assign) BOOL isMultiPlayerModel; // 是否是多人模式
@property (nonatomic, assign) BOOL isEnableDataChannel; // 是否开启数据通道
@property (nonatomic, assign) LiveServerInfo *roomTransInfo; // 房间转推配置
@property (nonatomic, assign) LiveServerInfo *anchorTransInfo; // 主播转推配置
@property (nonatomic, assign) BOOL isMixing; // 是否混流
@property (nonatomic, copy) NSString *rtmpUrl; // 转推地址
@property (nonatomic, assign) RtcLiveTransferMode liveTransferMode; // 转推模式
返回
无
getParamSettings
- (RtcParameterSettings *)getParamSettings;
介绍
获取音视频相关参数。
获取当前设置的音视频相关参数,如分辨率、帧率、码率、视频方向等。
参数
无
返回
RtcParameterSettings 音视频参数信息
setEngineStateStatistics
- (void)setEngineStateStatistics:(BOOL)bOnStatistics;
介绍
RTC统计信息开关。
当打开开关时 onEngineStatisticsInfo 函数每隔1秒返回一次统计信息,并且可通过queryEngineStatisticsInfo 函数主动查询RTC统计信息。统计信息包括 CPU, FPS,video codec等。
参数
参数 | 类型 | 描述 |
---|---|---|
bOnStatistics | boolean | bOnStatistics = YES, 打开开关;bOnStatistics = NO, 关闭引擎统计信息 |
返回
无
房间相关接口
loginRtcRoomWithRoomName
- (BOOL)loginRtcRoomWithRoomName:(NSString *)roomName userID:(int)userId;
介绍
登录房间。
登录房间成功,在同一个房间的人能进行相互音视频聊天,如果失败,会通过onErrorInfoUpdate call back 返回错误信息。
参数
参数 | 类型 | 描述 |
---|---|---|
roomName | NSString* | 房间名,长度不可超过 255 byte |
userId | int | 用户 id,每个房间的用户 ID 必须唯一 |
返回
true 成功,false 失败
logoutRtcRoom
- (bool)logoutRtcRoom;
介绍
退出房间。
执行 logoutRtcRoom 后,会停止音视频采集,断开与房间服务器的连接,取消音视频的传输,销毁音视频传输通道以及释放其他资源。
参数
无
返回
true 成功,false 失败
kickOffUserWithId
- (void)kickOffUserWithId:(int)userId;
介绍
踢除聊天。
房管/主播/会议主持 把某人踢出聊天室。
参数
参数 | 类型 | 描述 |
---|---|---|
userId | int | 在房间中的用户的 用户 ID |
返回
无
shutUpUserWithId
- (void)shutUpUserWithId:(int)userId;
介绍
禁言
房管/主播/会议主持 禁止某人发言。
参数
参数 | 类型 | 描述 |
---|---|---|
userId | int | 在房间中的用户的 用户 ID |
返回
无
disbandRoom
- (void)disbandRoom;
介绍
解散房间
房管/主播/会议主持 解散房间。
参数
无
返回
无
queryUserListOfRoom
- (NSArray *)queryUserListOfRoom;
介绍
查询媒体用户。
查询房间用户信息,获取房间中所有媒体用户列表。
参数
无
返回
NSArray* 用户信息列表
queryMessageUserListOfRoom
- (NSArray *)queryMessageUserListOfRoom;
介绍
查询消息用户。
查询房间用户信息,获取房间中 Message 用户列表。
参数
无
返回
NSArray* 用户信息列表
发布/订阅流相关接口
publishStreaming
- (void)publishStreaming;
介绍
发布流。
流发布在 roomId 指定的房间,在同一房间 joined 的用户可以相互订阅流,默认在发布流的同时, listening/subscriber 在该房间其他用户的流。
参数
无
返回
无
stopPublishStreaming
- (void)stopPublishStreaming;
介绍
停止发布流。
stop 通过 publishStreaming 发布的流。
参数
无
返回
无
subsribeStreaming
- (void)subsribeStreaming:(NSArray<NSNumber *> *)streamingIds;;
介绍
订阅流。
用于订阅同一房间的其他用户的流.
参数
参数 | 类型 | 描述 |
---|---|---|
streamingIds | NSArray<NSNumber*>* | 用户要订阅的其他用户的流id列表(即其他用户id列表) |
返回
无
stopSubscribeStreaming
- (void)stopSubscribeStreaming:(NSArray<NSNumber *> *)streamingIds;;
介绍
停止订阅流。
该接口停止已经订阅的流.
参数
参数 | 类型 | 描述 |
---|---|---|
streamingIds | NSArray<NSNumber*>* | 用户要停止订阅的流id列表(即其他用户id列表) |
返回
无
消息相关接口
sendMessage2
- (int)sendMessage2:(NSString *)message;
介绍
广播消息。
广播消息给在同一房间的其他用户。
参数
参数 | 类型 | 描述 |
---|---|---|
message | NSString* | 需要发送的文本消息 |
返回
-1 发送失败,0 发送成功
sendMessage2WithUserId
- (int)sendMessage2WithUserId:(NSString *)message userId:(NSNumber *)userId;
介绍
指定用户发送消息。
发送文本消息给在同一房间的指定用户。
参数
参数 | 类型 | 描述 |
---|---|---|
message | NSString* | 需要发送的文本消息 |
userId | NSNumber* | 指定接收消息的用户 ID |
返回
-1 发送失败,0 发送成功
setUserAttribute
- (int)setUserAttribute:(NSString *)attribute;
介绍
attribute 属性设置。
设置本用户 attribute 属性,房间其他用户由 onTextMessageAttribute 通知收到。
参数
参数 | 类型 | 描述 |
---|---|---|
attribute | NSString* | attribute 值 |
返回
-1 发送失败,0 发送成功
getUserAttribute
- (int)getUserAttribute:(NSNumber *)userID;
介绍
attribute属性获取。
获取指定用户 attribute 属性,属性值由 onTextMessageAttribute 通知得到。
参数
参数 | 类型 | 描述 |
---|---|---|
userID | NSNumber* | 用户ID |
返回
-1 发送失败,0 发送成功
视频相关接口
setVideoCaptureFactory
- (void)setVideoCaptureFactory:(id<BaiduVideoCaptureFactory>)factory;
介绍
外部采集设置。
设置外部采集模块。必须在登录房间前调用,并且不能置空。
参数
参数 | 类型 | 描述 |
---|---|---|
factory | id<BaiduVideoCaptureFactory> | 工厂对象,遵循 BaiduVideoCaptureFactory 协议的对象 |
返回
无
setRenderDelegate
- (void)setRenderDelegate:(id<BaiduRtcApiRenderDelegate>)renderDelegate;
介绍
外部渲染设置。
设置外部渲染回调对象。使用外部渲染功能,需要设置代理对象。未设置代理对象,或对象设置错误,可能导致无法正常收到相关回调
注意:请使用 BaiduExternalVideoRender
参数
参数 | 类型 | 描述 |
---|---|---|
renderDelegate | id<BaiduRtcApiRenderDelegate> | 遵循 BaiduRtcApiRenderDelegate 协议的代理对象 |
返回
无
startPreview
- (void)startPreview;
介绍
本地预览。
打开camera,开始预览。
参数
无
返回
无
stopPreview
- (void)stopPreview;
介绍
停止预览。
关闭camera, 停止本地预览。
参数
无
返回
无
setLocalDisplay
- (void)setLocalDisplay:(NSView<RTCVideoRenderer> *)localVideoView;
介绍
本地显示view设置。
设置本地显示view。在 loginRtcRoomWithRoomName 之前调用,loginRtcRoomWithRoomName 之后,本地视频数据会显示到 localVideoView, localVideoView 的位置大小要与采集的视频大小成比例。
参数
参数 | 类型 | 描述 |
---|---|---|
localVideoView | NSView <RTCVideoRenderer> * | 本地显示view,用于显示camera采集的视频数据 |
返回
无
setRemoteDisplay
- (void)setRemoteDisplay:(NSView<RTCVideoRenderer> *)remoteVideoView;
介绍
远端view显示。
设置远端显示view。在 loginRtcRoomWithRoomName 之前调用,loginRtcRoomWithRoomName 之后,远端视频数据会显示到 remoteVideoView,remoteVideoView 的大小要与采集的视频大小成比例。
参数
参数 | 类型 | 描述 |
---|---|---|
remoteVideoView | NSView <RTCVideoRenderer> * | 远端画面显示view, 用于显示远端用户传输过来的视频数据 |
返回
无
setRemoteDisplay: userId:
- (void)setRemoteDisplay:(NSView<RTCVideoRenderer> *)remoteVideoView userId:(NSInteger)userId;
介绍
多人模式设置指定用户远端 view。
在远端用户流到达后调用,指定用户视频数据会显示到 remoteVideoView,remoteVideoView 的大小要与采集的视频大小成比例
参数
参数 | 类型 | 描述 |
---|---|---|
remoteVideoView | NSView <RTCVideoRenderer> * | 远端画面显示 view, 用于显示远端用户传输过来的视频数据 |
userId | NSInteger | 远端用户ID |
返回
无
updateDisplay: userId:
- (void)updateDisplay:(NSView<RTCVideoRenderer> *)remoteVideoView userId:(NSInteger)userId;
介绍
更新指定用户的远端显示 view
多人模式,更新指定用户视频数据显示view,remoteVideoView 的大小要与采集的视频大小成比例
参数
参数 | 类型 | 描述 |
---|---|---|
remoteVideoView | NSView <RTCVideoRenderer> * | 远端画面显示 view, 用于显示远端用户传输过来的视频数据 |
userId | NSInteger | 远端用户ID |
返回
无
setRemoteVideoPlayState
-(void)setRemoteVideoPlayState:(BOOL)stats userId:(NSInteger)userId;
介绍
指定远端画面暂停/恢复播放
通过控制指定远端用户流是否拉取,控制指定远端用户画面暂停/恢复播放
参数
参数 | 类型 | 描述 |
---|---|---|
stats | BOOL | true 订阅; false 停止订阅 |
userId | NSInteger | 远端用户ID |
返回
无
摄像头相关接口
switchCamera
- (void)switchCamera;
介绍
摄像头切换。
切换摄像头,前后摄像头切换。
参数
无
返回
无
muteCamera
- (void)muteCamera;
介绍
关闭/打开摄像头。
在关闭摄像头后,本地无法预览,且不传输本地视频数据给对方
参数
无
返回
无
cameraFocusWithPoint
- (void)cameraFocusWithPoint:(CGPoint)point andPlaneSize:(CGSize)size;
介绍
摄像头对焦。
摄像头对焦功能,支持手动和自动对焦。
参数
参数 | 类型 | 描述 |
---|---|---|
point | CGPoint | 对焦点坐标 |
size | CGSize | camera预览view尺寸 |
返回
无
setCameraFace
- (void)setCameraFace:(BOOL)front
介绍
设置前后置摄像头。
设置前后置摄像头,默认前置摄像头。
参数
参数 | 类型 | 描述 |
---|---|---|
front | BOOL | true 前置;false 后置 |
返回
无
音频相关接口
muteMicphone
- (void)muteMicphone;
介绍
关闭麦克风。
关闭麦克风,停止音频的采集
参数
无
返回
无
getRemoteAudioLevels
- (NSArray *)getRemoteAudioLevels;
介绍
获取远端用户音量。
获取远端用户音量,返回数组包含各远端用户userID及对应音量。
参数
无
返回
RtcRoomAudioLevel 数组
RtcRoomAudioLevel
@interface RtcRoomAudioLevel : NSObject // 用户语音激励
@property (nonatomic, copy) NSNumber *userID; // 用户 ID
@property (nonatomic, copy) NSString *userName; // 用户名
@property (nonatomic, assign) NSInteger volumeLevel; // 音量
@end
setRemoteAudioPlayState
- (void)setRemoteAudioPlayState:(BOOL)stats userId:(NSInteger)userId;
介绍
指定某个远端用户音频暂停/播放。
控制特定远端用户音频暂停/播放。控制音频流是否拉取
参数
参数 | 类型 | 描述 |
---|---|---|
stats | BOOL | true 拉取;false 停止拉取 |
userId | NSInteger | 用户 ID |
返回
无
美颜相关接口
setWhitenFactor
- (void)setWhitenFactor:(float)factor;
介绍
美白度设置。
设置美白度,调节美白系数
参数
参数 | 类型 | 描述 |
---|---|---|
factor | float | 在美颜中的美白因子 |
返回
无
setRedenFactor
- (void)setRedenFactor:(float)factor;
介绍
红润度设置。
设置红润度,调节红润系数。
参数
参数 | 类型 | 描述 |
---|---|---|
factor | float | 在美颜中的红润因子 |
返回
无
setBuffingFactor
- (void)setBuffingFactor:(float)factor;
介绍
磨皮度设置。
设置磨皮度,调节磨皮系数
参数
参数 | 类型 | 描述 |
---|---|---|
factor | float | 在美颜中的磨皮因子 |
返回
无
转推配置相关接口
configLiveServerWithUrl
- (void)configLiveServerWithUrl::(NSString *)url
isMix:(BOOL)isMix
isRecording:(BOOL)isRecording
mixTemplate:(NSString *)mixTmplt
transferMode:(RtcLiveTransferMode)mode
avParam:(RtcLiveAuidoVideoParameters*)avParam;
介绍
该接口用于配置server推流的参数,聊天室模式:在同一个rtc房间的所有参与者在混流后,直接转推到一个指定的直播房间; 主播转推模式:主播推向不同的直播房间。
参数
参数 | 类型 | 描述 |
---|---|---|
url | NSString* | 转推url地址 |
isMix | BOOL | 是否混流 |
isRecording | BOOL | 是否录制 |
mixTemplate | NSString* | 混流模板 |
transferMode | RtcLiveTransferMode | 转推模式 |
avParam | RtcLiveAuidoVideoParameters* | 转推参数 |
返回
无
通知相关接口
onRoomEventUpdate
- (void)onRoomEventUpdate:(RtcRoomEvents *)roomEvents;
介绍
房间中用户加入或离开时,通知房间中其他用户,其他用户可接收到房间中他人离开的信息。
参数
参数 | 类型 | 描述 |
---|---|---|
roomEvents | RtcRoomEvents | 房间事件信息,具体信息参考 BaiduRtcRoomApiDefines.h |
回调事件
RTC_ROOM_EVENTS_ROOM_CREATED = 100, // 创建房间成功
RTC_ROOM_EVENTS_ROOM_JOINED, // 加入房间成功
RTC_ROOM_EVENTS_USER_JOINED, // 有用户加入房间
RTC_ROOM_EVENTS_USER_LEAVING, // 有用户离开房间
RTC_ROOM_EVENTS_RECEIVED_HANGUP, // 收到server端挂断通知
RTC_ROOM_EVENTS_RECEIVED_TIMEOUT, // server端接收信令超时通知, 没有收到client发送到信令
RTC_ROOM_EVENTS_SENT_TIMEOUT, // client端发送信令超时,没有server responce
RTC_ROOM_EVENTS_SENDING_MEDIA_OK, // 媒体数据发送成功
RTC_ROOM_EVENTS_SENDING_MEDIA_FAILED, // 媒体数据发送失败
RTC_ROOM_EVENTS_PUBLISHE_STREAMING_ERROR, // server端规定时间内未能收到client端推送上去的流
RTC_ROOM_EVENTS_USEREVENTS_USER_JOINED = 110, // userevent事件 用户加入房间
RTC_ROOM_EVENTS_USEREVENTS_USER_LEAVING, // userevent事件 用户退出房间
RTC_ROOM_EVENTS_DISBAND_ROOM = 112, // 解散房间回调
RTC_ROOM_EVENTS_SOMEBODY_SHUTUPED = 113, // 禁言回调
RTC_ROOM_EVENTS_SOMEBODY_DISSHUTUPED = 114, // 解禁回调
RTC_ROOM_EVENTS_SOMEBODY_KICKOFFED = 115, // 踢人回调
RTC_ROOM_EVENTS_OTHERS // 未知事件
返回
无
onPeerConnectStateUpdate
- (void)onPeerConnectStateUpdateWithType:(RtcPeerConnectionType)type stats:(int)connecStats;
介绍
与server连接状态通知。与server端的连接状态信息更新,包括信令/媒体/数据通道,如开始建连,连接成功,连接失败等
参数
参数 | 类型 | 描述 |
---|---|---|
type | RtcPeerConnectionType | 状态类型:媒体、数据、信令 |
connecStates | int | 连接状态码 |
回调事件
// 信令通道状态
RTC_SIGNAL_CHANNEL_STATS_ESTABLISHING = 150, // 信令通道正在建立
RTC_SIGNAL_CHANNEL_STATS_ESTABLISHED, // 信令通道已经建立
RTC_SIGNAL_CHANNEL_STATS_CLOSED, // 信令通道关闭
RTC_SIGNAL_CHANNEL_STATS_FAILED, // 信令通道建立失败
RTC_SIGNAL_CHANNEL_STATS_DISCONNECT, // 信令通道失去连接
RTC_SIGNAL_CHANNEL_STATS_OTHERS // 其它
// 媒体通道状态
RTC_MEDIA_CHANNEL_STATS_CONNECTING = 200, // 媒体通道正在建立
RTC_MEDIA_CHANNEL_STATS_CONNECTED, // 媒体通道建立完成
RTC_MEDIA_CHANNEL_STATS_DISCONNECTED, // 媒体通道断开连接
RTC_MEDIA_CHANNEL_STATS_FAILED, // 媒体通道建立失败
RTC_MEDIA_CHANNEL_STATS_OTHERS // 其它
// 数据通道
RTC_DATA_CHANNEL_STATS_CONNECTING = 300, // 数据通道正在建立
RTC_DATA_CHANNEL_STATS_CONNECTED, // 数据通道建立成功
RTC_DATA_CHANNEL_STATS_DISCONNECTED, // 数据通道断开连接
RTC_DATA_CHANNEL_STATS_FAILED, // 数据通道建立失败
RTC_DATA_CHANNEL_STATS_OTHERS // 其它
返回
无
onStreamInfoUpdate
- (void)onStreamInfoUpdate:(RtcStreamInfo *)rtcStreamInfo;
介绍
媒体流信息通知。当有远端或本地流信息到来时,通知app层做后续处理
参数
参数 | 类型 | 描述 |
---|---|---|
rtcStreamInfo | RtcStreamInfo | 具体流相关的信息 |
回调事件
RTC_VIDEO_STREAMING_STATES_ARRIVAL = 0, // 视频流到达事件
RTC_VIDEO_STREAMING_STATES_REMOVE, // 视频流离开事件
RTC_AUDIO_ONLY_STREAMING_STATES_ARRIVAL, // 纯音频流到达事件
RTC_AUDIO_ONLY_STREAMING_STATES_REMOVE, // 纯音频流离开事件
RTC_VIDEO_STREAMING_STATES_OTHERS // 其它事件
返回
无
onErrorInfoUpdate
- (void)onErrorInfoUpdate:(RtcErrorCodes)errorInfo;
介绍
错误信息通知。RTC通信过程中,错误信息的反馈
参数
参数 | 类型 | 描述 |
---|---|---|
errorInfo | RtcErrorCodes | 错误信息字符串 |
回调事件
RTC_NO_SUCH_ROOM_ERROR = 426, // 房间不存在
RTC_ROOM_ALREADY_EXIST_ERROR, // 房间已存在
RTC_USERID_ALREADY_EXIST_ERROR = 436, // 用户已存在
RTC_ERROR_OTHERS // 其它错误
返回
无
onEngineStatisticsInfo
- (void)onEngineStatisticsInfo:(NSArray *)statistics;
介绍
RTC引擎状态信息统计。该callback返回当前rtc engine的一些参数和性能信息,如传输fps,码率,网络状况,cpu等信息给app
参数
参数 | 类型 | 描述 |
---|---|---|
statistics | NSArray | rtc引擎状态信息统计数组 |
返回
无
onTextMessageArrival2
- (void)onTextMessageArrival2:(RtcMessageInfo *)msg;
介绍
当房间的其他用户发消息时,会收到该通知
参数
参数 | 类型 | 描述 |
---|---|---|
msg | RtcMessageInfo | 消息结构体,具体消息在该结构体中 |
返回
无
onTextMessageAttribute
- (void)onTextMessageAttribute:(NSNumber *)userID attribute:(NSString *)attribute;
介绍
房间其他用户调用接口setUserAttribute,或本用户调用getUserAttribute获取用户Attribute属性时,该通知被触发,返回用户attribute属性
参数
参数 | 类型 | 描述 |
---|---|---|
userID | NSNumber | 用户ID |
attribute | NSString* | 属性值 |
返回
无
其他接口
version
+ (NSString *)version;
介绍
获取 iOS SDK 版本号。
参数
无
返回
返回当前版本号
setUseTestEnv
+ (void)setUseTestEnv:(BOOL)isUseTestEnv;
介绍
是否启用测试环境。
建议在初始化 SDK 前调用。建议开发者在开发阶段设置为测试环境,使用由百度提供的测试环境。上线前需切换为正式环境运营。
参数
参数 | 类型 | 描述 |
---|---|---|
isUseTestEnv | boolean | 是否启用测试环境,true 启用,false 不启用。默认为 false |
返回
无
setVerbose
+ (void)setVerbose:(BOOL)bOnVerbose;
介绍
是否打开调试信息。
建议在初始化 SDK 前调用。建议在调试阶段打开此开关,方便调试。
参数
参数 | 类型 | 描述 |
---|---|---|
bOnVerbose | boolean | 是否打开调试信息,true 打开,false 不打开。默认为 false |
返回
无
upLoadLog
+ (void)upLoadLog;
介绍
上报日志。
上传日志到后台便于分析问题。在初始化SDK成功后调用。
参数
无
返回
无
setBaiduRtcAppID
+ (void)setBaiduRtcAppID:(NSString *)appId andToken:(NSString *)tokenStr;
介绍
动态设置AppId和TokenStr
业务变更需要调整appId、tokenStr时,调用此api可以设置。在初始化sdk前后都可以调用。
参数
参数 | 类型 | 描述 |
---|---|---|
appId | NSString* | RTC基础业务单元的唯一标识 |
tokenStr | NSString* | RTC Server端鉴权使用的字符串 |
返回
无
queryEngineStatisticsInfo
- (NSArray *)queryEngineStatisticsInfo;
介绍
查询RTC统计信息。 如CPU, FPS,video codec等
参数
无
返回
NSArray* rtc 状态统计信息
enableStatsToServer
- (void)enableStatsToServer:(BOOL)isEnable qualityMonitorEnv:(NSString *)qualityMonitorEnv;
介绍
RTC质量监控数据上报。
预置接口,监控信息上报开关 当打开开关时,上报帧率、码率、分辨率、丢包率等监控信息到服务端,console可查。
参数
参数 | 类型 | 描述 |
---|---|---|
isEnable | BOOL | 是否打开rtc质量监控数据上报,true 打开,false不打开。默认为 false |
qualityMonitorEnv | NSString | 线上环境:"online" 沙盒:"qa"。 默认值为 "online" |
返回
无