Skip to main content
Version: 21 Aug 2024

Control

Module: Audio / Audio Definitions

CONTROL.

Enums​

Name
enumMLAudioState
{
MLAudioState_Stopped,
MLAudioState_Playing,
MLAudioState_Paused,
MLAudioState_Ensure32Bits = 0x7FFFFFFF
}
enumMLAudioSoundEvent
{
MLAudioSoundEvent_End,
MLAudioSoundEvent_Loop,
MLAudioSoundEvent_MutedBySystem,
MLAudioSoundEvent_UnmutedBySystem,
MLAudioSoundEvent_DuckedBySystem,
MLAudioSoundEvent_UnduckedBySystem,
MLAudioSoundEvent_ResourceDestroyed,
MLAudioSoundEvent_Ensure32Bits = 0x7FFFFFFF
}
enumMLAudioMediaEvent
{
MLAudioMediaEvent_Play,
MLAudioMediaEvent_Stop,
MLAudioMediaEvent_Pause,
MLAudioMediaEvent_NextTrack,
MLAudioMediaEvent_PrevTrack,
MLAudioMediaEvent_Ensure32Bits = 0x7FFFFFFF
}

Enums Documentation​

MLAudioState​

EnumeratorValueDescription
MLAudioState_StoppedStopped, can be started.
MLAudioState_PlayingPlaying, can be stopped or paused.
MLAudioState_PausedPaused, can be resumed or re-started.
MLAudioState_Ensure32Bits0x7FFFFFFFEnsure enum is represented as 32 bits.

Possible playback states for sounds and inputs.

MLAudioSoundEvent​

EnumeratorValueDescription
MLAudioSoundEvent_EndA sound output has reached the end and is stopping.
MLAudioSoundEvent_LoopA sound output has reached the end and is looping.
MLAudioSoundEvent_MutedBySystemA sound output has been muted due to system conditions.
MLAudioSoundEvent_UnmutedBySystemA previously muted sound output has been unmuted due to system conditions.
MLAudioSoundEvent_DuckedBySystemA sound output has been ducked due to system conditions.
MLAudioSoundEvent_UnduckedBySystemA previously ducked sound output has been unducked due to system conditions.
MLAudioSoundEvent_ResourceDestroyedThe resource used by a sound output has been destroyed.
MLAudioSoundEvent_Ensure32Bits0x7FFFFFFFEnsure enum is represented as 32 bits.

Possible events for individual sound outputs.

MLAudioMediaEvent​

EnumeratorValueDescription
MLAudioMediaEvent_PlayIndicates a user command to play.
MLAudioMediaEvent_StopIndicates a user command to stop.
MLAudioMediaEvent_PauseIndicates a user command to pause.
MLAudioMediaEvent_NextTrackIndicates a user command to go to next track.
MLAudioMediaEvent_PrevTrackIndicates a user command to go to previous track.
MLAudioMediaEvent_Ensure32Bits0x7FFFFFFFEnsure enum is represented as 32 bits.

Possible media control events initiated by the user.