ddf.minim

Class AudioSample

java.lang.Object

ddf.minim.Controller

ddf.minim.AudioSource

ddf.minim.AudioSample

All Implemented Interfaces:

Effectable, Recordable

public abstract class AudioSample
extends AudioSource

An AudioSample keeps the entire file in an internal buffer and all you can do is trigger() the sound. However, you can trigger the sound even if it is still playing back. It is not advised that you use this class for long sounds (like entire songs, for example) because the entire file is kept in memory.

To create an AudioSample you must use either the loadSample or createSample methods of the Minim class.

AudioSample also provides most of the same methods as AudioPlayer for controlling volume, panning, and so forth.

We now recommend using Sampler class from the ugens package because it is more full-featured than AudioSample.

Author:

Damien Di Fede

Field Summary

Fields

Modifier and Type	Field and Description
static int	LEFT int used to request the left channel of audio from the getChannel method.
static int	RIGHT int used to request the right channel of audio from the getChannel method.

Fields inherited from class ddf.minim.AudioSource

left, mix, right

Fields inherited from class ddf.minim.Controller

BALANCE, GAIN, MUTE, PAN, SAMPLE_RATE, VOLUME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AudioSample(ddf.minim.spi.AudioOut output)

Method Summary

Modifier and Type	Method and Description
abstract float[]	getChannel(int channelNumber) Gets the samples for the requested channel number as a float array.
abstract AudioMetaData	getMetaData() Get the AudioMetaData for this sample.
abstract int	length() Gets the length in milliseconds of this AudioSample.
abstract void	stop() Stops all sound being produced by this AudioSample.
abstract void	trigger() Triggers the sound to play once.

Methods inherited from class ddf.minim.AudioSource

addEffect, addListener, bufferSize, clearEffects, close, disableEffect, disableEffect, effectCount, effects, enableEffect, enableEffect, getEffect, getFormat, hasEffect, isEffected, isEnabled, noEffects, removeEffect, removeEffect, removeListener, sampleRate, type

Methods inherited from class ddf.minim.Controller

balance, gain, getBalance, getControl, getControls, getGain, getPan, getVolume, hasControl, isMuted, mute, pan, printControls, setBalance, setGain, setPan, setVolume, shiftBalance, shiftGain, shiftPan, shiftVolume, unmute, volume

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LEFT

public static final int LEFT

int used to request the left channel of audio from the getChannel method.

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

int used to request the right channel of audio from the getChannel method.

See Also:

Constant Field Values

Constructor Detail

AudioSample

protected AudioSample(ddf.minim.spi.AudioOut output)

Method Detail

getMetaData

public abstract AudioMetaData getMetaData()

Get the AudioMetaData for this sample. This will mostly be useful if you have created an AudioSample from an mp3 file and want to get at some of the most common ID3 tags.

Returns:

the AudioMetaData for the sample.

getChannel

public abstract float[] getChannel(int channelNumber)

Gets the samples for the requested channel number as a float array. Use either AudioSample.LEFT or AudioSample.RIGHT.

Parameters:

channelNumber - int: the channel you want the samples for

Returns:

float[]: the samples in the specified channel

length

public abstract int length()

Gets the length in milliseconds of this AudioSample.

Returns:

int: the length in milliseconds

trigger

public abstract void trigger()

Triggers the sound to play once. Can be called again before the sound finishes playing.

stop

public abstract void stop()

Stops all sound being produced by this AudioSample.