com.jme3.audio

Interface AudioSource

All Known Implementing Classes:

AudioNode

public interface AudioSource

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AudioSource.Status Status indicates the current status of the audio source.

Method Summary

Modifier and Type	Method and Description
AudioData	getAudioData()
int	getChannel() Do not use.
Vector3f	getDirection()
Filter	getDryFilter()
float	getInnerAngle()
float	getMaxDistance()
float	getOuterAngle()
float	getPitch()
float	getPlaybackTime()
Vector3f	getPosition()
float	getRefDistance()
Filter	getReverbFilter()
AudioSource.Status	getStatus()
float	getTimeOffset()
Vector3f	getVelocity()
float	getVolume()
boolean	isDirectional()
boolean	isLooping()
boolean	isPositional()
boolean	isReverbEnabled()
void	setChannel(int channel) Do not use.
void	setStatus(AudioSource.Status status) Do not use.

Method Detail

setChannel

void setChannel(int channel)

Do not use.

Parameters:

channel - the desired channel index, or -1 if stopped

getChannel

int getChannel()

Do not use.

Returns:

the channel index, or -1 if stopped

getDryFilter

Filter getDryFilter()

Returns:

The {#link Filter dry filter} that is set.

See Also:

AudioNode.setDryFilter(com.jme3.audio.Filter)

getAudioData

AudioData getAudioData()

Returns:

The AudioData set previously with AudioNode.setAudioData(com.jme3.audio.AudioData, com.jme3.audio.AudioKey) or any of the constructors that initialize the audio data.

setStatus

void setStatus(AudioSource.Status status)

Do not use.

Parameters:

status - the desired Status

getStatus

AudioSource.Status getStatus()

Returns:

The AudioSource.Status of the audio source. The status will be changed when either the AudioNode.play() or AudioNode.stop() methods are called.

isLooping

boolean isLooping()

Returns:

True if the audio will keep looping after it is done playing, otherwise, false.

See Also:

AudioNode.setLooping(boolean)

getPitch

float getPitch()

Returns:

The pitch of the audio, also the speed of playback.

See Also:

AudioNode.setPitch(float)

getVolume

float getVolume()

Returns:

The volume of this audio source.

See Also:

AudioNode.setVolume(float)

getTimeOffset

float getTimeOffset()

Returns:

the time offset in the sound sample to start playing

getPlaybackTime

float getPlaybackTime()

Returns:

the current playback position of the source in seconds.

getPosition

Vector3f getPosition()

Returns:

The position of the audio source.

getVelocity

Vector3f getVelocity()

Returns:

The velocity of the audio source.

See Also:

AudioNode.setVelocity(com.jme3.math.Vector3f)

isReverbEnabled

boolean isReverbEnabled()

Returns:

True if reverb is enabled, otherwise false.

See Also:

AudioNode.setReverbEnabled(boolean)

getReverbFilter

Filter getReverbFilter()

Returns:

Filter for the reverberations of this audio source.

See Also:

AudioNode.setReverbFilter(com.jme3.audio.Filter)

getMaxDistance

float getMaxDistance()

Returns:

Maximum distance for this audio source.

See Also:

AudioNode.setMaxDistance(float)

getRefDistance

float getRefDistance()

Returns:

The reference playing distance for the audio source.

See Also:

AudioNode.setRefDistance(float)

isDirectional

boolean isDirectional()

Returns:

True if the audio source is directional

See Also:

AudioNode.setDirectional(boolean)

getDirection

Vector3f getDirection()

Returns:

The direction of this audio source.

See Also:

AudioNode.setDirection(com.jme3.math.Vector3f)

getInnerAngle

float getInnerAngle()

Returns:

The directional audio source, cone inner angle.

See Also:

AudioNode.setInnerAngle(float)

getOuterAngle

float getOuterAngle()

Returns:

The directional audio source, cone outer angle.

See Also:

AudioNode.setOuterAngle(float)

isPositional

boolean isPositional()

Returns:

True if the audio source is positional.

See Also:

AudioNode.setPositional(boolean)