org.jouvieje.fmodex.defines
Interface FMOD_TIMEUNIT

public interface FMOD_TIMEUNIT

List of time types that can be returned by Sound::getLength and used with Channel::setPosition or Channel::getPosition.

Remarks

FMOD_TIMEUNIT_SENTENCE_MS, FMOD_TIMEUNIT_SENTENCE_PCM, FMOD_TIMEUNIT_SENTENCE_PCMBYTES, FMOD_TIMEUNIT_SENTENCE and FMOD_TIMEUNIT_SENTENCE_SUBSOUND are only supported by Channel functions.
Do not combine flags except FMOD_TIMEUNIT_BUFFERED.

Platforms Supported

Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation 2, PlayStation Portable, PlayStation 3, Wii, Solaris, iPhone

See Also

Sound::getLength
Channel::setPosition
Channel::getPosition

Field Summary

static int	FMOD_TIMEUNIT_BUFFERED Time value as seen by buffered stream.
static int	FMOD_TIMEUNIT_MODORDER MOD/S3M/XM/IT.
static int	FMOD_TIMEUNIT_MODPATTERN MOD/S3M/XM/IT.
static int	FMOD_TIMEUNIT_MODROW MOD/S3M/XM/IT.
static int	FMOD_TIMEUNIT_MS Milliseconds.
static int	FMOD_TIMEUNIT_PCM PCM samples, related to milliseconds * samplerate / 1000.
static int	FMOD_TIMEUNIT_PCMBYTES Bytes, related to PCM samples * channels * datawidth (ie 16bit = 2 bytes).
static int	FMOD_TIMEUNIT_PCMFRACTION Fractions of 1 PCM sample.
static int	FMOD_TIMEUNIT_RAWBYTES Raw file bytes of (compressed) sound data (does not include headers).
static int	FMOD_TIMEUNIT_SENTENCE Currently playing sentence index according to the channel.
static int	FMOD_TIMEUNIT_SENTENCE_MS Currently playing subsound in a sentence time in milliseconds.
static int	FMOD_TIMEUNIT_SENTENCE_PCM Currently playing subsound in a sentence time in PCM Samples, related to milliseconds * samplerate / 1000.
static int	FMOD_TIMEUNIT_SENTENCE_PCMBYTES Currently playing subsound in a sentence time in bytes, related to PCM samples * channels * datawidth (ie 16bit = 2 bytes).
static int	FMOD_TIMEUNIT_SENTENCE_SUBSOUND Currently playing subsound index in a sentence.

Field Detail

FMOD_TIMEUNIT_MS

public static final int FMOD_TIMEUNIT_MS

Milliseconds.

See Also:

Constant Field Values

FMOD_TIMEUNIT_PCM

public static final int FMOD_TIMEUNIT_PCM

PCM samples, related to milliseconds * samplerate / 1000.

See Also:

Constant Field Values

FMOD_TIMEUNIT_PCMBYTES

public static final int FMOD_TIMEUNIT_PCMBYTES

Bytes, related to PCM samples * channels * datawidth (ie 16bit = 2 bytes).

See Also:

Constant Field Values

FMOD_TIMEUNIT_RAWBYTES

public static final int FMOD_TIMEUNIT_RAWBYTES

Raw file bytes of (compressed) sound data (does not include headers). Only used by Sound::getLength and Channel::getPosition.

See Also:

Constant Field Values

FMOD_TIMEUNIT_PCMFRACTION

public static final int FMOD_TIMEUNIT_PCMFRACTION

Fractions of 1 PCM sample. Unsigned int range 0 to 0xFFFFFFFF. Used for sub-sample granularity for DSP purposes.

See Also:

Constant Field Values

FMOD_TIMEUNIT_MODORDER

public static final int FMOD_TIMEUNIT_MODORDER

MOD/S3M/XM/IT. Order in a sequenced module format. Use Sound::getFormat to determine the PCM format being decoded to.

See Also:

Constant Field Values

FMOD_TIMEUNIT_MODROW

public static final int FMOD_TIMEUNIT_MODROW

MOD/S3M/XM/IT. Current row in a sequenced module format. Sound::getLength will return the number of rows in the currently playing or seeked to pattern.

See Also:

Constant Field Values

FMOD_TIMEUNIT_MODPATTERN

public static final int FMOD_TIMEUNIT_MODPATTERN

MOD/S3M/XM/IT. Current pattern in a sequenced module format. Sound::getLength will return the number of patterns in the song and Channel::getPosition will return the currently playing pattern.

See Also:

Constant Field Values

FMOD_TIMEUNIT_SENTENCE_MS

public static final int FMOD_TIMEUNIT_SENTENCE_MS

Currently playing subsound in a sentence time in milliseconds.

See Also:

Constant Field Values

FMOD_TIMEUNIT_SENTENCE_PCM

public static final int FMOD_TIMEUNIT_SENTENCE_PCM

Currently playing subsound in a sentence time in PCM Samples, related to milliseconds * samplerate / 1000.

See Also:

Constant Field Values

FMOD_TIMEUNIT_SENTENCE_PCMBYTES

public static final int FMOD_TIMEUNIT_SENTENCE_PCMBYTES

Currently playing subsound in a sentence time in bytes, related to PCM samples * channels * datawidth (ie 16bit = 2 bytes).

See Also:

Constant Field Values

FMOD_TIMEUNIT_SENTENCE

public static final int FMOD_TIMEUNIT_SENTENCE

Currently playing sentence index according to the channel.

See Also:

Constant Field Values

FMOD_TIMEUNIT_SENTENCE_SUBSOUND

public static final int FMOD_TIMEUNIT_SENTENCE_SUBSOUND

Currently playing subsound index in a sentence.

See Also:

Constant Field Values

FMOD_TIMEUNIT_BUFFERED

public static final int FMOD_TIMEUNIT_BUFFERED

Time value as seen by buffered stream. This is always ahead of audible time, and is only used for processing.

See Also:

Constant Field Values