RCRTCLocalUser (release 5.1.16)

所有超级接口:: RCRTCUser

public interface RCRTCLocalUser
extends RCRTCUser

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`void`	`cancelRequestJoinOtherRoom(String inviteeRoomId, String inviteeUserId, String extra, IRCRTCResultCallback callback)` 取消正在进行中的跨房间连麦请求
`boolean`	`containsStream(RCRTCOutputStream stream)` 判断该本地音视频流是否已发布
`void`	`deleteAttributes(List<String> attributeKeys, MessageContent message, IRCRTCResultCallback callback)` 删除全局用户属性
`void`	`getAttributes(List<String> attributeKeys, IRCRTCResultDataCallback<Map<String,String>> callback)` 获取全局用户属性
`RCRTCMicOutputStream`	`getDefaultAudioStream()` 默认本地音频流
`RCRTCCameraOutputStream`	`getDefaultVideoStream()` 本地默认视频流
`List<RCRTCOutputStream>`	`getStreams()` 获取本地用户发布的音视频流不含自定义视频流
`void`	`publishDefaultLiveStreams(IRCRTCResultDataCallback<RCRTCLiveInfo> callBack)` 发布本地默认音视频流，直播模式专用
`void`	`publishDefaultStreams(IRCRTCResultCallback callback)` 发布本地默认音视频流
`void`	`publishLiveStream(RCRTCOutputStream stream, IRCRTCResultDataCallback<RCRTCLiveInfo> callBack)` 发布本地指定音视频流，直播模式专用
`void`	`publishStream(RCRTCOutputStream stream, IRCRTCResultCallback callBack)` 发布本地指定音视频流
`void`	`publishStreams(List<? extends RCRTCOutputStream> streams, IRCRTCResultCallback callBack)` 发布多路本地指定音视频流
`void`	`requestJoinOtherRoom(String inviteeRoomId, String inviteeUserId, boolean inviterAutoMix, String extra, IRCRTCResultCallback callback)` 向指定用户发送跨房间连麦请求
`void`	`responseJoinOtherRoom(String inviterRoomId, String inviterUserId, boolean agree, boolean inviteeAutoMix, String extra, IRCRTCResultCallback callback)` 响应跨房间连麦请求
`void`	`setAttributeValue(String key, String value, MessageContent message, IRCRTCResultCallback callback)` 设置全局用户属性
`void`	`subscribeLiveUrl(String liveUrl, RCRTCAVStreamType avStreamType, RCRTCLiveCallback callBack)` 为兼容观众只能拿到 liveUrl 的情况下订阅直播提供的方法 1.
`void`	`subscribeStream(RCRTCInputStream stream, IRCRTCResultCallback callBack)` 订阅远端指定音视频流
`void`	`subscribeStreams(List<? extends RCRTCInputStream> streams, IRCRTCResultCallback callBack)` 订阅多路远端指定音视频流
`void`	`switchToAudience(IRCRTCSwitchRoleCallback callBack)` Added from 5.1.9 将当前角色切换为观众，切换成功后房间中其他主播会收到`IRCRTCRoomEventsListener.onSwitchRole(String, RCRTCLiveRole)`回调。
`void`	`switchToBroadcaster(List<? extends RCRTCOutputStream> publishStreams, IRCRTCSwitchRoleDataCallback<RCRTCLiveInfo> callBack)` Added from 5.1.9 将当前角色切换为主播，切换成功后房间中其他用户会收到`IRCRTCRoomEventsListener.onSwitchRole(String, RCRTCLiveRole)`回调。
`void`	`unpublishDefaultLiveStreams(IRCRTCResultCallback callback)` 取消发布本地默认音视频流，直播模式专用
`void`	`unpublishDefaultStreams(IRCRTCResultCallback callback)` 取消发布本地默认音视频流
`void`	`unpublishLiveStream(RCRTCOutputStream stream, IRCRTCResultCallback callback)` 发布本地指定音视频流，直播模式专用
`void`	`unpublishStream(RCRTCOutputStream stream, IRCRTCResultCallback callBack)` 取消发布本地指定音视频流
`void`	`unpublishStreams(List<RCRTCOutputStream> streams, IRCRTCResultCallback callBack)` 取消发布多路本地指定音视频流
`void`	`unsubscribeStream(RCRTCInputStream stream, IRCRTCResultCallback callBack)` 取消订阅远端指定音视频流
`void`	`unsubscribeStreams(List<? extends RCRTCInputStream> streams, IRCRTCResultCallback callBack)` 取消订阅多路远端指定音视频流

从接口继承的方法 cn.rongcloud.rtc.api.RCRTCUser
getUserId

- 方法详细资料
  - getStreams
```
List<RCRTCOutputStream> getStreams()
```
    获取本地用户发布的音视频流
    不含自定义视频流
    
    返回:
  - containsStream
```
boolean containsStream(RCRTCOutputStream stream)
```
    判断该本地音视频流是否已发布
    
    参数:
    
    stream - 要判断的流
    
    返回:
    
    true - 包含；false - 不包含
  - publishDefaultStreams
```
void publishDefaultStreams(IRCRTCResultCallback callback)
```
    发布本地默认音视频流
    
    参数:
    
    callback - 发布资源结果回调
  - publishDefaultLiveStreams
```
void publishDefaultLiveStreams(IRCRTCResultDataCallback<RCRTCLiveInfo> callBack)
```
    发布本地默认音视频流，直播模式专用
    
    参数:
    
    callBack - 发布资源结果回调
  - unpublishDefaultStreams
```
void unpublishDefaultStreams(IRCRTCResultCallback callback)
```
    取消发布本地默认音视频流
    
    参数:
    
    callback - 发布结果
  - unpublishDefaultLiveStreams
```
void unpublishDefaultLiveStreams(IRCRTCResultCallback callback)
```
    取消发布本地默认音视频流，直播模式专用
    
    参数:
    
    callback -
  - publishStreams
```
void publishStreams(List<? extends RCRTCOutputStream> streams,
                    IRCRTCResultCallback callBack)
```
    发布多路本地指定音视频流
    
    参数:
    
    streams - 音视频流集合
    
    callBack - 发布回调
  - unpublishStreams
```
void unpublishStreams(List<RCRTCOutputStream> streams,
                      IRCRTCResultCallback callBack)
```
    取消发布多路本地指定音视频流
    
    参数:
    
    streams - 音视频流集合
    
    callBack - 取消发布回调
  - publishStream
```
void publishStream(RCRTCOutputStream stream,
                   IRCRTCResultCallback callBack)
```
    发布本地指定音视频流
    
    参数:
    
    stream - 音视频流
    
    callBack - 发布回调
  - unpublishStream
```
void unpublishStream(RCRTCOutputStream stream,
                     IRCRTCResultCallback callBack)
```
    取消发布本地指定音视频流
    
    参数:
    
    stream - 音视频流
    
    callBack - 取消发布回调
  - publishLiveStream
```
void publishLiveStream(RCRTCOutputStream stream,
                       IRCRTCResultDataCallback<RCRTCLiveInfo> callBack)
```
    发布本地指定音视频流，直播模式专用
    
    参数:
    
    stream - 音视频流
    
    callBack - 发布回调
  - unpublishLiveStream
```
void unpublishLiveStream(RCRTCOutputStream stream,
                         IRCRTCResultCallback callback)
```
    发布本地指定音视频流，直播模式专用
    
    参数:
    
    stream -
    
    callback -
  - subscribeStreams
```
void subscribeStreams(List<? extends RCRTCInputStream> streams,
                      IRCRTCResultCallback callBack)
```
    订阅多路远端指定音视频流
    
    参数:
    
    streams - 音视频流集合
    
    callBack - 订阅回调
  - subscribeStream
```
void subscribeStream(RCRTCInputStream stream,
                     IRCRTCResultCallback callBack)
```
    订阅远端指定音视频流
    
    参数:
    
    stream - 音视频流
    
    callBack - 订阅回调
  - unsubscribeStreams
```
void unsubscribeStreams(List<? extends RCRTCInputStream> streams,
                        IRCRTCResultCallback callBack)
```
    取消订阅多路远端指定音视频流
    
    参数:
    
    streams - 音视频流集合
    
    callBack - 取消订阅回调
  - unsubscribeStream
```
void unsubscribeStream(RCRTCInputStream stream,
                       IRCRTCResultCallback callBack)
```
    取消订阅远端指定音视频流
    
    参数:
    
    stream - 音视频流
    
    callBack - 取消订阅回调
  - setAttributeValue
```
void setAttributeValue(String key,
                       String value,
                       MessageContent message,
                       IRCRTCResultCallback callback)
```
    设置全局用户属性
    
    参数:
    
    value - 属性值
    
    key - 属性名称
    
    message - 是否在设置属性的时候携带消息内容，传空则不往房间中发送消息
    
    callback - 设置完成回调
  - deleteAttributes
```
void deleteAttributes(List<String> attributeKeys,
                      MessageContent message,
                      IRCRTCResultCallback callback)
```
    删除全局用户属性
    
    参数:
    
    attributeKeys - 属性名称数组
    
    message - 是否在设置属性的时候携带消息内容，传空则不往房间中发送消息
    
    callback - 删除完成回调
  - getAttributes
```
void getAttributes(List<String> attributeKeys,
                   IRCRTCResultDataCallback<Map<String,String>> callback)
```
    获取全局用户属性
    
    参数:
    
    attributeKeys - 属性名称
    
    callback - 获取结果回调IRCRTCResultDataCallback
  - getDefaultVideoStream
```
RCRTCCameraOutputStream getDefaultVideoStream()
```
    本地默认视频流
    
    返回:
  - getDefaultAudioStream
```
RCRTCMicOutputStream getDefaultAudioStream()
```
    默认本地音频流
  - requestJoinOtherRoom
```
void requestJoinOtherRoom(String inviteeRoomId,
                          String inviteeUserId,
                          boolean inviterAutoMix,
                          String extra,
                          IRCRTCResultCallback callback)
```
    向指定用户发送跨房间连麦请求
    
    参数:
    
    inviteeRoomId - 被邀请者所在房间 id
    
    inviteeUserId - 被邀请用户 id
    
    inviterAutoMix - 是否将邀请者音视频资源发送到被邀请人房间中合流
    1: inviterAutoMix为true时： 1.1：如果被邀请方在加入邀请方房间之前发布了资源，当被邀请方加入邀请者房间成功后，服务器会把被邀请方流资源合并到邀请方视图 ·（默认仅悬浮布局合流）上。 1.2：如果被邀请方在加入邀请方房间之前没有发布过资源，将会在被邀请方发布资源成功后，服务器会把被邀请方流资源合并到邀请方视图（默认仅悬浮布局合流）上。 2:无论为true或false，双方都可以使用RCRTCLiveInfo.setMixConfig(RCRTCMixConfig, IRCRTCResultCallback) 方法主动设置合流布局。一旦主动设置过合流布局，后续音视频直播过程中设置的自动合流参数将失效。
    
    extra - 扩展字段，默认为空
    
    callback - 发送回调
  - cancelRequestJoinOtherRoom
```
void cancelRequestJoinOtherRoom(String inviteeRoomId,
                                String inviteeUserId,
                                String extra,
                                IRCRTCResultCallback callback)
```
    取消正在进行中的跨房间连麦请求
    
    参数:
    
    inviteeRoomId - 被邀请者所在房间 id
    
    inviteeUserId - 被邀请者用户 id
    
    extra - 扩展字段，默认为空
    
    callback - 发送回调
  - responseJoinOtherRoom
```
void responseJoinOtherRoom(String inviterRoomId,
                           String inviterUserId,
                           boolean agree,
                           boolean inviteeAutoMix,
                           String extra,
                           IRCRTCResultCallback callback)
```
    响应跨房间连麦请求
    
    参数:
    
    inviterRoomId - 邀请者所在房间 id，
    
    inviterUserId - 邀请者用户 id
    
    agree - 被邀请者是否同意连麦邀请
    
    inviteeAutoMix - 是否将被邀请者音视频资源发送到邀请人房间中合流
    1：inviteeAutoMix 为true时： 1.1：如果邀请方在发送连麦请求之前发布了资源，当被邀请方加入邀请者房间成功后，服务器会把邀请方流资源合并到被邀请方视图（默认仅悬浮布局合流）上。 1.2：如果邀请方在发送连麦请求之前没有发布资源，将会在邀请方发布资源成功后，服务器才会把邀请方的资源合并到被邀请方视图（默认仅悬浮布局合流）上。 2: 无论为true或false，双方都可以使用RCRTCLiveInfo.setMixConfig(RCRTCMixConfig, IRCRTCResultCallback) 方法主动设置合流布局。一旦主动设置过合流布局，后续音视频直播过程中设置的自动合流参数将失效。
    
    extra - 扩展字段，默认为空
    
    callback - 发送回调
  - subscribeLiveUrl
```
void subscribeLiveUrl(String liveUrl,
                      RCRTCAVStreamType avStreamType,
                      RCRTCLiveCallback callBack)
```
    为兼容观众只能拿到 liveUrl 的情况下订阅直播提供的方法
    1. 如果可以通过RCRTCRoom.getLiveStreams() 方法拿到直播流,推荐使用subscribeStreams(List, IRCRTCResultCallback) 方法来订阅直播 2. 取消订阅直播: 通过RCRTCRoom.getLiveStreams() 方法拿到所有的直播流，并将指定要取消的 Stream 对象传给unsubscribeStreams(List, IRCRTCResultCallback) 方法即可完成取消订阅操作
    Added from 5.1.1.3
    
    参数:
    
    liveUrl - 直播地址
    
    avStreamType - 订阅流类型
    
    callBack - 订阅结果回调
  - switchToAudience
```
void switchToAudience(IRCRTCSwitchRoleCallback callBack)
```
    Added from 5.1.9
    将当前角色切换为观众，切换成功后房间中其他主播会收到IRCRTCRoomEventsListener.onSwitchRole(String, RCRTCLiveRole)回调。房间中其他观众会收到IRCRTCRoomEventsListener.onUserLeft(RCRTCRemoteUser)
    1. 如果当前用户加入了 RCRTCOtherRoom，切换为观众时。RTC SDK 内部会帮其退出所有 RCRTCOtherRoom。不会结束本次连麦。 2. 当切换失败且不影响当前角色继续音视频时，会回调IRCRTCFailedCallback.onFailed(RTCErrorCode) 3. 当切换失败且SDK处于无法回退状态时，会回调IRCRTCKickedCallback.onKicked() 。SDK内部会退出房间并清理所有资源，该用户只能重新加入房间才能继续音视频。 4. 角色切换之后会保留注册的RCRTCEngine.registerEventListener(cn.rongcloud.rtc.api.callback.IRCRTCEngineEventListener)、RCRTCEngine.registerStatusReportListener(cn.rongcloud.rtc.api.callback.IRCRTCStatusReportListener)和RCRTCRoom.registerRoomListener(cn.rongcloud.rtc.api.callback.IRCRTCRoomEventsListener)等 RTC SDK 全局类型的监听。其他监听需要切换角色成功后重新注册才能使用。
    
    参数:
    
    callBack -
  - switchToBroadcaster
```
void switchToBroadcaster(List<? extends RCRTCOutputStream> publishStreams,
                         IRCRTCSwitchRoleDataCallback<RCRTCLiveInfo> callBack)
```
    Added from 5.1.9
    将当前角色切换为主播，切换成功后房间中其他用户会收到IRCRTCRoomEventsListener.onSwitchRole(String, RCRTCLiveRole)回调。房间中其他观众会收到IRCRTCRoomEventsListener.onUserJoined(RCRTCRemoteUser)
    1. 当切换失败且不影响当前角色继续音视频时，会回调IRCRTCFailedCallback.onFailed(RTCErrorCode) 2. 当切换失败且SDK处于无法回退状态时，会回调IRCRTCKickedCallback.onKicked() 。SDK内部会退出房间并清理所有资源，该用户只能重新加入房间才能继续音视频。 3. 角色切换之后会保留注册的RCRTCEngine.registerEventListener(cn.rongcloud.rtc.api.callback.IRCRTCEngineEventListener)、RCRTCEngine.registerStatusReportListener(cn.rongcloud.rtc.api.callback.IRCRTCStatusReportListener)和RCRTCRoom.registerRoomListener(cn.rongcloud.rtc.api.callback.IRCRTCRoomEventsListener)等 RTC SDK 全局类型的监听。其他监听需要切换角色成功后重新注册才能使用。
    
    参数:
    
    publishStreams - 切换为主播成功后，需要发布的资源；默认为:null
    
    callBack -

接口 RCRTCLocalUser

方法概要

从接口继承的方法 cn.rongcloud.rtc.api.RCRTCUser

方法详细资料

getStreams

containsStream

publishDefaultStreams

publishDefaultLiveStreams

unpublishDefaultStreams

unpublishDefaultLiveStreams

publishStreams

unpublishStreams

publishStream

unpublishStream

publishLiveStream

unpublishLiveStream

subscribeStreams

subscribeStream

unsubscribeStreams

unsubscribeStream

setAttributeValue

deleteAttributes

getAttributes

getDefaultVideoStream

getDefaultAudioStream

requestJoinOtherRoom

cancelRequestJoinOtherRoom

responseJoinOtherRoom

subscribeLiveUrl

switchToAudience

switchToBroadcaster