org.achtern.AchternEngine.core.audio.openal

Class AudioSource

java.lang.Object

org.achtern.AchternEngine.core.bootstrap.NativeObject

org.achtern.AchternEngine.core.audio.openal.AudioSource

All Implemented Interfaces:

Native

public class AudioSource
extends NativeObject

Field Summary

Fields

Modifier and Type	Field and Description
protected AudioBuffer	buffer Associated AudioBuffer
protected float	gain Gain of this AudioSource. 0.0f is minimum and 1.0f maximum.
protected boolean	loop Indicates whether this AudioSource should be played in a loop.
protected Vector3f	position Position of this AudioSource in 3D space.
protected boolean	relative If this AudioSource is not relative, getPosition() will be interpreted as absolute world coordiantes, otherwise as offset from the AudioListener.
protected AudioSourceState	state Stores the current state of this AudioSource.
protected Vector3f	velocity The velocity of the AudioSource, for doppler effects etc.

Fields inherited from interface org.achtern.AchternEngine.core.bootstrap.Native

INVALID_ID

Constructor Summary

Constructors

Constructor and Description
AudioSource(AudioBuffer buffer)
AudioSource(AudioBuffer buffer, Vector3f position, Vector3f velocity)
AudioSource(AudioBuffer buffer, Vector3f position, Vector3f velocity, boolean loop, boolean relative, float gain, AudioSourceState state)

Method Summary

Modifier and Type	Method and Description
AudioBuffer	getBuffer() Associated AudioBuffer
float	getGain() Gain of this AudioSource. 0.0f is minimum and 1.0f maximum.
Vector3f	getPosition() Position of this AudioSource in 3D space.
AudioSourceState	getState() Stores the current state of this AudioSource.
Vector3f	getVelocity() The velocity of the AudioSource, for doppler effects etc.
boolean	isLoop() Indicates whether this AudioSource should be played in a loop.
boolean	isRelative() If this AudioSource is not relative, getPosition() will be interpreted as absolute world coordiantes, otherwise as offset from the AudioListener.
void	setBuffer(AudioBuffer buffer) Associated AudioBuffer
void	setGain(float gain) Gain of this AudioSource. 0.0f is minimum and 1.0f maximum.
void	setLoop(boolean loop) Indicates whether this AudioSource should be played in a loop.
void	setPosition(Vector3f position) Position of this AudioSource in 3D space.
void	setRelative(boolean relative) If this AudioSource is not relative, getPosition() will be interpreted as absolute world coordiantes, otherwise as offset from the AudioListener.
void	setState(AudioSourceState playing) internal use only.
void	setVelocity(Vector3f velocity) The velocity of the AudioSource, for doppler effects etc.
String	toString()

Methods inherited from class org.achtern.AchternEngine.core.bootstrap.NativeObject

getID, setID

Methods inherited from class java.lang.Object

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

Field Detail

buffer

protected AudioBuffer buffer

Associated AudioBuffer

position

protected Vector3f position

Position of this AudioSource in 3D space. This can be both in absolute or relative coordinates to the AudioListener.

See Also:

isRelative()

velocity

protected Vector3f velocity

The velocity of the AudioSource, for doppler effects etc. Not needed in most cases.

loop

protected boolean loop

Indicates whether this AudioSource should be played in a loop.

relative

protected boolean relative

If this AudioSource is not relative, getPosition() will be interpreted as absolute world coordiantes, otherwise as offset from the AudioListener.

gain

protected float gain

Gain of this AudioSource. 0.0f is minimum and 1.0f maximum. Defaults to 1.0f NOTE: the 1.0f maximum is NOT enforced. Some drivers may allow gain over 1.0f

state

protected AudioSourceState state

Stores the current state of this AudioSource.

Constructor Detail

AudioSource

public AudioSource(AudioBuffer buffer)

AudioSource

public AudioSource(AudioBuffer buffer,
                   Vector3f position,
                   Vector3f velocity)

AudioSource

@ConstructorProperties(value={"buffer","position","velocity","loop","relative","gain","state"})
 @Generated(value="lombok")
public AudioSource(AudioBuffer buffer,
                                                                                                                                               Vector3f position,
                                                                                                                                               Vector3f velocity,
                                                                                                                                               boolean loop,
                                                                                                                                               boolean relative,
                                                                                                                                               float gain,
                                                                                                                                               AudioSourceState state)

Method Detail

setState

public void setState(AudioSourceState playing)

internal use only. Stores the current state of this AudioSource

Parameters:

playing - the new state

toString

public String toString()

Overrides:

toString in class Object

getBuffer

@Generated(value="lombok")
public AudioBuffer getBuffer()

Associated AudioBuffer

Returns:

the currently assoc. AudioBuffer

getPosition

@Generated(value="lombok")
public Vector3f getPosition()

Position of this AudioSource in 3D space. This can be both in absolute or relative coordinates to the AudioListener.

Returns:

current position

See Also:

isRelative()

getVelocity

@Generated(value="lombok")
public Vector3f getVelocity()

The velocity of the AudioSource, for doppler effects etc. Not needed in most cases.

Returns:

current velocity

isLoop

@Generated(value="lombok")
public boolean isLoop()

Indicates whether this AudioSource should be played in a loop.

Returns:

if it will loop

isRelative

@Generated(value="lombok")
public boolean isRelative()

If this AudioSource is not relative, getPosition() will be interpreted as absolute world coordiantes, otherwise as offset from the AudioListener.

Returns:

if position is relative

getGain

@Generated(value="lombok")
public float getGain()

Gain of this AudioSource. 0.0f is minimum and 1.0f maximum. Defaults to 1.0f NOTE: the 1.0f maximum is NOT enforced. Some drivers may allow gain over 1.0f

Returns:

current gain of the AudioSource.

getState

@Generated(value="lombok")
public AudioSourceState getState()

Stores the current state of this AudioSource.

Returns:

current state

setBuffer

@Generated(value="lombok")
public void setBuffer(AudioBuffer buffer)

Associated AudioBuffer

Parameters:

buffer - New buffer to use with this AudioSource

setPosition

@Generated(value="lombok")
public void setPosition(Vector3f position)

Position of this AudioSource in 3D space. This can be both in absolute or relative coordinates to the AudioListener.

Parameters:

position - Sets the new position

See Also:

isRelative()

setVelocity

@Generated(value="lombok")
public void setVelocity(Vector3f velocity)

The velocity of the AudioSource, for doppler effects etc. Not needed in most cases.

Parameters:

velocity - new velocity

setLoop

@Generated(value="lombok")
public void setLoop(boolean loop)

Indicates whether this AudioSource should be played in a loop.

Parameters:

loop - if it should be looped

setRelative

@Generated(value="lombok")
public void setRelative(boolean relative)

If this AudioSource is not relative, getPosition() will be interpreted as absolute world coordiantes, otherwise as offset from the AudioListener.

Parameters:

relative - if position is relative

setGain

@Generated(value="lombok")
public void setGain(float gain)

Gain of this AudioSource. 0.0f is minimum and 1.0f maximum. Defaults to 1.0f NOTE: the 1.0f maximum is NOT enforced. Some drivers may allow gain over 1.0f

Parameters:

gain - gain of the AudioSource