Package com.jme3.audio

Interface AudioRenderer

All Known Implementing Classes:

ALAudioRenderer

public interface AudioRenderer

Interface to be implemented by audio renderers.

Method Summary

Modifier and Type	Method	Description
void	cleanup()	Cleanup/destroy the audio system.
void	deleteAudioData(AudioData ad)
void	deleteFilter(Filter filter)
float	getSourcePlaybackTime(AudioSource src)
void	initialize()	Initializes the renderer.
void	pauseAll()	Pauses all Playing audio.
void	pauseSource(AudioSource src)
void	playSource(AudioSource src)
void	playSourceInstance(AudioSource src)
void	resumeAll()	Resumes all audio paused by pauseAll().
void	setEnvironment(Environment env)	Sets the environment, used for reverb effects.
void	setListener(Listener listener)
void	stopSource(AudioSource src)
void	update(float tpf)	Update the audio system.
void	updateListenerParam(Listener listener, ListenerParam param)
void	updateSourceParam(AudioSource src, AudioParam param)

Method Details

setListener

void setListener(Listener listener)

Parameters:

listener - The listener camera, all 3D sounds will be oriented around the listener.

setEnvironment

void setEnvironment(Environment env)

Sets the environment, used for reverb effects.

Parameters:

env - The environment to set.

See Also:

• AudioNode.setReverbEnabled(boolean)

playSourceInstance

void playSourceInstance(AudioSource src)

playSource

void playSource(AudioSource src)

pauseSource

void pauseSource(AudioSource src)

stopSource

void stopSource(AudioSource src)

updateSourceParam

void updateSourceParam(AudioSource src,
 AudioParam param)

updateListenerParam

void updateListenerParam(Listener listener,
 ListenerParam param)

getSourcePlaybackTime

float getSourcePlaybackTime(AudioSource src)

deleteFilter

void deleteFilter(Filter filter)

deleteAudioData

void deleteAudioData(AudioData ad)

initialize

void initialize()

Initializes the renderer. Should be the first method called before using the system.

update

void update(float tpf)

Update the audio system. Must be called periodically.

Parameters:

tpf - Time per frame.

pauseAll

void pauseAll()

Pauses all Playing audio. To be used when the app is placed in the background.

resumeAll

void resumeAll()

Resumes all audio paused by pauseAll(). To be used when the app is brought back to the foreground.

cleanup

void cleanup()

Cleanup/destroy the audio system. Call this when app closes.