com.jogamp.opengl.util.av

Interface AudioSink

public interface AudioSink

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AudioSink.AudioDataFormat Specifies the audio data format.
static class	AudioSink.AudioDataType Specifies the audio data type.
static class	AudioSink.AudioFrame

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG
static AudioSink.AudioDataFormat	DefaultFormat Default AudioSink.AudioDataFormat, [type PCM, sampleRate 44100, sampleSize 16, channelCount 2, signed, littleEndian].

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Destroys this instance, i.e.
AudioSink.AudioDataFormat	getPreferredFormat() Returns the preferred AudioSink.AudioDataFormat by this sink.
int	getQueuedByteCount() Returns the number of bytes queued for playing.
int	getQueuedTime() Returns the queued buffer time in milliseconds for playing.
int	getWritableBufferCount() Returns the number of buffers in the sink available for writing.
AudioSink.AudioDataFormat	initSink(AudioSink.AudioDataFormat requestedFormat, int bufferCount) Initializes the sink.
boolean	isDataAvailable(int data_size) Returns true if data is available to be written in the sink.
boolean	isInitialized() Returns the initialized state of this instance.
void	writeData(AudioSink.AudioFrame audioFrame) Writes the remaining bytes of the given direct ByteBuffer to this sink.

Field Detail

DEBUG

static final boolean DEBUG

DefaultFormat

static final AudioSink.AudioDataFormat DefaultFormat

Default AudioSink.AudioDataFormat, [type PCM, sampleRate 44100, sampleSize 16, channelCount 2, signed, littleEndian].

Method Detail

isInitialized

boolean isInitialized()

Returns the initialized state of this instance.

The initialized state is affected by this instance overall availability, i.e. after instantiation, as well as by destroy().

getPreferredFormat

AudioSink.AudioDataFormat getPreferredFormat()

Returns the preferred AudioSink.AudioDataFormat by this sink.

The preferred format shall reflect this sinks most native format, i.e. best performance w/o data conversion.

See Also:

#initSink(AudioDataFormat)

initSink

AudioSink.AudioDataFormat initSink(AudioSink.AudioDataFormat requestedFormat,
                                 int bufferCount)

Initializes the sink.

Implementation shall try to match the given requestedFormat AudioSink.AudioDataFormat as close as possible, regarding it's capabilities.

A user may consider getPreferredFormat() and pass this value to utilize best performance and behavior.

The DefaultFormat should be supported by all implementations.

Parameters:

requestedFormat - the requested AudioSink.AudioDataFormat.

bufferCount - number of buffers for sink

Returns:

if successful the chosen AudioDataFormat based on the requestedFormat and this sinks capabilities, otherwise null.

destroy

void destroy()

Destroys this instance, i.e. closes all streams and devices allocated.

getQueuedByteCount

int getQueuedByteCount()

Returns the number of bytes queued for playing.

#initSink(AudioDataFormat) must be called first.

getQueuedTime

int getQueuedTime()

Returns the queued buffer time in milliseconds for playing.

#initSink(AudioDataFormat) must be called first.

getWritableBufferCount

int getWritableBufferCount()

Returns the number of buffers in the sink available for writing.

#initSink(AudioDataFormat) must be called first.

isDataAvailable

boolean isDataAvailable(int data_size)

Returns true if data is available to be written in the sink.

#initSink(AudioDataFormat) must be called first.

writeData

void writeData(AudioSink.AudioFrame audioFrame)

Writes the remaining bytes of the given direct ByteBuffer to this sink.

The data must comply with the chosen AudioSink.AudioDataFormat as returned by #initSink(AudioDataFormat).