RCRTCMixConfig (release 5.1.16)

java.lang.Object
- cn.rongcloud.rtc.api.RCRTCMixConfig

所有已实现的接口:: Parcelable

public class RCRTCMixConfig
extends Object
implements Parcelable

Created by wangw on 2019-10-11.

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`RCRTCMixConfig.CustomLayoutList`
`static class`	`RCRTCMixConfig.MediaConfig`
`static class`	`RCRTCMixConfig.MixLayoutMode`
`static class`	`RCRTCMixConfig.VideoRenderMode`

从接口继承的嵌套类/接口 android.os.Parcelable
Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

字段概要

字段
限定符和类型字段和说明

static Parcelable.Creator<RCRTCMixConfig> CREATOR
- 从接口继承的字段 android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

字段
限定符和类型	字段和说明
`static Parcelable.Creator<RCRTCMixConfig>`	`CREATOR`

构造器概要

构造器
限定符	构造器和说明
	`RCRTCMixConfig()` 设置合流布局专用
	`RCRTCMixConfig(List<RCRTCMixConfig.MediaConfig.CDNPushUrl> urls)` 设置 MCU 合流布局，为 CDN 推流专用
`protected`	`RCRTCMixConfig(Parcel in)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`int`	`describeContents()`
`List<RCRTCMixConfig.CustomLayoutList.CustomLayout>`	`getCustomLayouts()`
`String`	`getHostStreamId()`
`String`	`getHostUserId()`
`List<String>`	`getInputFilterMixRooms()`
`RCRTCMixConfig.MixLayoutMode`	`getLayoutMode()` 获取合流布局模式
`RCRTCMixConfig.MediaConfig`	`getMediaConfig()`
`RCMixInputFilterMode`	`getMixInputFilterMode()`
`int`	`getVersion()`
`boolean`	`isCustomMode()`
`void`	`setCustomLayouts(List<RCRTCMixConfig.CustomLayoutList.CustomLayout> customLayouts)`
`void`	`setCustomMixAudio(List<RCRTCMixConfig.CustomLayoutList.CustomMixAudio> customMixAudioList)` 传入需要MCU合并的音频流数据
`void`	`setCustomMode(boolean customMode)` 主播控制本房间观众是否能听到对方主播声音 1.customMode 参数设置为 true 时： 1.1.当没有设置`setCustomMixAudio(List)`参数时,房间中所有音频流会自动合并，观众能听到所有主播声音。
`void`	`setHostVideoStream(RCRTCStream stream)` 当做背景的Video Stream 注意: stream 类型必须是VideoStream
`void`	`setLayoutMode(RCRTCMixConfig.MixLayoutMode mode)` 设置合流布局模式
`void`	`setMediaConfig(RCRTCMixConfig.MediaConfig mediaConfig)`
`void`	`setMixInputFilterByRoomIds(List<String> roomIds, RCRTCMixMediaType mediaType, boolean isAppend)` 设置 MCU 混流配置
`void`	`setMixInputFilterByStreams(List<RCRTCMixConfig.CustomLayoutList.CustomLayout> videoList, List<RCRTCMixConfig.CustomLayoutList.CustomMixAudio> audioList)` 设置 MCU 混流配置
`void`	`writeToParcel(Parcel dest, int flags)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - CREATOR
```
public static final Parcelable.Creator<RCRTCMixConfig> CREATOR
```
- 构造器详细资料
  - RCRTCMixConfig
```
public RCRTCMixConfig(List<RCRTCMixConfig.MediaConfig.CDNPushUrl> urls)
```
    设置 MCU 合流布局，为 CDN 推流专用
  - RCRTCMixConfig
```
public RCRTCMixConfig()
```
    设置合流布局专用
  - RCRTCMixConfig
```
protected RCRTCMixConfig(Parcel in)
```
- 方法详细资料
  - isCustomMode
```
public boolean isCustomMode()
```
  - setCustomMode
```
public void setCustomMode(boolean customMode)
```
    主播控制本房间观众是否能听到对方主播声音 1.customMode 参数设置为 true 时： 1.1.当没有设置setCustomMixAudio(List)参数时,房间中所有音频流会自动合并，观众能听到所有主播声音。 1.2.当设置setCustomMixAudio(List)参数为没有数据的集合(new ArrayList(16);)时，不合并音频流，观众仅能听见本房间主播声音。 1.3.当设置setCustomMixAudio(List)参数不为空时，会将RCRTCMixConfig.CustomLayoutList.CustomMixAudio.setAudioStream(RCRTCStream)设置的音频流合流到直播流中，观众就能听到合并的音频。 1.4.当没有设置setCustomLayouts(List)参数时,且已经设置setLayoutMode(MixLayoutMode)参数，即按照合流布局合流。 1.5.当设置setCustomLayouts(List)}参数为没有数据的集合(new ArrayList(16))时，所有人视频频都不合流。观众仅能看见本地主播视频。 1.6.当已经设置setCustomLayouts(List)}参数且setLayoutMode(MixLayoutMode)参数为 SUSPENSION 或 ADAPTIVE 时，按传入的RCRTCMixConfig.CustomLayoutList.setCustomLayouts(List)视频流合流。 1.7.当已经设置setCustomLayouts(List)}参数且setLayoutMode(MixLayoutMode)参数为 CUSTOM 时，按传入的RCRTCMixConfig.CustomLayoutList.setCustomLayouts(List) 视频流和合流布局进行合流。 2.customMode 参数设置为 false 时：全部合并所有主播音频流，视频流合并逻辑按照setLayoutMode(MixLayoutMode) 参数合并。如果参数 setLayoutMode(MixLayoutMode) 为 CUSTOM 时，视频合流逻辑按照设置的setCustomLayouts(List)} 集合合并。
    
    参数:
    
    customMode - 默认true
  - setMixInputFilterByStreams
```
public void setMixInputFilterByStreams(List<RCRTCMixConfig.CustomLayoutList.CustomLayout> videoList,
                                       List<RCRTCMixConfig.CustomLayoutList.CustomMixAudio> audioList)
```
    设置 MCU 混流配置
    
    参数:
    
    videoList - 视频输入混流列表，为 null 代表视频全混流，为空集合代表视频全不混流，否则按照输入列表进行混流
    
    audioList - 音频输入混流列表，为 null 代表音频全混流，为空集合代表音频全不混流，否则按照输入列表进行混流
  - setMixInputFilterByRoomIds
```
public void setMixInputFilterByRoomIds(List<String> roomIds,
                                       RCRTCMixMediaType mediaType,
                                       boolean isAppend)
```
    设置 MCU 混流配置
    
    参数:
    
    roomIds - 混流房间列表
    
    mediaType - 混流媒体类型
    
    isAppend - 是否为增量混流。true 为增量混流； false为全量覆盖混流
  - getInputFilterMixRooms
```
public List<String> getInputFilterMixRooms()
```
  - getMixInputFilterMode
```
public RCMixInputFilterMode getMixInputFilterMode()
```
  - getVersion
```
public int getVersion()
```
  - getLayoutMode
```
public RCRTCMixConfig.MixLayoutMode getLayoutMode()
```
    获取合流布局模式
  - setLayoutMode
```
public void setLayoutMode(RCRTCMixConfig.MixLayoutMode mode)
```
    设置合流布局模式
  - getHostUserId
```
public String getHostUserId()
```
  - getHostStreamId
```
public String getHostStreamId()
```
  - setHostVideoStream
```
public void setHostVideoStream(RCRTCStream stream)
```
    当做背景的Video Stream 注意: stream 类型必须是VideoStream
    
    参数:
    
    stream - Stream.mediaType 必须是RCRTCMediaType.VIDEO
  - getMediaConfig
```
public RCRTCMixConfig.MediaConfig getMediaConfig()
```
  - setMediaConfig
```
public void setMediaConfig(RCRTCMixConfig.MediaConfig mediaConfig)
```
  - getCustomLayouts
```
public List<RCRTCMixConfig.CustomLayoutList.CustomLayout> getCustomLayouts()
```
  - setCustomLayouts
```
public void setCustomLayouts(List<RCRTCMixConfig.CustomLayoutList.CustomLayout> customLayouts)
```
  - setCustomMixAudio
```
public void setCustomMixAudio(List<RCRTCMixConfig.CustomLayoutList.CustomMixAudio> customMixAudioList)
```
    传入需要MCU合并的音频流数据
  - describeContents
```
public int describeContents()
```
    指定者:
    
    describeContents 在接口中 Parcelable
  - writeToParcel
```
public void writeToParcel(Parcel dest,
                          int flags)
```
    指定者:
    
    writeToParcel 在接口中 Parcelable

类 RCRTCMixConfig

嵌套类概要

从接口继承的嵌套类/接口 android.os.Parcelable

字段概要

从接口继承的字段 android.os.Parcelable

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

CREATOR

构造器详细资料

RCRTCMixConfig

RCRTCMixConfig

RCRTCMixConfig

方法详细资料

isCustomMode

setCustomMode

setMixInputFilterByStreams

setMixInputFilterByRoomIds

getInputFilterMixRooms

getMixInputFilterMode

getVersion

getLayoutMode

setLayoutMode

getHostUserId

getHostStreamId

setHostVideoStream

getMediaConfig

setMediaConfig

getCustomLayouts

setCustomLayouts

setCustomMixAudio

describeContents

writeToParcel