ddf.minim
Class AudioSample

java.lang.Object
  extended byddf.minim.Controller
      extended byddf.minim.AudioSource
          extended byddf.minim.AudioSample
All Implemented Interfaces:
Effectable, Recordable

public class AudioSample
extends AudioSource

An AudioSample is a special kind of file playback that allows you to repeatedly trigger an audio file. It does this by keeping the entire file in an internal buffer and then keeping a list of trigger points. It is Recordable and Effectable so access to the samples is available and AudioEffects can be attached to it, but there are not the cueing abilities found on an AudioSnippet and AudioPlayer. All you can do is trigger() the sound. However, you can trigger the sound even if it is still playing back. AudioSample supports up to 20 overlapping triggers, which should be plenty for short sounds. 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.

Author:
Damien Di Fede

Field Summary
 
Fields inherited from class ddf.minim.AudioSource
left, mix, right
 
Fields inherited from class ddf.minim.Controller
BALANCE, GAIN, MUTE, PAN, SAMPLE_RATE, VOLUME
 
Method Summary
 void trigger()
          Triggers the sample.
 
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, 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
 

Method Detail

trigger

public void trigger()
Triggers the sample. This may be called while the sound is still playing back.