com.jmex.audio
Class AudioTrack

java.lang.Object
  extended by com.jmex.audio.AudioTrack
Direct Known Subclasses:
OpenALAudioTrack

public abstract class AudioTrack
extends java.lang.Object

Represents a sound file.

Version:
$Id: AudioTrack.java 4342 2009-05-13 00:45:51Z mulova $
Author:
Joshua Slack

Nested Class Summary
static class AudioTrack.Format
           
static class AudioTrack.TrackType
           
 
Constructor Summary
AudioTrack(java.net.URL resource, boolean streaming)
           
 
Method Summary
 void addTrackStateListener(TrackStateListener listener)
           
 void autosetRolloff()
           
 void clearTrackStateListeners()
           
 void fadeIn(float time, float maxVolume)
           
 void fadeOut(float time)
           
 float getCurrentTime()
           
 Vector3f getCurrVelocity()
           
 float getMaxAudibleDistance()
           
 float getMaxVolume()
           
 float getMinVolume()
           
 float getPitch()
           
 AudioPlayer getPlayer()
           
 float getReferenceDistance()
           
 java.net.URL getResource()
           
 float getRolloff()
           
 float getTargetVolume()
           
 float getTotalTime()
           
 AudioTrack.TrackType getType()
           
 float getVolume()
           
 float getVolumeChangeRate()
           
 Vector3f getWorldPosition()
           
 boolean isActive()
           
 boolean isEnabled()
           
 boolean isLooping()
           
 boolean isPlaying()
           
 boolean isRelative()
           
 boolean isStopped()
           
 boolean isStreaming()
           
 void mute()
           
 void pause()
           
 void play()
           
 void release()
           
 void removeTrackStateListener(TrackStateListener listener)
           
 void setCurrVelocity(Vector3f currVelocity)
           
 void setEnabled(boolean enabled)
           
 void setLooping(boolean shouldLoop)
           
 void setMaxAudibleDistance(float maxDistance)
           
 void setMaxVolume(float maxVolume)
           
 void setMinVolume(float minVolume)
           
 void setPitch(float pitch)
           
 void setPlayer(AudioPlayer buffer)
           
 void setReferenceDistance(float refDistance)
           
 void setRelative(boolean relative)
           
 void setResource(java.net.URL resource)
           
 void setRolloff(float rolloff)
           
 void setTargetVolume(float targetVolume)
           
 void setType(AudioTrack.TrackType type)
           
 void setVolume(float volume)
           
 void setVolumeChangeRate(float volumeChangeRate)
           
 void setWorldPosition(float x, float y, float z)
           
 void setWorldPosition(Vector3f position)
           
 void stop()
           
 void track(Spatial spat)
           
 void unmute()
           
 void update(float dt)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AudioTrack

public AudioTrack(java.net.URL resource,
                  boolean streaming)
Method Detail

pause

public void pause()

play

public void play()

stop

public void stop()

setLooping

public void setLooping(boolean shouldLoop)

addTrackStateListener

public void addTrackStateListener(TrackStateListener listener)

removeTrackStateListener

public void removeTrackStateListener(TrackStateListener listener)

clearTrackStateListeners

public void clearTrackStateListeners()

isLooping

public boolean isLooping()

unmute

public void unmute()

mute

public void mute()

getVolume

public float getVolume()

setVolume

public void setVolume(float volume)

fadeOut

public void fadeOut(float time)

fadeIn

public void fadeIn(float time,
                   float maxVolume)

getPlayer

public AudioPlayer getPlayer()

setPlayer

public void setPlayer(AudioPlayer buffer)

isPlaying

public boolean isPlaying()

isActive

public boolean isActive()

isStopped

public boolean isStopped()

isRelative

public boolean isRelative()

setRelative

public void setRelative(boolean relative)

getWorldPosition

public Vector3f getWorldPosition()

getCurrentTime

public float getCurrentTime()

setWorldPosition

public void setWorldPosition(Vector3f position)

setWorldPosition

public void setWorldPosition(float x,
                             float y,
                             float z)

getCurrVelocity

public Vector3f getCurrVelocity()

setCurrVelocity

public void setCurrVelocity(Vector3f currVelocity)

track

public void track(Spatial spat)

update

public void update(float dt)

getMaxAudibleDistance

public float getMaxAudibleDistance()

setMaxAudibleDistance

public void setMaxAudibleDistance(float maxDistance)

getPitch

public float getPitch()

setPitch

public void setPitch(float pitch)

getMaxVolume

public float getMaxVolume()

setMaxVolume

public void setMaxVolume(float maxVolume)

getMinVolume

public float getMinVolume()

setMinVolume

public void setMinVolume(float minVolume)

getReferenceDistance

public float getReferenceDistance()

setReferenceDistance

public void setReferenceDistance(float refDistance)

getRolloff

public float getRolloff()

setRolloff

public void setRolloff(float rolloff)

autosetRolloff

public void autosetRolloff()

getResource

public java.net.URL getResource()

setResource

public void setResource(java.net.URL resource)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

isStreaming

public boolean isStreaming()

getTargetVolume

public float getTargetVolume()

setTargetVolume

public void setTargetVolume(float targetVolume)

getVolumeChangeRate

public float getVolumeChangeRate()

setVolumeChangeRate

public void setVolumeChangeRate(float volumeChangeRate)

getTotalTime

public float getTotalTime()

getType

public AudioTrack.TrackType getType()

setType

public void setType(AudioTrack.TrackType type)

release

public void release()