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

Instance Methods

(void) - enterRoomWithUserNick:
 
(void) - enterRoomWithUserNick:extension:
 
(void) - leaveRoom
 
(void) - getRoomDetail:
 
(void) - updateRoomTitle:onSuccess:onFailure:
 
(void) - updateRoomNotice:onSuccess:onFailure:
 
(void) - getRoomUserListWithPageNum:pageSize:onSuccess:onFailure:
 
(void) - kickRoomUserWithUserID:onSuccess:onFailure:
 
(void) - kickRoomUserWithUserID:kickedSeconds:onSuccess:onFailure:
 

Properties

id< AIRBRoomChannelDelegatedelegate
 
id< AIRBChatProtocolchat
 
id< AIRBLivePusherProtocollivePusher
 
id< AIRBLivePlayerProtocollivePlayer
 
id< AIRBVodPlayerProtocolvodPlayer
 
id< AIRBRTCProtocolrtc
 
id< AIRBWhiteBoardProtocolwhiteboard
 
id< AIRBDocumentProtocoldocument
 

Method Documentation

◆ enterRoomWithUserNick:

- (void) enterRoomWithUserNick: (NSString *)  userNick

@abstract 进入房间

Parameters
userNick当前用户昵称,不能为空;

◆ enterRoomWithUserNick:extension:

- (void) enterRoomWithUserNick: (NSString *)  userNick
extension: (NSDictionary< NSString *, NSString * > *)  extension 

@abstract 进入房间

Parameters
userNick当前用户昵称,不能为空;
extension当前用户相关的自定义扩展信息

◆ getRoomDetail:

- (void) getRoomDetail: (void(^)(AIRBRoomBasicInfo *_Nullable roomDetail))  onGotten

获取房间详情信息

◆ getRoomUserListWithPageNum:pageSize:onSuccess:onFailure:

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

获取房间内人员列表

Parameters
pageNum分页index,从1开始
pageSize每页的数量
onSuccess成功的回调,结果见AIRBRoomChannelUserListResponse
onFailure失败的回调

◆ kickRoomUserWithUserID:kickedSeconds:onSuccess:onFailure:

- (void) kickRoomUserWithUserID: (nonnull NSString *)  kickUserID
kickedSeconds: (int32_t)  kickedSeconds
onSuccess: (void(^)(void))  onSuccess
onFailure: (void(^)(NSString *errorMessage))  onFailure 

从房间内踢出某人

Parameters
kickUserID被踢人的用户id
kickedSeconds踢出后不能再次进入当前房间的秒数
onSuccess成功的回调
onFailure失败的回调

◆ kickRoomUserWithUserID:onSuccess:onFailure:

- (void) kickRoomUserWithUserID: (nonnull NSString *)  kickUserID
onSuccess: (void(^)(void))  onSuccess
onFailure: (void(^)(NSString *errorMessage))  onFailure 

从房间内踢出某人

Parameters
kickUserID被踢人的用户id
onSuccess成功的回调
onFailure失败的回调

◆ leaveRoom

- (void) leaveRoom

离开房间

◆ updateRoomNotice:onSuccess:onFailure:

- (void) updateRoomNotice: (nonnull NSString *)  notice
onSuccess: (void(^)(void))  onSuccess
onFailure: (void(^)(NSString *errorMessage))  onFailure 

更新房间公告

Parameters
notice要更新的房间公告
onSuccess成功的回调
onFailure失败的回调

◆ updateRoomTitle:onSuccess:onFailure:

- (void) updateRoomTitle: (nonnull NSString *)  title
onSuccess: (void(^)(void))  onSuccess
onFailure: (void(^)(NSString *errorMessage))  onFailure 

更新房间标题

Parameters
title要更新的房间标题
onSuccess成功的回调
onFailure失败的回调

Property Documentation

◆ chat

- (id<AIRBChatProtocol>) chat
readwritenonatomicstrong

用来进行房间互动消息收发的实例,具体接口见AIRBChatProtocol,进入房间成功后才可使用

◆ delegate

- (id<AIRBRoomChannelDelegate>) delegate
readwritenonatomicweak

所有事件和错误的回调通知

◆ document

- (id<AIRBDocumentProtocol>) document
readwritenonatomicstrong

文档服务

◆ livePlayer

- (id<AIRBLivePlayerProtocol>) livePlayer
readwritenonatomicstrong

用来在房间内进行直播拉流的实例,具体接口见AIRBLivePlayerProtocol,进入房间成功后才可使用

◆ livePusher

- (id<AIRBLivePusherProtocol>) livePusher
readwritenonatomicstrong

用来进行房间内进行直播推流的实例,具体接口见AIRBLivePusherProtocol,进入房间成功后才可使用

◆ rtc

- (id<AIRBRTCProtocol>) rtc
readwritenonatomicstrong

用来在房间实时音视频通信活动的实例,具体接口见AIRBRTCProtocol,进入房间成功后才可使用

◆ vodPlayer

- (id<AIRBVodPlayerProtocol>) vodPlayer
readwritenonatomicstrong

用来在房间内进行点播的实例,具体接口见AIRBVodPlayerProtocol,进入房间成功后才可使用

◆ whiteboard

- (id<AIRBWhiteBoardProtocol>) whiteboard
readwritenonatomicstrong

用来进行房间查看或操作的白板实例,具体接口见AIRBWhiteBoardProtocol,进入房间成功后才可使用


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