Audio Enumerations

Audio items enumerations. More...

Collaboration diagram for Audio Enumerations:

Enumerations
enum	Murl::IEnums::AudioSessionCategory {   Murl::IEnums::AUDIO_SESSION_CATEGORY_DEFAULT , Murl::IEnums::AUDIO_SESSION_CATEGORY_SOLO_AMBIENT , Murl::IEnums::AUDIO_SESSION_CATEGORY_MIX_AMBIENT , Murl::IEnums::AUDIO_SESSION_CATEGORY_MIX_AMBIENT_IF_PLAYING ,   Murl::IEnums::AUDIO_SESSION_CATEGORY_PLAYBACK }
	Available audio session categories. More...
enum	Murl::IEnums::SampleFormat {   Murl::IEnums::SAMPLE_FORMAT_DEFAULT , Murl::IEnums::SAMPLE_FORMAT_MONO_8_BIT , Murl::IEnums::SAMPLE_FORMAT_MONO_16_BIT , Murl::IEnums::SAMPLE_FORMAT_STEREO_8_BIT ,   Murl::IEnums::SAMPLE_FORMAT_STEREO_16_BIT , NUM_SAMPLE_FORMATS }
	Available sample formats for sound playback. More...
enum	Murl::IEnums::AudioStreamFormat { Murl::IEnums::AUDIO_STREAM_FORMAT_DEFAULT , Murl::IEnums::AUDIO_STREAM_FORMAT_RAW , Murl::IEnums::AUDIO_STREAM_FORMAT_VORBIS , NUM_AUDIO_STREAM_FORMATS }
	Available audio stream formats. More...
enum	Murl::IEnums::DistanceModel {   Murl::IEnums::DISTANCE_MODEL_INVERSE , Murl::IEnums::DISTANCE_MODEL_INVERSE_CLAMPED , Murl::IEnums::DISTANCE_MODEL_LINEAR , Murl::IEnums::DISTANCE_MODEL_LINEAR_CLAMPED ,   Murl::IEnums::DISTANCE_MODEL_EXPONENT , Murl::IEnums::DISTANCE_MODEL_EXPONENT_CLAMPED , NUM_DISTANCE_MODELS }
	Available distance models for audio volume attenuation. More...

Functions
UInt32	Murl::IEnums::GetSampleFormatByteSize (SampleFormat sampleFormat)
	Query the number of bytes per sample for a given sample format. More...

Detailed Description

Audio items enumerations.

Enumeration Type Documentation

AudioSessionCategory

enum Murl::IEnums::AudioSessionCategory

Available audio session categories.

Enumerator
AUDIO_SESSION_CATEGORY_DEFAULT	The default category, no audio session category is applied. String value: \
AUDIO_SESSION_CATEGORY_SOLO_AMBIENT	The solo ambient category, silences other audio. String value: \
AUDIO_SESSION_CATEGORY_MIX_AMBIENT	The mix ambient category, mixes other audio. String value: \
AUDIO_SESSION_CATEGORY_MIX_AMBIENT_IF_PLAYING	The mix ambient category, mixes if another audio is playing at app start. String value: \
AUDIO_SESSION_CATEGORY_PLAYBACK	The playback category, audio continues playing if app is in background. String value: \

SampleFormat

enum Murl::IEnums::SampleFormat

Available sample formats for sound playback.

Enumerator
SAMPLE_FORMAT_DEFAULT	The default sample format specified in a sound resource. String value: \
SAMPLE_FORMAT_MONO_8_BIT	8bit mono (1 Byte per sample) String value: \
SAMPLE_FORMAT_MONO_16_BIT	16bit mono (2 Bytes per sample) String value: \
SAMPLE_FORMAT_STEREO_8_BIT	8bit stereo (2 Bytes per sample) String value: \
SAMPLE_FORMAT_STEREO_16_BIT	16bit stereo (4 Bytes per sample) String value: \

AudioStreamFormat

enum Murl::IEnums::AudioStreamFormat

Available audio stream formats.

Enumerator
AUDIO_STREAM_FORMAT_DEFAULT	The default compression. String value: \
AUDIO_STREAM_FORMAT_RAW	No compression, i.e. raw sample values. String value: \
AUDIO_STREAM_FORMAT_VORBIS	Ogg Vorbis compression. String value: \

DistanceModel

enum Murl::IEnums::DistanceModel

Available distance models for audio volume attenuation.

See Graph::IListener for a detailed description.

Enumerator
DISTANCE_MODEL_INVERSE	Inverse distance model. String value: \
DISTANCE_MODEL_INVERSE_CLAMPED	Inverse clamped distance model. String value: \
DISTANCE_MODEL_LINEAR	Linear distance model. String value: \
DISTANCE_MODEL_LINEAR_CLAMPED	Linear clamped distance model. String value: \
DISTANCE_MODEL_EXPONENT	Exponential distance model. String value: \
DISTANCE_MODEL_EXPONENT_CLAMPED	Exponential clamped distance model. String value: \

Function Documentation

GetSampleFormatByteSize()

UInt32 Murl::IEnums::GetSampleFormatByteSize

(

SampleFormat

sampleFormat

)

Query the number of bytes per sample for a given sample format.

Parameters

sampleFormat

The sample format to query.

Returns

The number of bytes per sample.