Skip to content
Ju Liaoyuan edited this page Dec 20, 2022 · 1 revision

SRRoom Class Reference

  Inherits from NSObject
  Declared in SRRoom.h

SRRoom.m

Tasks

Other Methods

– enterRoom:

– leaveRoom

– onKickOutRoom

– createRoomWithModel:

– openRoomWithModel:

– closeRoomWithModel:

– registerWithPlugin:

– unregisterWithPlugin:

– getPluginWith:

– registerWithSDKPlugin:

– unregisterWithSDKPlugin:

– registerWithSDKPluginClass:

– unregisterWithSDKPluginClass:

– getSDKPluginWith:

– updateConfigWithModel:

– setDeviceMode:

Other Methods

  conn property

  audio property

  bgm property

  admin property

  configModel property

  defaultDeviceMode property

Properties

admin

房间管理相关操作

@property (nonatomic, strong, readonly) SRRoomAdmin *admin

Discussion

房间管理相关操作

Declared In

  • SRRoom.h

audio

房间流相关操作

@property (nonatomic, strong, readonly) SRRoomAudio *audio

Discussion

房间流相关操作

Declared In

  • SRRoom.h

bgm

房间bgm相关操作

@property (nonatomic, strong, readonly) SRRoomBgm *bgm

Discussion

房间bgm相关操作

Declared In

  • SRRoom.h

configModel

房间配置

@property (nonatomic, strong, readonly) SNConfigModel *configModel

Discussion

房间配置

Declared In

  • SRRoom.h

conn

/ 房间消息相关操作

@property (nonatomic, strong, readonly) SRRoomConn *conn

Discussion

/ 房间消息相关操作

Declared In

  • SRRoom.h

defaultDeviceMode

设置初始 DeviceMode,默认是 SRDeviceModeGeneral 如果想在推流过程中更改 deviceModel,可以通过 setDeivceMode: 来设置

@property (nonatomic, assign) SRDeviceMode defaultDeviceMode

Discussion

设置初始 DeviceMode,默认是 SRDeviceModeGeneral 如果想在推流过程中更改 deviceModel,可以通过 setDeivceMode: 来设置

Declared In

  • SRRoom.h

Instance Methods

closeRoomWithModel:

关闭房间

- (RACSignal *)closeRoomWithModel:(SRCloseRoomModel *)*model*

Parameters

model
   参数模型, @see SRCloseRoomModel

Discussion

关闭房间

Declared In

  • SRRoom.h

createRoomWithModel:

创建房间

- (RACSignal *)createRoomWithModel:(SRCreateRoomModel *)*model*

Parameters

model
   参数模型。

Return Value

返回创建房间结果,成功时的具体参数参见 @see SNConfigModel

Discussion

创建房间

Declared In

  • SRRoom.h

enterRoom:

进入房间

- (RACSignal *)enterRoom:(SREnterRoomModel *)*model*

Parameters

model
   进房数据模型, @see SREnterRoomModel

Return Value

进房结果,这里会以 code 来区分房间类型(IM or Audio), @see SRRoomEnterResult

Discussion

进入房间

Declared In

  • SRRoom.h

getPluginWith:

获取业务plugin

- (id<SRRoomPluginProtocol>)getPluginWith:(Class)*cls*

Parameters

cls
   类名

Return Value

与 cls 匹配的 plugin

Discussion

获取业务plugin

Declared In

  • SRRoom.h

getSDKPluginWith:

获取sdk plugin

- (id<SNSDKPluginProtocol>)getSDKPluginWith:(SNSDKPluginType)*pluginType*

Discussion

获取sdk plugin

Declared In

  • SRRoom.h

leaveRoom

离开房间

- (RACSignal *)leaveRoom

Return Value

离开房间结果,这里会以 code 来区分房间类型(IM or Audio), @see SRRoomLeaveResult

Discussion

离开房间

Declared In

  • SRRoom.h

onKickOutRoom

用户被踢出房间

- (RACSubject *)onKickOutRoom

Return Value

踢出房间的错误,RACTuple类型,元素均为 NSNumber 类型. 第一个元素为被踢出的原因(枚举值,详见 @see SRRoomBeKickedType); 第二个元素为具体的 code.

Discussion

用户被踢出房间

Declared In

  • SRRoom.h

openRoomWithModel:

开启房间

- (RACSignal *)openRoomWithModel:(SROpenRoomModel *)*model*

Parameters

model
   参数模型,@see SROpenRoomModel

Discussion

开启房间

Declared In

  • SRRoom.h

registerWithPlugin:

注册业务plugin

- (void)registerWithPlugin:(id<SRRoomPluginProtocol>)*plugin*

Parameters

plugin
   需要实现的协议

Discussion

注册业务plugin

Declared In

  • SRRoom.h

registerWithSDKPlugin:

注册 sdk plugin

- (void)registerWithSDKPlugin:(id<SNSDKPluginProtocol>)*plugin*

Discussion

注册 sdk plugin

Declared In

  • SRRoom.h

registerWithSDKPluginClass:

注册sdk plugin Class

- (void)registerWithSDKPluginClass:(Class<SNSDKPluginProtocol>)*pluginClass*

Discussion

注册sdk plugin Class

Declared In

  • SRRoom.h

setDeviceMode:

设置上麦模式,请确保在 SonaRoom 进入成功后调用(即 enterRoom 方法回调 SRRoomEnterAudioSuccess 后)

- (void)setDeviceMode:(SRDeviceMode)*mode*

Parameters

mode
   模式,参见 @see SRDeviceMode,默认是 SRDeviceModeGeneral

Discussion

设置上麦模式,请确保在 SonaRoom 进入成功后调用(即 enterRoom 方法回调 SRRoomEnterAudioSuccess 后)

Declared In

  • SRRoom.h

unregisterWithPlugin:

注销业务plugin

- (void)unregisterWithPlugin:(id<SRRoomPluginProtocol>)*plugin*

Parameters

plugin
   需要实现的协议

Discussion

注销业务plugin

Declared In

  • SRRoom.h

unregisterWithSDKPlugin:

注销sdk plugin

- (void)unregisterWithSDKPlugin:(id<SNSDKPluginProtocol>)*plugin*

Discussion

注销sdk plugin

Declared In

  • SRRoom.h

unregisterWithSDKPluginClass:

注销sdk plugin Class

- (void)unregisterWithSDKPluginClass:(Class<SNSDKPluginProtocol>)*pluginClass*

Discussion

注销sdk plugin Class

Declared In

  • SRRoom.h

updateConfigWithModel:

更新配置

- (void)updateConfigWithModel:(SNConfigModel *)*model*

Parameters

model
   配置模型,@see SNConfigModel

Discussion

更新配置

Declared In

  • SRRoom.h
Clone this wiki locally