Inheritance diagram for Sandbox.Engine.Audio.MyAudio:

Public Member Functions
delegate void	VolumeChangeHandler (float newVolume)

Static Public Member Functions
static new void	LoadData ()

static new void	UnloadData ()

static void	Pause ()

static void	Resume ()

static void	PauseGameSounds ()

static void	ResumeGameSounds ()

static MySourceVoice	GetMusicCue ()

static MyMusicState	GetMusicState ()

static void	MuteHud (bool mute)

static bool	HasAnyTransition ()

static void	Update (bool ignoreGameReadyStatus=false)

static MyMusicTransitionEnum	GetRandomTransitionEnum ()

static bool	ApplyTransition (MyMusicTransitionEnum transitionEnum, int priority=0, string category=null, bool loop=true)

static void	StopTransition (int priority)

static MySourceVoice	PlayCue2D (MySoundCuesEnum cueEnum, float volume=-1f)

static void	WaitForPlayingHudSounds ()

static float	SemitonesToFrequencyRatio (float semitones)

static MySourceVoice	PlayIntroLoopPair3D (IMy3DSoundEmitter source, MySoundCuesEnum introCueEnum, MySoundCuesEnum loopCueEnum, bool addToUpdateList=true)

static MySourceVoice	PlayCue3D (IMy3DSoundEmitter source, MySoundCuesEnum cueEnum, bool addToUpdateList=true)

static void	WriteDebugInfo (StringBuilder builder)

static int	GetUpdating3DSoundsCount ()

static int	GetSoundInstancesTotal2D ()

static int	GetSoundInstancesTotal3D ()

static void	StopUpdatingAll3DCues ()

static bool	SourceIsCloseEnoughToPlaySound (IMy3DSoundEmitter source, MySoundCuesEnum cueEnum)

static MySourceVoice	PlayTestSound (MySoundCuesEnum cueEnum)

Properties
static MyCueBank	CueBank `[get]`

static MyObjectBuilder_CueDefinition	SoloCue `[get, set]`

static Listener	Listener `[get]`

static bool	GameSoundIsPaused `[get]`

static bool	ApplyReverb `[get, set]`

static float	VolumeMusic `[get, set]`

static float	VolumeHud `[get, set]`

static float	VolumeGame `[get, set]`

static bool	Mute `[get, set]`

static bool	MusicAllowed `[get, set]`

static string	AudioPath `[get]`

Events
static VolumeChangeHandler	OnSetVolumeHud

Detailed Description

Definition at line 46 of file MyAudio.cs.

Member Function Documentation

static bool Sandbox.Engine.Audio.MyAudio.ApplyTransition	(	MyMusicTransitionEnum	transitionEnum,
		int	priority = `0`,
		string	category = `null`,
		bool	loop = `true`
	)

inlinestatic

Definition at line 645 of file MyAudio.cs.

static MySourceVoice Sandbox.Engine.Audio.MyAudio.GetMusicCue ( )

inlinestatic

Definition at line 514 of file MyAudio.cs.

static MyMusicState Sandbox.Engine.Audio.MyAudio.GetMusicState ( )

inlinestatic

Definition at line 519 of file MyAudio.cs.

static MyMusicTransitionEnum Sandbox.Engine.Audio.MyAudio.GetRandomTransitionEnum ( )

inlinestatic

Definition at line 637 of file MyAudio.cs.

static int Sandbox.Engine.Audio.MyAudio.GetSoundInstancesTotal2D ( )

inlinestatic

Definition at line 1150 of file MyAudio.cs.

static int Sandbox.Engine.Audio.MyAudio.GetSoundInstancesTotal3D ( )

inlinestatic

Definition at line 1155 of file MyAudio.cs.

static int Sandbox.Engine.Audio.MyAudio.GetUpdating3DSoundsCount ( )

inlinestatic

Definition at line 1145 of file MyAudio.cs.

static bool Sandbox.Engine.Audio.MyAudio.HasAnyTransition ( )

inlinestatic

Definition at line 530 of file MyAudio.cs.

static new void Sandbox.Engine.Audio.MyAudio.LoadData ( )

inlinestatic

Definition at line 220 of file MyAudio.cs.

static void Sandbox.Engine.Audio.MyAudio.MuteHud ( bool mute )

inlinestatic

Definition at line 524 of file MyAudio.cs.

static void Sandbox.Engine.Audio.MyAudio.Pause ( )

inlinestatic

Definition at line 442 of file MyAudio.cs.

static void Sandbox.Engine.Audio.MyAudio.PauseGameSounds ( )

inlinestatic

Definition at line 454 of file MyAudio.cs.

static MySourceVoice Sandbox.Engine.Audio.MyAudio.PlayCue2D	(	MySoundCuesEnum	cueEnum,
		float	volume = `-1f`
	)

inlinestatic

Definition at line 750 of file MyAudio.cs.

static MySourceVoice Sandbox.Engine.Audio.MyAudio.PlayCue3D	(	IMy3DSoundEmitter	source,
		MySoundCuesEnum	cueEnum,
		bool	addToUpdateList = `true`
	)

inlinestatic

Definition at line 1039 of file MyAudio.cs.

static MySourceVoice Sandbox.Engine.Audio.MyAudio.PlayIntroLoopPair3D	(	IMy3DSoundEmitter	source,
		MySoundCuesEnum	introCueEnum,
		MySoundCuesEnum	loopCueEnum,
		bool	addToUpdateList = `true`
	)

inlinestatic

Definition at line 907 of file MyAudio.cs.

static MySourceVoice Sandbox.Engine.Audio.MyAudio.PlayTestSound ( MySoundCuesEnum cueEnum )

inlinestatic

Definition at line 1268 of file MyAudio.cs.

static void Sandbox.Engine.Audio.MyAudio.Resume ( )

inlinestatic

Definition at line 448 of file MyAudio.cs.

static void Sandbox.Engine.Audio.MyAudio.ResumeGameSounds ( )

inlinestatic

Definition at line 464 of file MyAudio.cs.

static float Sandbox.Engine.Audio.MyAudio.SemitonesToFrequencyRatio ( float semitones )

inlinestatic

Definition at line 902 of file MyAudio.cs.

static bool Sandbox.Engine.Audio.MyAudio.SourceIsCloseEnoughToPlaySound	(	IMy3DSoundEmitter	source,
		MySoundCuesEnum	cueEnum
	)

inlinestatic

Definition at line 1245 of file MyAudio.cs.

static void Sandbox.Engine.Audio.MyAudio.StopTransition ( int priority )

inlinestatic

Definition at line 721 of file MyAudio.cs.

static void Sandbox.Engine.Audio.MyAudio.StopUpdatingAll3DCues ( )

inlinestatic

Definition at line 1231 of file MyAudio.cs.

static new void Sandbox.Engine.Audio.MyAudio.UnloadData ( )

inlinestatic

Definition at line 310 of file MyAudio.cs.

static void Sandbox.Engine.Audio.MyAudio.Update ( bool ignoreGameReadyStatus = false )

inlinestatic

Definition at line 541 of file MyAudio.cs.

delegate void Sandbox.Engine.Audio.MyAudio.VolumeChangeHandler ( float newVolume )

static void Sandbox.Engine.Audio.MyAudio.WaitForPlayingHudSounds ( )

inlinestatic

Definition at line 824 of file MyAudio.cs.

static void Sandbox.Engine.Audio.MyAudio.WriteDebugInfo ( StringBuilder builder )

inlinestatic

Definition at line 1139 of file MyAudio.cs.

Property Documentation

bool Sandbox.Engine.Audio.MyAudio.ApplyReverb

staticgetset

Definition at line 332 of file MyAudio.cs.

string Sandbox.Engine.Audio.MyAudio.AudioPath

staticget

Definition at line 536 of file MyAudio.cs.

MyCueBank Sandbox.Engine.Audio.MyAudio.CueBank

staticget

Definition at line 118 of file MyAudio.cs.

bool Sandbox.Engine.Audio.MyAudio.GameSoundIsPaused

staticget

Definition at line 121 of file MyAudio.cs.

Listener Sandbox.Engine.Audio.MyAudio.Listener

staticget

Definition at line 120 of file MyAudio.cs.

bool Sandbox.Engine.Audio.MyAudio.MusicAllowed

staticgetset

Definition at line 509 of file MyAudio.cs.

bool Sandbox.Engine.Audio.MyAudio.Mute

staticgetset

Definition at line 477 of file MyAudio.cs.

MyObjectBuilder_CueDefinition Sandbox.Engine.Audio.MyAudio.SoloCue

staticgetset

Definition at line 119 of file MyAudio.cs.

float Sandbox.Engine.Audio.MyAudio.VolumeGame

staticgetset

Definition at line 419 of file MyAudio.cs.

float Sandbox.Engine.Audio.MyAudio.VolumeHud

staticgetset

Definition at line 390 of file MyAudio.cs.

float Sandbox.Engine.Audio.MyAudio.VolumeMusic

staticgetset

Definition at line 361 of file MyAudio.cs.

Event Documentation

VolumeChangeHandler Sandbox.Engine.Audio.MyAudio.OnSetVolumeHud

static

Definition at line 116 of file MyAudio.cs.

The documentation for this class was generated from the following file:

Sources/Sandbox.Game/Engine/Audio/MyAudio.cs

Public Member Functions

Static Public Member Functions

Properties

Events

Detailed Description

Member Function Documentation

Property Documentation

Event Documentation