RCRTCAudioMixer (release 5.1.16)

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

```
public abstract class RCRTCAudioMixer
extends Object
```
混音
混音功能支持将用户自定义的音频数据或音频文件与本地麦克风采集的音频数据进行混合，支持的用户自定义音频文件格式为：MP3、AAC、M4A、WAV

嵌套类概要

嵌套类
限定符和类型类和说明

static class RCRTCAudioMixer.MixingState

static class RCRTCAudioMixer.MixingStateReason

static class RCRTCAudioMixer.Mode
混音模式

嵌套类
限定符和类型	类和说明
`static class`	`RCRTCAudioMixer.MixingState`
`static class`	`RCRTCAudioMixer.MixingStateReason`
`static class`	`RCRTCAudioMixer.Mode` 混音模式

字段概要

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

static RCRTCAudioMixer mInstance

字段
限定符和类型	字段和说明
`static RCRTCAudioMixer`	`mInstance`

构造器概要

构造器
构造器和说明

RCRTCAudioMixer()

构造器
构造器和说明
`RCRTCAudioMixer()`

方法概要

所有方法静态方法实例方法抽象方法具体方法已过时的方法
限定符和类型	方法和说明
`abstract float`	`getCurrentPosition()` 获取混音当前进度
`abstract int`	`getDurationMillis()` 获取混音文件的总时长
`abstract int`	`getDurationMillis(String path)` 获取指定音频文件的总时长
`static RCRTCAudioMixer`	`getInstance()`
`abstract int`	`getMixingVolume()` 获取混音文件在对端播放音量
`abstract int`	`getPlaybackVolume()` 获取混音文件在本端的播放音量
`abstract void`	`pause()` 暂停混音
`abstract void`	`resume()` 继续混音
`abstract void`	`seekTo(float position)` 设置指定播放进度
`abstract void`	`setAudioDualMonoMode(AudioDualMonoMode mode)` Add from 5.1.13 设置混音声道模式
`abstract void`	`setAudioMixingStateChangeListener(RCRTCAudioMixingStateChangeListener listener)` 注册 AudioMixingStateChangeListener 监听混音结束回调
`abstract void`	`setMixingVolume(int vol)` 设置混音文件在对端播放音量，取值范围 [0-100]
`abstract void`	`setPlayback(boolean playback)` 设置本端是否播放混音文件
`abstract void`	`setPlaybackVolume(int vol)` 设置混音文件在本端的播放音量，取值范围 [0-100]
`abstract void`	`setVolume(int volume)` 同时设置混音文件在本端和对端的播放音量
`abstract boolean`	`start()` 已过时。
`abstract boolean`	`startMix(String path, RCRTCAudioMixer.Mode mode, boolean playback, int loopCount)` 将给定音频文件与麦克风混音发送至对端
`abstract boolean`	`startWrite()` Add from 5.1.11 开始write混音。
`abstract void`	`stop()` 停止混音
`abstract void`	`stopWrite()` Add from 5.1.11 结束write混音。
`abstract void`	`write(byte[] data, int sampleRate, int channelCount, int audioFormat, int volume, RCRTCAudioMixer.Mode mode)`

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

- 字段详细资料
  - mInstance
```
public static RCRTCAudioMixer mInstance
```
- 构造器详细资料
  - RCRTCAudioMixer
```
public RCRTCAudioMixer()
```
- 方法详细资料
  - getInstance
```
public static RCRTCAudioMixer getInstance()
```
  - startMix
```
public abstract boolean startMix(String path,
                                 RCRTCAudioMixer.Mode mode,
                                 boolean playback,
                                 int loopCount)
```
    将给定音频文件与麦克风混音发送至对端
    
    参数:
    
    path - 媒体文件路径
    
    mode - 混音模式，参考 RCRTCAudioMixer.Mode.NONE, RCRTCAudioMixer.Mode.MIX 和 RCRTCAudioMixer.Mode.REPLACE
    
    playback - 是否在本端播放
    
    loopCount - loopCount < 0 无限循环，loopCount > 0 循环 loopCount 次
    
    返回:
    
    失败返回 false
  - start
```
@Deprecated
public abstract boolean start()
```
    已过时。
    
    开始混音。在调用 write 接口开始混音前，必须调用此接口切换到开始状态。此方法5.1.11以废弃，请使用startWrite()
    
    返回:
  - startWrite
```
public abstract boolean startWrite()
```
    Add from 5.1.11
    开始write混音。在调用 write 接口开始混音前，必须调用此接口切换到开始状态。
    
    返回:
  - stopWrite
```
public abstract void stopWrite()
```
    Add from 5.1.11
    结束write混音。在调用 write 接口开始混音后，必须调用此接口结束混音。
  - write
```
public abstract void write(byte[] data,
                           int sampleRate,
                           int channelCount,
                           int audioFormat,
                           int volume,
                           RCRTCAudioMixer.Mode mode)
```
    参数:
    
    data - pcm 数据
    
    sampleRate - 采样率
    
    channelCount - 通道数
    
    audioFormat - 采样精度，参考 AudioFormat.ENCODING_PCM_8BIT, AudioFormat.ENCODING_PCM_16BIT, 和 AudioFormat.ENCODING_PCM_FLOAT
    
    volume - 混音音量
    
    mode - 混音模式，参考 RCRTCAudioMixer.Mode.MIX, RCRTCAudioMixer.Mode.REPLACE 和 RCRTCAudioMixer.Mode.NONE
  - setAudioMixingStateChangeListener
```
public abstract void setAudioMixingStateChangeListener(RCRTCAudioMixingStateChangeListener listener)
```
    注册 AudioMixingStateChangeListener 监听混音结束回调
    
    参数:
    
    listener -
  - setPlayback
```
public abstract void setPlayback(boolean playback)
```
    设置本端是否播放混音文件
    
    参数:
    
    playback - true，本端播放 false，本端不播放
  - setMixingVolume
```
public abstract void setMixingVolume(int vol)
```
    设置混音文件在对端播放音量，取值范围 [0-100]
  - getMixingVolume
```
public abstract int getMixingVolume()
```
    获取混音文件在对端播放音量
    
    返回:
    
    音量范围 [0,100]
  - setPlaybackVolume
```
public abstract void setPlaybackVolume(int vol)
```
    设置混音文件在本端的播放音量，取值范围 [0-100]
  - getPlaybackVolume
```
public abstract int getPlaybackVolume()
```
    获取混音文件在本端的播放音量
    
    返回:
    
    音量范围 [0,100]
  - getDurationMillis
```
public abstract int getDurationMillis()
```
    获取混音文件的总时长
  - getDurationMillis
```
public abstract int getDurationMillis(String path)
```
    获取指定音频文件的总时长
    
    参数:
    
    path - 文件路径
  - getCurrentPosition
```
public abstract float getCurrentPosition()
```
    获取混音当前进度
    
    返回:
    
    进度 [0.0,1.0]
  - seekTo
```
public abstract void seekTo(float position)
```
    设置指定播放进度
    
    参数:
    
    position - 进度 [0.0,1.0]
  - stop
```
public abstract void stop()
```
    停止混音
  - resume
```
public abstract void resume()
```
    继续混音
  - pause
```
public abstract void pause()
```
    暂停混音
  - setVolume
```
public abstract void setVolume(int volume)
```
    同时设置混音文件在本端和对端的播放音量
    
    参数:
    
    volume - 音量 [0,100]
  - setAudioDualMonoMode
```
public abstract void setAudioDualMonoMode(AudioDualMonoMode mode)
```
    Add from 5.1.13
    设置混音声道模式
    
    参数:
    
    mode - 声道模式 0 立体声混音, 1 左声道混音, 2 右声道混音

类 RCRTCAudioMixer

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

mInstance

构造器详细资料

RCRTCAudioMixer

方法详细资料

getInstance

startMix

start

startWrite

stopWrite

write

setAudioMixingStateChangeListener

setPlayback

setMixingVolume

getMixingVolume

setPlaybackVolume

getPlaybackVolume

getDurationMillis

getDurationMillis

getCurrentPosition

seekTo

stop

resume

pause

setVolume

setAudioDualMonoMode