RCRTCLocalUser Class Reference

Inherits from	RCRTCUser : NSObject
Declared in	RCRTCLocalUser.h

`localStreams`

本地用户发布的音视频流

@property (nonatomic, copy, readonly) NSArray<RCRTCOutputStream*> *DEPRECATED_MSG_ATTRIBUTE ( "use streams property instead" ) localStreams

Discussion

本地用户发布的音视频流

Declared In

RCRTCLocalUser.h

`streams`

本地用户发布的音视频流

@property (nonatomic, copy, readonly) NSArray<RCRTCOutputStream*> *streams

Discussion

本地用户发布的音视频流

Declared In

RCRTCLocalUser.h

`– setAttributeValue:forKey:message:completion:`

设置全局用户属性

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

Parameters

`attributeValue`	属性值
`key`	属性名称
`message`	是否在设置属性的时候携带消息内容，传空则不往房间中发送消息（也不会收到有用户属性变换的回调）
`completion`	设置完成回调 @discussion 设置用户属性 @remarks 房间管理

Discussion

设置全局用户属性

Declared In

RCRTCLocalUser.h

`– setAttribute:forKey:message:completion:`

设置全局用户属性

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

Parameters

`attributeValue`	属性值
`key`	属性名称
`message`	是否在设置属性的时候携带消息内容，传空则不往房间中发送消息（也不会收到有用户属性变换的回调）
`completion`	设置完成回调 @discussion 设置用户属性 @remarks 房间管理

Discussion

设置全局用户属性

Declared In

RCRTCLocalUser.h

`– deleteAttributes:message:completion:`

删除全局用户属性

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

Parameters

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

attributeKeys

属性名称数组

message

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

completion

删除完成回调 @discussion 删除用户属性

@remarks 房间管理

Discussion

删除全局用户属性

Declared In

RCRTCLocalUser.h

`– getAttributes:completion:`

获取全局用户属性

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

Parameters

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

attributeKeys

属性名称

completion

获取结果回调 @discussion 获取用户属性

@remarks 房间管理

Discussion

获取全局用户属性

Declared In

RCRTCLocalUser.h

`– setRole:completion:`

设置本地用户角色信息, 仅供融云服务统计用

- (void)setRole:(NSString *)role completion:(RCRTCOperationCallback)completion

Parameters

`role`	角色名称
`completion`	获取结果回调 @discussion 设置用户属性 @remarks 房间管理

role

角色名称

completion

获取结果回调 @discussion 设置用户属性

@remarks 房间管理

Discussion

设置本地用户角色信息, 仅供融云服务统计用

Declared In

RCRTCLocalUser.h

`– publishDefaultStreams:`

发布本地默认音视频流

- (void)publishDefaultStreams:(RCRTCOperationCallback)completion

Parameters

`completion`	发布完成回调 @discussion 发布默认音视频流 @remarks 资源管理

completion

发布完成回调 @discussion 发布默认音视频流

@remarks 资源管理

Discussion

发布本地默认音视频流

Declared In

RCRTCLocalUser.h

`– publishStream:completion:`

发布本地指定音视频流

- (void)publishStream:(nonnull RCRTCOutputStream *)stream completion:(nonnull RCRTCOperationCallback)completion

Parameters

`stream`	发布的音视频流
`completion`	发布的音视频流结果 @discussion 发布音视频流 @remarks 资源管理

stream

发布的音视频流

completion

发布的音视频流结果 @discussion 发布音视频流

@remarks 资源管理

Discussion

发布本地指定音视频流

Declared In

RCRTCLocalUser.h

`– publishStreams:completion:`

发布多路本地指定音视频流

- (void)publishStreams:(nonnull NSArray<RCRTCOutputStream*> *)streams completion:(nonnull RCRTCOperationCallback)completion

Parameters

`streams`	发布音视频流集合
`completion`	发布的音视频流结果 @discussion 发布多路音视频流 @remarks 资源管理

streams

发布音视频流集合

completion

发布的音视频流结果 @discussion 发布多路音视频流

@remarks 资源管理

Discussion

发布多路本地指定音视频流

Declared In

RCRTCLocalUser.h

`– publishDefaultLiveStreams:`

发布本地默认音视频流，直播模式专用

- (void)publishDefaultLiveStreams:(RCRTCLiveOperationCallback)completion

Parameters

`completion`	发布完成回调 @discussion 发布主播默认音视频流, 此接口仅直播模式的主播可用, 即 RCRTCRoomType 为 RCRTCRoomTypeLive 可用 @remarks 资源管理

completion

发布完成回调 @discussion 发布主播默认音视频流, 此接口仅直播模式的主播可用, 即 RCRTCRoomType 为 RCRTCRoomTypeLive 可用

@remarks 资源管理

Discussion

发布本地默认音视频流，直播模式专用

Declared In

RCRTCLocalUser.h

`– publishLiveStream:completion:`

发布本地指定音视频流，直播模式专用

- (void)publishLiveStream:(nonnull RCRTCOutputStream *)stream completion:(nonnull RCRTCLiveOperationCallback)completion

Parameters

`stream`	发布的音视频流
`completion`	发布的音视频流结果, 包括此主播的推流 url @discussion 发布直播音视频流, 此接口仅直播模式的主播可用, 即 RCRTCRoomType 为 RCRTCRoomTypeLive 可用 @remarks 资源管理

stream

发布的音视频流

completion

发布的音视频流结果, 包括此主播的推流 url @discussion 发布直播音视频流, 此接口仅直播模式的主播可用, 即 RCRTCRoomType 为 RCRTCRoomTypeLive 可用

@remarks 资源管理

Discussion

发布本地指定音视频流，直播模式专用

Declared In

RCRTCLocalUser.h

`– unpublishDefaultStreams:`

取消发布本地默认音视频流

- (void)unpublishDefaultStreams:(RCRTCOperationCallback)completion

Parameters

`completion`	取消发布完成回调 @discussion 取消发布默认音视频流 @remarks 资源管理

completion

取消发布完成回调 @discussion 取消发布默认音视频流

@remarks 资源管理

Discussion

取消发布本地默认音视频流

Declared In

RCRTCLocalUser.h

`– unpublishStream:completion:`

取消发布本地指定音视频流

- (void)unpublishStream:(nonnull RCRTCOutputStream *)stream completion:(nonnull RCRTCOperationCallback)completion

Parameters

`stream`	取消发布的音视频流
`completion`	发布的音视频流结果 @discussion 取消发布音视频流 @remarks 资源管理

stream

取消发布的音视频流

completion

发布的音视频流结果 @discussion 取消发布音视频流

@remarks 资源管理

Discussion

取消发布本地指定音视频流

Declared In

RCRTCLocalUser.h

`– unpublishStreams:completion:`

取消发布多路本地指定音视频流

- (void)unpublishStreams:(nonnull NSArray<RCRTCOutputStream*> *)streams completion:(nonnull RCRTCOperationCallback)completion

Parameters

`streams`	取消发布的音视频流集合
`completion`	发布的音视频流结果 @discussion 取消发布多路音视频流 @remarks 资源管理

streams

取消发布的音视频流集合

completion

发布的音视频流结果 @discussion 取消发布多路音视频流

@remarks 资源管理

Discussion

取消发布多路本地指定音视频流

Declared In

RCRTCLocalUser.h

`– unpublishDefaultLiveStreams:`

取消发布本地默认音视频流，直播模式专用

- (void)unpublishDefaultLiveStreams:(RCRTCOperationCallback)completion

Parameters

`completion`	取消发布完成回调 @discussion 取消发布默认音视频流，此接口仅直播模式的主播可用, 即 RCRTCRoomType 为 RCRTCRoomTypeLive 可用 @remarks 资源管理

completion

取消发布完成回调 @discussion 取消发布默认音视频流，此接口仅直播模式的主播可用, 即 RCRTCRoomType 为 RCRTCRoomTypeLive 可用

@remarks 资源管理

Discussion

取消发布本地默认音视频流，直播模式专用

Declared In

RCRTCLocalUser.h

`– unpublishLiveStream:completion:`

取消发布本地指定音视频流，直播模式专用

- (void)unpublishLiveStream:(nonnull RCRTCOutputStream *)stream completion:(nonnull RCRTCOperationCallback)completion

Parameters

`stream`	取消发布的音视频流
`completion`	发布的音视频流结果 @discussion 取消发布音视频流，此接口仅直播模式的主播可用, 即 RCRTCRoomType 为 RCRTCRoomTypeLive 可用 @remarks 资源管理

stream

取消发布的音视频流

completion

发布的音视频流结果 @discussion 取消发布音视频流，此接口仅直播模式的主播可用, 即 RCRTCRoomType 为 RCRTCRoomTypeLive 可用

@remarks 资源管理

Discussion

取消发布本地指定音视频流，直播模式专用

Declared In

RCRTCLocalUser.h

`– subscribeStream:tinyStreams:completion:`

订阅多路远端指定音视频流

- (void)subscribeStream:(NSArray<RCRTCInputStream*> *)avStreams tinyStreams:(NSArray<RCRTCInputStream*> *)tinyStreams completion:(nonnull RCRTCOperationCallback)completion

Parameters

`avStreams`	普通流
`tinyStreams`	需要携带小流的流数组
`completion`	完成的回调 @discussion 订阅流 @remarks 资源管理

avStreams

普通流

tinyStreams

需要携带小流的流数组

completion

完成的回调 @discussion 订阅流

@remarks 资源管理

Discussion

订阅多路远端指定音视频流

同一个流只能填写在 avStreams 或 tinyStreams 中的一个数组中

Declared In

RCRTCLocalUser.h

`– unsubscribeStream:completion:`

取消订阅远端指定音视频流

- (void)unsubscribeStream:(nonnull RCRTCInputStream *)stream completion:(nonnull RCRTCOperationCallback)completion

Parameters

`stream`	音视频流
`completion`	音视频流结果 @discussion 取消订阅音视频流 @remarks 资源管理

stream

音视频流

completion

音视频流结果 @discussion 取消订阅音视频流

@remarks 资源管理

Discussion

取消订阅远端指定音视频流

Declared In

RCRTCLocalUser.h

`– unsubscribeStreams:completion:`

取消订阅多路远端指定音视频流

- (void)unsubscribeStreams:(nonnull NSArray<RCRTCInputStream*> *)streams completion:(nonnull RCRTCOperationCallback)completion

Parameters

`streams`	音视频流集合
`completion`	音视频流结果 @discussion 取消订阅多路音视频流 @remarks 资源管理

streams

音视频流集合

completion

音视频流结果 @discussion 取消订阅多路音视频流

@remarks 资源管理

Discussion

取消订阅多路远端指定音视频流

Declared In

RCRTCLocalUser.h

`– requestJoinOtherRoom:userId:autoMix:extra:completion:`

向指定用户发送跨房间连麦请求

- (void)requestJoinOtherRoom:(NSString *)inviteeRoomId userId:(NSString *)inviteeUserId autoMix:(BOOL)autoMix extra:(NSString *)extra completion:(RCRTCOperationCallback)completion

Parameters

`inviteeRoomId`	被邀请人所在房间号
`inviteeUserId`	被邀请人userId
`autoMix`	是否将邀请人音视频资源发送到被邀请人房间中合流
`extra`	附加信息, 可随消息发送给被邀请人
`completion`	完成的回调 @discussion 仅供连麦使用 @remarks 资源管理

Discussion

向指定用户发送跨房间连麦请求

Declared In

RCRTCLocalUser.h

`– cancelRequestJoinOtherRoom:userId:extra:completion:`

取消正在进行中的跨房间连麦请求

- (void)cancelRequestJoinOtherRoom:(NSString *)inviteeRoomId userId:(NSString *)inviteeUserId extra:(NSString *)extra completion:(RCRTCOperationCallback)completion

Parameters

`inviteeRoomId`	被邀请人所在房间号
`inviteeUserId`	被邀请人userId
`extra`	附加信息, 可随消息发送给被邀请人
`completion`	完成的回调 @discussion 仅供连麦使用 @remarks 资源管理

Discussion

取消正在进行中的跨房间连麦请求

Declared In

RCRTCLocalUser.h

`– responseJoinOtherRoom:userId:agree:autoMix:extra:completion:`

响应跨房间连麦请求

- (void)responseJoinOtherRoom:(NSString *)inviterRoomId userId:(NSString *)inviterUserId agree:(BOOL)agree autoMix:(BOOL)autoMix extra:(NSString *)extra completion:(RCRTCOperationCallback)completion

Parameters

`inviterRoomId`	邀请人所在的房间号
`inviterUserId`	邀请人userId
`agree`	是否同意加入副房间
`autoMix`	是否将被邀请人音视频资源发送到邀请人房间中合流
`extra`	附加信息, 可随消息发送给邀请人
`completion`	完成的回调 @discussion 取消订阅多路音视频流 @remarks 资源管理

Discussion

响应跨房间连麦请求

Declared In

RCRTCLocalUser.h

RCRTCLocalUser Class Reference

Overview

Discussion

Declared In

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In