org.j3d.aviatrix3d
Interface AudioSource

All Known Implementing Classes:

AudioComponent, ByteAudioComponent

public interface AudioSource

Marker interface representing a class that provides source data for a Sound object.

The source can come from many different places, such as external data images, streams etc), or dynamically generated (multipass rendering). All texture objects require a source of data, and a single source can be added to multiple texture objects.

It is not intended that this interface be used directly as there is not much directly usable information. Derived versions of this interface will provide more interesting and source-specific behaviour.

Version:

$Revision: 1.2 $

Author:

Alan Hudson

Field Summary

static int	FORMAT_MONO16 Specifies the source is a mono channel, 16 bit
static int	FORMAT_MONO8 Specifies the source is a mono channel, 8 bit
static int	FORMAT_SETERO8 Specifies the source is a mono channel, 8 bit
static int	FORMAT_STEREO16 Specifies the source is a mono channel, 16 bit

Method Summary

int	getBufferId(net.java.games.joal.AL al, int seq) Get a bufferId for a given seq and context.
int	getFormat() Get the format of this sound source.
int	getFrequency() Get the frequency of this sound source.
boolean	getLoop() Does this source loop.
float	getPitch() The pitch to play the sound at.

Field Detail

FORMAT_MONO8

static final int FORMAT_MONO8

Specifies the source is a mono channel, 8 bit

See Also:

Constant Field Values

FORMAT_MONO16

static final int FORMAT_MONO16

Specifies the source is a mono channel, 16 bit

See Also:

Constant Field Values

FORMAT_SETERO8

static final int FORMAT_SETERO8

Specifies the source is a mono channel, 8 bit

See Also:

Constant Field Values

FORMAT_STEREO16

static final int FORMAT_STEREO16

Specifies the source is a mono channel, 16 bit

See Also:

Constant Field Values

Method Detail

getFormat

int getFormat()

Get the format of this sound source.

Returns:

the format

getFrequency

int getFrequency()

Get the frequency of this sound source.

Returns:

the format

getLoop

boolean getLoop()

Does this source loop.

Returns:

the format

getPitch

float getPitch()

The pitch to play the sound at.

Returns:

the pitch, (0 to 2)

getBufferId

int getBufferId(net.java.games.joal.AL al,
                int seq)

Get a bufferId for a given seq and context. Returns -1 if the buffer has not been created. When created a AudioUpdateListener event will be issued.

Parameters:

seq - The sequence number

Returns:

The bufferId.