RongRTCEngine Class Reference

Inherits from NSObject
Declared in RongRTCEngine.h

Overview

音视频引擎入口

+ sharedEngine

音视频引擎单例

+ (RongRTCEngine *)sharedEngine

Discussion

音视频引擎单例

Declared In

RongRTCEngine.h

  netMonitor

数据上报,该属性已废弃，请使用 monitorDelegate

@property (nonatomic, weak) id<RongRTCNetworkMonitorDelegate> netMonitor

Discussion

数据上报,该属性已废弃，请使用 monitorDelegate

Declared In

RongRTCEngine.h

  monitorDelegate

sdk 状态监视器代理

@property (nonatomic, weak) id<RongRTCActivityMonitorDelegate> monitorDelegate

Discussion

sdk 状态监视器代理

Declared In

RongRTCEngine.h

  currentRoom

当然已加入的房间

@property (nonatomic, strong, readonly) RongRTCRoom *currentRoom

Discussion

当然已加入的房间

Declared In

RongRTCEngine.h

– setMediaServerUrl:

设置媒体服务服务地址（私有部署用户使用）

- (BOOL)setMediaServerUrl:(NSString *)url

Parameters

url

url

Discussion

设置媒体服务服务地址（私有部署用户使用）

Declared In

RongRTCEngine.h

– setReconnectEnable:

是否允许断线重连，默认为 YES，SDK 在断线或者自己被踢出房间会尝试重连，如果设置为 NO ， 自己被踢出房间将不再做重连，会抛出 - (void)didKickedOutOfTheRoom:(RongRTCRoom *)room;此代理。

- (void)setReconnectEnable:(BOOL)enable

Parameters

enable

断线重连开关

Discussion

是否允许断线重连，默认为 YES，SDK 在断线或者自己被踢出房间会尝试重连，如果设置为 NO ， 自己被踢出房间将不再做重连，会抛出 - (void)didKickedOutOfTheRoom:(RongRTCRoom *)room;此代理。

Declared In

RongRTCEngine.h

– joinRoom:completion:

加入房间

- (void)joinRoom:(NSString *)roomId completion:(nullable void ( ^ ) ( RongRTCRoom *_Nullable room , RongRTCCode code ))completion

Parameters

roomId

房间 Id(支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式 最长 64 个字符)
completion

加入房间回调,其中，room 对象中的 remoteUsers ，存储当前房间中的所有人，包括发布资源和没有发布资源的人。

Discussion

加入房间

Declared In

RongRTCEngine.h

– joinRoom:config:completion:

加入房间，可配置加入房间场景。

- (void)joinRoom:(NSString *)roomId config:(RongRTCRoomConfig *)config completion:(nullable void ( ^ ) ( RongRTCRoom *_Nullable room , RongRTCCode code ))completion

Parameters

roomId

房间 Id(支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式 最长 64 个字符)
config

加入房间的配置，主要用于配置直播场景。
completion

加入房间回调,其中，room 对象中的 remoteUsers ，存储当前房间中的所有人，包括发布资源和没有发布资源的人。

Discussion

加入房间，可配置加入房间场景。

Declared In

RongRTCEngine.h

– leaveRoom:completion:

离开房间(注：离开房间时不需要调用取消资源发布和关闭摄像头，SDK 内部会做好取消发布和关闭摄像头资源释放逻辑)

- (void)leaveRoom:(NSString *)roomId completion:(void ( ^ ) ( BOOL isSuccess , RongRTCCode code ))completion

Parameters

roomId

房间 Id
completion

加入房间回调

Discussion

离开房间(注：离开房间时不需要调用取消资源发布和关闭摄像头，SDK 内部会做好取消发布和关闭摄像头资源释放逻辑)

Declared In

RongRTCEngine.h

– subscribeLiveAVStream:liveType:handler:

仅直播模式可用， 作为观众，直接观看主播的直播，无需加入房间，通过传入主播的 url，仅观众端可用。

- (void)subscribeLiveAVStream:(NSString *)url liveType:(RongRTCLiveType)liveType handler:(nullable RongRTCLiveCallback)handler

Parameters

url

主播直播的 url
liveType

当前直播类型
handler

动作的回调，会依次回调主播的 RongRTCLiveAVInputStream ，根据 streamType 区分是音频流还是视频流，如主播发布了音视频流，此回调会回调两次，分别为音频的 RongRTCLiveAVInputStream ， 和视频的 RongRTCLiveAVInputStream 。

Discussion

仅直播模式可用， 作为观众，直接观看主播的直播，无需加入房间，通过传入主播的 url，仅观众端可用。

Declared In

RongRTCEngine.h

– unsubscribeLiveAVStream:completion:

仅直播模式可用，作为观众，退出观看主播的直播，仅观众端使用。

- (void)unsubscribeLiveAVStream:(nullable NSString *)url completion:(void ( ^ ) ( BOOL isSuccess , RongRTCCode code ))completion

Parameters

url

主播直播的 url，如果为空，则为最后一次 subscribeLiveAVStream 接口传入的 url
completion

动作的回调

Discussion

仅直播模式可用，作为观众，退出观看主播的直播，仅观众端使用。

Declared In

RongRTCEngine.h

– getClientId

当前客户端全局唯一的 ID。

- (NSString *)getClientId

Discussion

当前客户端全局唯一的 ID。

Declared In

RongRTCEngine.h