ddf.minim

Interface AudioBuffer

public interface AudioBuffer

An AudioBuffer is a buffer of floating point samples corresponding to a single channel of streaming audio. It is readonly, but you can obtain a copy of the samples in the buffer by using the toArray method. In fact, when drawing a waveform, you should use the toArray method rather than iterating over the buffer itself because it is possible that the samples in the buffer will be replaced with new ones between calls to the get method, which results in a waveform that appears to have discontinuities in it.

Author:

Damien Di Fede

Method Summary

Modifier and Type	Method and Description
float	get(int i) Gets the ith sample in the buffer.
float	level() Gets the current level of the buffer.
int	size() Returns the length of the buffer.
float[]	toArray() Returns the samples in the buffer in a new float array.

Method Detail

size

int size()

Returns the length of the buffer.

Returns:

int: the number of samples in the buffer

get

float get(int i)

Gets the ith sample in the buffer. This method does not do bounds checking, so it may throw an exception.

Parameters:

i - int: the index of the sample you want to get

Returns:

float: the ith sample

level

float level()

Gets the current level of the buffer. It is calculated as the root-mean-square of all the samples in the buffer.

Returns:

float: the RMS amplitude of the buffer

toArray

float[] toArray()

Returns the samples in the buffer in a new float array. Modifying the samples in the returned array will not change the samples in the buffer.

Returns:

float[]: a new float array containing the buffer's samples