IMP(低代码音视频工厂)SDK v1.5.0
IMP SDK API Reference Manual for iOS Platforms
AIRBRoomEngine Class Reference
Inheritance diagram for AIRBRoomEngine:

Instance Methods

(void) - globalInitOnceWithConfig:
 
(BOOL) - isInited
 
(void) - loginWithUserID:
 
(void) - logoutOnSuccess:onFailure:
 
(BOOL) - isLogined:
 
(nullable id< AIRBRoomChannelProtocol >) - getRoomChannelWithRoomID:
 
(void) - getRoomListWithPageNum:pageSize:onSuccess:onFailure:
 
(void) - getRoomDetailWithID:onSuccess:onFailure:
 
(id< AIRBRoomSceneLiveProtocol >) - getRoomSceneLive
 
(id< AIRBRoomSceneClassProtocol >) - getRoomSceneClass
 

Class Methods

(AIRBRoomEngine *) + sharedInstance
 

Properties

id< AIRBRoomEngineDelegatedelegate
 
AIRBLoggerLevel logLevel
 

Method Documentation

◆ getRoomChannelWithRoomID:

- (nullable id< AIRBRoomChannelProtocol >) getRoomChannelWithRoomID: (nonnull NSString *)  roomID

登陆成功后 ,获取RoomChannel实例

Parameters
roomID房间ID

◆ getRoomDetailWithID:onSuccess:onFailure:

- (void) getRoomDetailWithID: (NSString *)  roomID
onSuccess: (void(^)(AIRBRoomBasicInfo *_Nonnull info))  onSuccess
onFailure: (void(^)(NSString *errorMessage))  onFailure 

获取房间详细信息

Parameters
roomID房间ID

◆ getRoomListWithPageNum:pageSize:onSuccess:onFailure:

- (void) getRoomListWithPageNum: (int32_t)  pageNum
pageSize: (int32_t)  pageSize
onSuccess: (void(^)(AIRBRoomEngineRoomListResponse *_Nonnull response))  onSuccess
onFailure: (void(^)(NSString *errorMessage))  onFailure 

获取房间列表

Parameters
pageNum页码,从1开始
pageSize当前页面房间数量

◆ globalInitOnceWithConfig:

- (void) globalInitOnceWithConfig: (nonnull AIRBRoomEngineConfig *)  config

全局初始化,只需要调用一次

◆ isInited

- (BOOL) isInited

是否已全局初始化成功

◆ isLogined:

- (BOOL) isLogined: (NSString *)  userID

用户是否已登录

◆ loginWithUserID:

- (void) loginWithUserID: (nonnull NSString *)  userID

登录

Parameters
userID需要登陆的用户ID, 必须是阿拉伯数字或者英文字母或二者的混合
Note
旧版本登录接口的token参数通过请求token事件(onAIRBRoomEngineRequestToken:)的回调获取

◆ logoutOnSuccess:onFailure:

- (void) logoutOnSuccess: (void(^)(void))  onSuccess
onFailure: (void(^)(NSString *errorMessage))  onFailure 

登出当前已登录的用户

◆ sharedInstance

+ (AIRBRoomEngine *) sharedInstance

获取RoomEngine全局单例对象


The documentation for this class was generated from the following file: