RCRTCBaseRoom Class Reference

Inherits from	NSObject
Declared in	RCRTCBaseRoom.h

`roomId`

房间ID

@property (nonatomic, copy, readonly) NSString *roomId

Discussion

房间ID

Declared In

RCRTCBaseRoom.h

`roomConfig`

加入房间时设置的房间配置

@property (nonatomic, strong, readonly, nullable) RCRTCRoomConfig *roomConfig

Discussion

加入房间时设置的房间配置

Declared In

RCRTCBaseRoom.h

`sessionId`

会话 id, 用于 server API，会话唯一标识

@property (nonatomic, copy, readonly, nullable) NSString *sessionId

Discussion

会话 id, 用于 server API，会话唯一标识

Declared In

RCRTCBaseRoom.h

`remoteUsers`

参与用户

@property (nonatomic, strong, readonly) NSArray<RCRTCRemoteUser*> *remoteUsers

Discussion

参与用户

Declared In

RCRTCBaseRoom.h

`userId`	用户 ID @discussion 根据用户 ID 获取房间内远端用户，不存在则返回 nil

`– sendMessage:success:error:`

发送消息

- (nullable RCMessage *)sendMessage:(RCMessageContent *)content success:(nullable void ( ^ ) ( long messageId ))successBlock error:(nullable void ( ^ ) ( NSInteger nErrorCode , long messageId ))errorBlock

Parameters

`content`	消息的内容
`successBlock`	消息发送成功的回调 [messageId:消息的ID]
`errorBlock`	消息发送失败的回调 [nErrorCode:发送失败的错误码,messageId:消息的ID] @discussion 该接口只能发送 persistentFlag 为 MessagePersistent_STATUS 的状态消息, 远端用户如果不在线则消息丢失, 自定义消息时下面标识一定要给出, 否则会导致消息发送失败 + (RCMessagePersistent)persistentFlag { return MessagePersistent_STATUS; } @remarks 房间管理

content

消息的内容

successBlock

消息发送成功的回调 [messageId:消息的ID]

errorBlock

消息发送失败的回调 [nErrorCode:发送失败的错误码,messageId:消息的ID] @discussion 该接口只能发送 persistentFlag 为 MessagePersistent_STATUS 的状态消息, 远端用户如果不在线则消息丢失, 自定义消息时下面标识一定要给出, 否则会导致消息发送失败 + (RCMessagePersistent)persistentFlag { return MessagePersistent_STATUS; }

@remarks 房间管理

Return Value

发送的消息实体

Discussion

发送消息

Declared In

RCRTCBaseRoom.h

`– setRoomAttributeValue:forKey:message:completion:`

设置房间属性

- (void)setRoomAttributeValue:(NSString *)attributeValue forKey:(NSString *)key message:(nullable RCMessageContent *)message completion:(nullable RCRTCOperationCallback)completion DEPRECATED_MSG_ATTRIBUTE ( "use setAttribute:forKey:message:completion: API instead" )

Parameters

`attributeValue`	属性值
`key`	属性名称
`message`	是否在设置属性的时候携带消息内容, 传空则不往房间中发送消息
`completion`	设置完成回调 @discussion 设置房间属性 @remarks 房间管理

Discussion

设置房间属性

Declared In

RCRTCBaseRoom.h

`– setAttribute:forKey:message:completion:`

设置房间属性

- (void)setAttribute:(NSString *)attributeValue forKey:(NSString *)key message:(nullable RCMessageContent *)message completion:(nullable RCRTCOperationCallback)completion

Parameters

`attributeValue`	属性值
`key`	属性名称
`message`	是否在设置属性的时候携带消息内容, 传空则不往房间中发送消息
`completion`	设置完成回调 @discussion 设置房间属性 @remarks 房间管理

Discussion

设置房间属性

Declared In

RCRTCBaseRoom.h

`– deleteRoomAttributes:message:completion:`

删除房间属性

- (void)deleteRoomAttributes:(NSArray<NSString*> *)attributeKeys message:(nullable RCMessageContent *)message completion:(nullable RCRTCOperationCallback)completion DEPRECATED_MSG_ATTRIBUTE ( "use deleteAttributes:message:completion: API instead" )

Parameters

`attributeKeys`	属性名称数组
`message`	是否在设置属性的时候携带消息内容, 传空则不往房间中发送消息
`completion`	删除完成回调 @discussion 删除房间属性 @remarks 房间管理

attributeKeys

属性名称数组

message

是否在设置属性的时候携带消息内容, 传空则不往房间中发送消息

completion

删除完成回调 @discussion 删除房间属性

@remarks 房间管理

Discussion

删除房间属性

Declared In

RCRTCBaseRoom.h

`– deleteAttributes:message:completion:`

删除房间属性

- (void)deleteAttributes:(NSArray<NSString*> *)attributeKeys message:(nullable RCMessageContent *)message completion:(nullable RCRTCOperationCallback)completion

Parameters

`attributeKeys`	属性名称数组
`message`	是否在设置属性的时候携带消息内容, 传空则不往房间中发送消息
`completion`	删除完成回调 @discussion 删除房间属性 @remarks 房间管理

attributeKeys

属性名称数组

message

是否在设置属性的时候携带消息内容, 传空则不往房间中发送消息

completion

删除完成回调 @discussion 删除房间属性

@remarks 房间管理

Discussion

删除房间属性

Declared In

RCRTCBaseRoom.h

`– getRoomAttributes:completion:`

获取房间属性

- (void)getRoomAttributes:(NSArray<NSString*> *)attributeKeys completion:(nullable RCRTCAttributeOperationCallback)completion DEPRECATED_MSG_ATTRIBUTE ( "use getAttributes:completion: API instead" )

Parameters

`attributeKeys`	属性名称
`completion`	获取结果回调 @discussion 获取房间属性 @remarks 房间管理

attributeKeys

属性名称

completion

获取结果回调 @discussion 获取房间属性

@remarks 房间管理

Discussion

获取房间属性

Declared In

RCRTCBaseRoom.h

`– getAttributes:completion:`

获取房间属性

- (void)getAttributes:(NSArray<NSString*> *)attributeKeys completion:(nullable RCRTCAttributeOperationCallback)completion

Parameters

`attributeKeys`	属性名称
`completion`	获取结果回调 @discussion 获取房间属性 @remarks 房间管理

attributeKeys

属性名称

completion

获取结果回调 @discussion 获取房间属性

@remarks 房间管理

Discussion

获取房间属性

Declared In

RCRTCBaseRoom.h