AudioBuffer

java.lang.Object
- com.sinovoice.hcicloudsdk.recorder.AudioBuffer

```
public final class AudioBuffer
extends java.lang.Object
```
音频缓冲区

音频录制模块在录音时会以稳定的速率持续产生录音数据，但其使用者可能无法保证以线性速率对录音数据进行消费，此时就会因消费不及时导致录音数据丢失。音频缓存可以通过缓存数据来避免这种情况的发生。

内部实现是一个 byte[] 环形缓冲区。

目前支持的功能
- 支持通道数选择，单通道（mono）或立体声（stereo）
- 采样格式支持8位，16位，24位，32位有符号整形
- 采样率支持 11025, 22050, 44100 和其他为 1000 整数倍的采样率
- 支持设置缓冲区大小，以时间为单位，最小 100ms, 最大 60s
- 支持阻塞/非阻塞式数据写入/读取
- 阻塞式写入/读取，可以设置等待时间
- 对写入/读取操作，均支持挂起（暂停）和取消挂起（暂停）操作
- 支持清空操作 flush()，可一次性清空缓存
- 支持关闭操作 close()，关闭后，所有处于阻塞中的操作将返回
- 支持事件通知，仅对感兴趣的事件进行通知
  - 数据写入通知 IAudioBufferHandler.onDataPut(int, long)
  - 数据读取通知 IAudioBufferHandler.onDataGet(int, long)
  - 缓冲区空通知 IAudioBufferHandler.onBufferEmpty()
  - 缓冲区满通知 IAudioBufferHandler.onBufferFull()
  - 写入操作挂起/取消挂起通知 IAudioBufferHandler.onPutPaused(boolean)
  - 读取操作挂起/取消挂起通知 IAudioBufferHandler.onGetPaused(boolean)
  - 缓冲区关闭通知 IAudioBufferHandler.onClosed()

字段概要

字段
限定符和类型	字段和说明
`int`	`bufferTime` 缓冲区长度，以时间为计量单位，单位：ms
`int`	`channels` 声音通道数量
`int`	`sampleBits` 采样位数，可以为 8, 16, 24, 32
`int`	`sampleBytes` 一个采样的字节数
`int`	`sampleRate` 采样率。

构造器概要

构造器
构造器和说明
`AudioBuffer(int channels, int sampleRate, int sampleBits, int bufferTime, IAudioBufferHandler handler)` 构造函数

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`long`	`bytesGet()` 已读取字节总数
`long`	`bytesPut()` 已写入字节总数
`void`	`close()` 关闭缓冲区。
`void`	`flush()` 清空缓冲区
`int`	`getData(byte[] data, int milliseconds)` 消费者从 AudioBuffer 中读取数据，若缓冲区空或者读取被挂起，则进行等待
`int`	`getData(byte[] data, int offset, int milliseconds)` 消费者从 AudioBuffer 中读取数据，若缓冲区空或者读取被挂起，则进行等待
`int`	`getData(byte[] data, int offset, int length, int milliseconds)` 消费者从 AudioBuffer 中读取数据，若缓冲区空或者读取被挂起，则进行等待
`int`	`getDataNB(byte[] data)` 消费者从 AudioBuffer 中读取数据，若缓冲区空或者读取被挂起，不进行等待
`int`	`getDataNB(byte[] data, int offset)` 消费者从 AudioBuffer 中读取数据，若缓冲区空或者读取被挂起，不进行等待
`int`	`getDataNB(byte[] data, int offset, int length)` 消费者从 AudioBuffer 中读取数据，若缓冲区空或者读取被挂起，不进行等待
`boolean`	`isClosed()` 缓冲区是否已关闭
`boolean`	`isEmpty()` 缓冲区是否为空
`boolean`	`isFull()` 缓冲区是否已满
`boolean`	`isGetPaused()`
`boolean`	`isPutPaused()`
`int`	`length()` 缓冲区内数据长度(字节数量)
`void`	`pauseGet()` 挂起数据读取(消费)，挂起后 getData 会读不到数据，即使缓冲区内有数据
`void`	`pausePut()` 挂起写入操作(生产)，挂起后 putData() 会无法写入数据，即使有足够的空间
`boolean`	`putData(byte[] data, int milliseconds)` 生产者向 AudioBuffer 内写入数据，若因写入挂起或空间不够时，则进行等待
`boolean`	`putData(byte[] data, int offset, int milliseconds)` 生产者向 AudioBuffer 内写入数据，若因写入挂起或空间不够时，则进行等待
`boolean`	`putData(byte[] data, int offset, int length, int milliseconds)` 生产者向 AudioBuffer 内写入数据，若因写入挂起或空间不够时，则进行等待
`boolean`	`putDataNB(byte[] data)` 生产者向 AudioBuffer 内写入数据，若空间不足或写入被挂起，不进行等待
`boolean`	`putDataNB(byte[] data, int offset)` 生产者向 AudioBuffer 内写入数据，若空间不足或写入被挂起，不进行等待
`boolean`	`putDataNB(byte[] data, int offset, int length)` 生产者向 AudioBuffer 内写入数据，若空间不足或写入被挂起，不进行等待
`void`	`resumeGet()` 取消数据读取挂起(允许继续消费)
`void`	`resumePut()` 取消数据写入挂起(允许继续生产)
`int`	`timeLength()` 缓冲数据时长，单位: ms

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

- 字段详细资料
  - sampleBits
```
public final int sampleBits
```
    采样位数，可以为 8, 16, 24, 32
  - channels
```
public final int channels
```
    声音通道数量
  - sampleRate
```
public final int sampleRate
```
    采样率。支持 11025, 22050, 44100 及其他为1000整数倍的采样率
  - bufferTime
```
public final int bufferTime
```
    缓冲区长度，以时间为计量单位，单位：ms
  - sampleBytes
```
public final int sampleBytes
```
    一个采样的字节数
- 构造器详细资料
  - AudioBuffer
```
public AudioBuffer(int channels,
                   int sampleRate,
                   int sampleBits,
                   int bufferTime,
                   IAudioBufferHandler handler)
```
    构造函数
    
    参数:
    
    channels - 声道数量
    
    sampleRate - 采样率
    
    sampleBits - 采样位数，可以为 8, 16, 24, 32
    
    bufferTime - 缓冲区长度，单位: ms，最小为 100ms，最长为 60s
    
    handler - 缓冲区事件回调接口，不能为 null
- 方法详细资料
  - bytesPut
```
public long bytesPut()
```
    已写入字节总数
    
    返回:
    
    已写入字节总数
  - bytesGet
```
public long bytesGet()
```
    已读取字节总数
    
    返回:
    
    已读取字节总数
  - close
```
public void close()
```
    关闭缓冲区。
    
    关闭后，缓冲区将不能被继续使用。
  - isClosed
```
public boolean isClosed()
```
    缓冲区是否已关闭
    
    返回:
    
    缓冲区是否已关闭
  - isEmpty
```
public boolean isEmpty()
```
    缓冲区是否为空
    
    返回:
    
    缓冲区是否为空
  - isFull
```
public boolean isFull()
```
    缓冲区是否已满
    
    返回:
    
    缓冲区是否已满
  - length
```
public int length()
```
    缓冲区内数据长度(字节数量)
    
    返回:
    
    缓冲区内数据长度(字节数量)
  - timeLength
```
public int timeLength()
```
    缓冲数据时长，单位: ms
    
    返回:
    
    缓冲数据时长，单位: ms
  - putDataNB
```
public boolean putDataNB(byte[] data)
```
    生产者向 AudioBuffer 内写入数据，若空间不足或写入被挂起，不进行等待
    
    参数:
    
    data - 音频数据
    
    返回:
    
    写入成功返回 true，否则返回 false (空间不足，写入被挂起或者被关闭)
  - putDataNB
```
public boolean putDataNB(byte[] data,
                         int offset)
```
    生产者向 AudioBuffer 内写入数据，若空间不足或写入被挂起，不进行等待
    
    参数:
    
    data - 音频数据
    
    offset - 写入 data 中的部分数据，起始位置为 offset，结束位置为 data 结尾
    
    返回:
    
    写入成功返回 true，否则返回 false (空间不足，写入被挂起或者被关闭)
  - putDataNB
```
public boolean putDataNB(byte[] data,
                         int offset,
                         int length)
```
    生产者向 AudioBuffer 内写入数据，若空间不足或写入被挂起，不进行等待
    
    参数:
    
    data - 音频数据
    
    offset - 写入 data 中的部分数据，起始位置为 offset
    
    length - 要写入数据的长度
    
    返回:
    
    写入成功返回 true，否则返回 false (空间不足，写入被挂起或者被关闭)
  - putData
```
public boolean putData(byte[] data,
                       int milliseconds)
```
    生产者向 AudioBuffer 内写入数据，若因写入挂起或空间不够时，则进行等待
    
    参数:
    
    data - 音频数据
    
    milliseconds - 等待的时间。传入 -1 表示一直等待，直到可以完成写入
    
    返回:
    
    写入成功返回 true，否则返回 false (等待超时或者被关闭)
  - putData
```
public boolean putData(byte[] data,
                       int offset,
                       int milliseconds)
```
    生产者向 AudioBuffer 内写入数据，若因写入挂起或空间不够时，则进行等待
    
    参数:
    
    data - 音频数据
    
    offset - 写入 data 中的部分数据，起始位置为 offset，结束位置为 data 结尾
    
    milliseconds - 等待的时间。传入 -1 表示一直等待，直到可以完成写入
    
    返回:
    
    写入成功返回 true，否则返回 false (等待超时或者被关闭)
  - putData
```
public boolean putData(byte[] data,
                       int offset,
                       int length,
                       int milliseconds)
```
    生产者向 AudioBuffer 内写入数据，若因写入挂起或空间不够时，则进行等待
    
    参数:
    
    data - 音频数据
    
    offset - 写入 data 中的部分数据，起始位置为 offset
    
    length - 要写入数据的长度
    
    milliseconds - 等待的时间。传入 -1 表示一直等待，直到可以完成写入
    
    返回:
    
    写入成功返回 true，否则返回 false (等待超时或者被关闭)
  - getDataNB
```
public int getDataNB(byte[] data)
```
    消费者从 AudioBuffer 中读取数据，若缓冲区空或者读取被挂起，不进行等待
    
    参数:
    
    data - 音频数据，用来保存读取的数据。写入区间 [0, data.length)
    
    返回:
    
    成功返回读取数据的长度，否则返回 0 (读取被挂起，缓冲区空或者被关闭)
  - getDataNB
```
public int getDataNB(byte[] data,
                     int offset)
```
    消费者从 AudioBuffer 中读取数据，若缓冲区空或者读取被挂起，不进行等待
    
    参数:
    
    data - 音频数据，用来保存读取的数据。写入区间 [offset, data.length)
    
    offset - 在 data 内的写入区间起始位置
    
    返回:
    
    成功返回读取数据的长度，否则返回 0 (读取被挂起，缓冲区空或者被关闭)
  - getDataNB
```
public int getDataNB(byte[] data,
                     int offset,
                     int length)
```
    消费者从 AudioBuffer 中读取数据，若缓冲区空或者读取被挂起，不进行等待
    
    参数:
    
    data - 音频数据，用来保存读取的数据。写入区间 [offset, offset + length)
    
    offset - 在 data 内的写入区间起始位置
    
    length - 待读取的长度
    
    返回:
    
    成功返回读取到数据的长度，否则返回 0 (读取被挂起，缓冲区空或者被关闭)
  - getData
```
public int getData(byte[] data,
                   int milliseconds)
```
    消费者从 AudioBuffer 中读取数据，若缓冲区空或者读取被挂起，则进行等待
    
    参数:
    
    data - 音频数据，用来保存读取的数据。写入区间 [0, data.length)
    
    milliseconds - 等待的时间。传入 -1 表示一直等待，直到可以完成读取
    
    返回:
    
    成功返回读取到数据的长度，否则返回 0 (等待超时或者被关闭)
  - getData
```
public int getData(byte[] data,
                   int offset,
                   int milliseconds)
```
    消费者从 AudioBuffer 中读取数据，若缓冲区空或者读取被挂起，则进行等待
    
    参数:
    
    data - 音频数据，用来保存读取的数据。写入区间 [offset, data.length)
    
    offset - 在 data 内的写入区间起始位置
    
    milliseconds - 等待的时间。传入 -1 表示一直等待，直到可以完成读取
    
    返回:
    
    成功返回读取到数据的长度，否则返回 0 (等待超时或者被关闭)
  - getData
```
public int getData(byte[] data,
                   int offset,
                   int length,
                   int milliseconds)
```
    消费者从 AudioBuffer 中读取数据，若缓冲区空或者读取被挂起，则进行等待
    
    参数:
    
    data - 音频数据，用来保存读取的数据。写入区间 [offset, offset + length)
    
    offset - 在 data 内的写入区间起始位置
    
    length - 待读取的长度
    
    milliseconds - 等待的时间。传入 -1 表示一直等待，直到可以完成读取
    
    返回:
    
    成功返回读取到数据的长度，否则返回 0 (等待超时或者被关闭)
  - flush
```
public void flush()
```
    清空缓冲区
  - pauseGet
```
public void pauseGet()
```
    挂起数据读取(消费)，挂起后 getData 会读不到数据，即使缓冲区内有数据
  - resumeGet
```
public void resumeGet()
```
    取消数据读取挂起(允许继续消费)
  - isGetPaused
```
public boolean isGetPaused()
```
    返回:
    
    读取是否被挂起
  - pausePut
```
public void pausePut()
```
    挂起写入操作(生产)，挂起后 putData() 会无法写入数据，即使有足够的空间
  - resumePut
```
public void resumePut()
```
    取消数据写入挂起(允许继续生产)
  - isPutPaused
```
public boolean isPutPaused()
```
    返回:
    
    写入是否被挂起

类 AudioBuffer

音频缓冲区

字段概要

构造器概要

方法概要

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

字段详细资料

sampleBits

channels

sampleRate

bufferTime

sampleBytes

构造器详细资料

AudioBuffer

方法详细资料

bytesPut

bytesGet

close

isClosed

isEmpty

isFull

length

timeLength

putDataNB

putDataNB

putDataNB

putData

putData

putData

getDataNB

getDataNB

getDataNB

getData

getData

getData

flush

pauseGet

resumeGet

isGetPaused

pausePut

resumePut

isPutPaused