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
}
 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 }
 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
}
 Available distance models for audio volume attenuation. More...
 

Functions

const Enum< SampleFormat > & Murl::IEnums::GetSampleFormatEnum ()
 Get the SampleFormat enumeration string mapping. More...
 
UInt32 Murl::IEnums::GetSampleFormatByteSize (SampleFormat sampleFormat)
 Query the number of bytes per sample for a given sample format. More...
 
const Enum< AudioStreamFormat > & Murl::IEnums::GetAudioStreamFormatEnum ()
 Get the AudioStreamFormat enumeration string mapping. More...
 
const Enum< DistanceModel > & Murl::IEnums::GetDistanceModelEnum ()
 Get the DistanceModel enumeration string mapping. More...
 

Detailed Description

Audio items enumerations.

Enumeration Type Documentation

◆ AudioSessionCategory

Available audio session categories.

Enumerator
AUDIO_SESSION_CATEGORY_DEFAULT 

The default category, no audio session category is applied.

String value: "DEFAULT"

AUDIO_SESSION_CATEGORY_SOLO_AMBIENT 

The solo ambient category, silences other audio.

String value: "SOLO_AMBIENT"

AUDIO_SESSION_CATEGORY_MIX_AMBIENT 

The mix ambient category, mixes other audio.

String value: "MIX_AMBIENT"

AUDIO_SESSION_CATEGORY_MIX_AMBIENT_IF_PLAYING 

The mix ambient category, mixes if another audio is playing at app start.

String value: "MIX_AMBIENT_IF_PLAYING"

AUDIO_SESSION_CATEGORY_PLAYBACK 

The playback category, audio continues playing if app is in background.

String value: "PLAYBACK"

◆ SampleFormat

Available sample formats for sound playback.

Enumerator
SAMPLE_FORMAT_DEFAULT 

The default sample format specified in a sound resource.

String value: "DEFAULT"

SAMPLE_FORMAT_MONO_8_BIT 

8bit mono (1 Byte per sample)

String value: "MONO_8_BIT"

SAMPLE_FORMAT_MONO_16_BIT 

16bit mono (2 Bytes per sample)

String value: "MONO_16_BIT"

SAMPLE_FORMAT_STEREO_8_BIT 

8bit stereo (2 Bytes per sample)

String value: "STEREO_8_BIT"

SAMPLE_FORMAT_STEREO_16_BIT 

16bit stereo (4 Bytes per sample)

String value: "STEREO_16_BIT"

◆ AudioStreamFormat

Available audio stream formats.

Enumerator
AUDIO_STREAM_FORMAT_DEFAULT 

The default compression.

String value: "DEFAULT"

AUDIO_STREAM_FORMAT_RAW 

No compression, i.e. raw sample values.

String value: "RAW"

AUDIO_STREAM_FORMAT_VORBIS 

Ogg Vorbis compression.

String value: "VORBIS"

◆ DistanceModel

Available distance models for audio volume attenuation.

See Graph::IListener for a detailed description.

Enumerator
DISTANCE_MODEL_INVERSE 

Inverse distance model.

String value: "INVERSE"

DISTANCE_MODEL_INVERSE_CLAMPED 

Inverse clamped distance model.

String value: "INVERSE_CLAMPED"

DISTANCE_MODEL_LINEAR 

Linear distance model.

String value: "LINEAR"

DISTANCE_MODEL_LINEAR_CLAMPED 

Linear clamped distance model.

String value: "LINEAR_CLAMPED"

DISTANCE_MODEL_EXPONENT 

Exponential distance model.

String value: "EXPONENT"

DISTANCE_MODEL_EXPONENT_CLAMPED 

Exponential clamped distance model.

String value: "EXPONENT_CLAMPED"

Function Documentation

◆ GetSampleFormatEnum()

const Enum< SampleFormat >& Murl::IEnums::GetSampleFormatEnum ( )

Get the SampleFormat enumeration string mapping.

  • Returns
    The enumeration string mapping.

◆ GetSampleFormatByteSize()

UInt32 Murl::IEnums::GetSampleFormatByteSize ( SampleFormat  sampleFormat)

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

Parameters
sampleFormatThe sample format to query.
Returns
The number of bytes per sample.

◆ GetAudioStreamFormatEnum()

const Enum< AudioStreamFormat >& Murl::IEnums::GetAudioStreamFormatEnum ( )

Get the AudioStreamFormat enumeration string mapping.

  • Returns
    The enumeration string mapping.

◆ GetDistanceModelEnum()

const Enum< DistanceModel >& Murl::IEnums::GetDistanceModelEnum ( )

Get the DistanceModel enumeration string mapping.

  • Returns
    The enumeration string mapping.


Copyright © 2011-2018 Spraylight GmbH.