AudioFile

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ddf.minim
Class AudioFile

java.lang.Object
  ddf.minim.Controller
      ddf.minim.AudioFile

All Implemented Interfaces:: Effectable, Playable, Recordable

public class AudioFile
extends Controller
implements Effectable, Playable, Recordable

AudioFile is used for playing audio files, whether they are on the local file system or streaming from the web. The interface is identical to an AudioSnippet, the only difference being that samples are available. This means that you can do things like draw the waveform, attach AudioEffects, and use different audio analysis classes with it. You get an AudioFile by asking Minim for one.

Author:: Damien Di Fede

Field Summary
`AudioBuffer`	`left` The buffer containing the left channel samples.
`AudioBuffer`	`mix` The buffer containing the mix of the left and right channels.
`AudioBuffer`	`right` The buffer containing the right channel samples.

Fields inherited from class ddf.minim.Controller

BALANCE, GAIN, MUTE, PAN, SAMPLE_RATE, VOLUME

Method Summary
`void`	`addEffect(AudioEffect e)` Adds an effect to the effects chain.
`void`	`addListener(AudioListener listener)` Adds a listener who will be notified each time this receives or creates a new buffer of samples.
`int`	`bufferSize()` Returns the buffer size being used by this Recordable.
`void`	`clearEffects()` Removes all effects from the effect chain.
`void`	`cue(int millis)` Sets the position to `millis` milliseconds from the beginning.
`void`	`disableEffect(int i)` disables the `i`^th effect in the effect chain.
`int`	`effectCount()` Returns the number of effects in the chain.
`void`	`effects()` Enables all effects currently attached to this.
`void`	`enableEffect(int i)` Enables the `i`^th effect in the effect chain.
`AudioEffect`	`getEffect(int i)` Returns the `i^th` effect in the effect chain.
`boolean`	`isEffected()` Returns true if at least one effect in the chain is enabled.
`boolean`	`isLooping()` Returns true if this is currently playing and has more than one loop left to play.
`boolean`	`isPlaying()` Returns true if this currently playing.
`int`	`length()` Returns the length of the sound in milliseconds.
`void`	`loop()` Sets looping to continuous.
`void`	`loop(int num)` Sets this to loop `num` times.
`void`	`noEffects()` Disables all effects currently attached to this.
`void`	`pause()` Pauses playback.
`void`	`play()` Starts playback from the current position.
`void`	`play(int millis)` Starts playback `millis` from the beginning.
`int`	`position()` Returns the current position of the "playhead" (ie how much of the sound has already been played)
`void`	`removeEffect(AudioEffect e)` Removes `e` from the effects chain.
`AudioEffect`	`removeEffect(int i)` Removes and returns the `i^th` effect in the effect chain.
`void`	`removeListener(AudioListener listener)` Removes the listener from the list of listeners.
`void`	`rewind()` Rewinds to the beginning.

Methods inherited from class ddf.minim.Controller

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface ddf.minim.Recordable

getFormat

Field Detail

left

public final AudioBuffer left

The buffer containing the left channel samples. If this is a mono AudioFile, it contains the single channel of audio.

right

public final AudioBuffer right

The buffer containing the right channel samples. If this is a mono AudioFile, right contains the same samples as left.

mix

public final AudioBuffer mix

The buffer containing the mix of the left and right channels. If this is a mono AudioFile, mix simply contains the same samples as left.

Method Detail