Inheritance diagram for VRage.Audio.IMyAudio:

Public Member Functions
List< MyStringId >	GetCategories ()

MySoundData	GetCue (MyCueId cue)

Dictionary< MyStringId, List< MyCueId > >	GetAllMusicCues ()

void	SetReverbParameters (float diffusion, float roomSize)

void	Pause ()

void	Resume ()

void	PauseGameSounds ()

void	ResumeGameSounds ()

void	SetSameSoundLimiter ()

void	EnableMasterLimiter (bool enable)

void	ChangeGlobalVolume (float level, float time)

void	PlayMusic (MyMusicTrack?track=null, int priorityForRandom=0)

IMySourceVoice	PlayMusicCue (MyCueId musicCue, bool overrideMusicAllowed)

void	StopMusic ()

void	MuteHud (bool mute)

bool	HasAnyTransition ()

bool	IsValidTransitionCategory (MyStringId transitionCategory, MyStringId musicCategory)

void	LoadData (MyAudioInitParams initParams, ListReader< MySoundData > cues, ListReader< MyAudioEffect > effects)

void	UnloadData ()

void	ReloadData ()

void	ReloadData (ListReader< MySoundData > cues, ListReader< MyAudioEffect > effects)

void	Update (int stepSizeInMS, Vector3 listenerPosition, Vector3 listenerUp, Vector3 listenerFront)

IMySourceVoice	PlaySound (MyCueId cueId, IMy3DSoundEmitter source=null, MySoundDimensions type=MySoundDimensions.D2, bool skipIntro=false, bool skipToEnd=false)

IMySourceVoice	GetSound (MyCueId cueId, IMy3DSoundEmitter source=null, MySoundDimensions type=MySoundDimensions.D2)

IMySourceVoice	GetSound (IMy3DSoundEmitter source, int sampleRate, int channels, MySoundDimensions dimension)

float	SemitonesToFrequencyRatio (float semitones)

int	GetUpdating3DSoundsCount ()

int	GetSoundInstancesTotal2D ()

int	GetSoundInstancesTotal3D ()

void	StopUpdatingAll3DCues ()

bool	SourceIsCloseEnoughToPlaySound (Vector3 position, MyCueId cueId, float?customMaxDistance=0)

bool	IsLoopable (MyCueId cueId)

object	CalculateDspSettingsDebug (IMy3DSoundEmitter source)

bool	ApplyTransition (MyStringId transitionEnum, int priority=0, MyStringId?category=null, bool loop=true)

void	WriteDebugInfo (StringBuilder sb)

ListReader< IMy3DSoundEmitter >	Get3DSounds ()

IMyAudioEffect	ApplyEffect (IMySourceVoice input, MyStringHash effect, MyCueId[] cueIds=null, float?duration=null, bool musicEffect=false)
	Creates effect on input emitter More...

Properties
Dictionary< MyCueId, MySoundData >.ValueCollection	CueDefinitions `[get]`

MySoundData	SoloCue `[get, set]`

bool	ApplyReverb `[get, set]`

float	VolumeMusic `[get, set]`

float	VolumeHud `[get, set]`

float	VolumeGame `[get, set]`

float	VolumeVoiceChat `[get, set]`

bool	Mute `[get, set]`

bool	MusicAllowed `[get, set]`

bool	GameSoundIsPaused `[get]`

bool	EnableVoiceChat `[get, set]`

bool	UseVolumeLimiter `[get, set]`

bool	UseSameSoundLimiter `[get, set]`

bool	EnableReverb `[get, set]`

int	SampleRate `[get]`

Events
Action< bool >	VoiceChatEnabled

Detailed Description

Definition at line 12 of file IMyAudio.cs.

Member Function Documentation

IMyAudioEffect VRage.Audio.IMyAudio.ApplyEffect	(	IMySourceVoice	input,
		MyStringHash	effect,
		MyCueId[]	cueIds = `null`,
		float?	duration = `null`,
		bool	musicEffect = `false`
	)

Creates effect on input emitter

Parameters

input	Emitter to work with
effect
cueIds	additional cues if effect mixes them (ie. crossfade)

Returns: effect output sound

Implemented in VRage.Audio.MyXAudio2.

bool VRage.Audio.IMyAudio.ApplyTransition	(	MyStringId	transitionEnum,
		int	priority = `0`,
		MyStringId?	category = `null`,
		bool	loop = `true`
	)

Implemented in VRage.Audio.MyXAudio2.

object VRage.Audio.IMyAudio.CalculateDspSettingsDebug ( IMy3DSoundEmitter source )

Implemented in VRage.Audio.MyXAudio2.

void VRage.Audio.IMyAudio.ChangeGlobalVolume	(	float	level,
		float	time
	)

Implemented in VRage.Audio.MyXAudio2.

void VRage.Audio.IMyAudio.EnableMasterLimiter ( bool enable )

Implemented in VRage.Audio.MyXAudio2.

ListReader<IMy3DSoundEmitter> VRage.Audio.IMyAudio.Get3DSounds ( )

Implemented in VRage.Audio.MyXAudio2.

Dictionary<MyStringId, List<MyCueId> > VRage.Audio.IMyAudio.GetAllMusicCues ( )

List<MyStringId> VRage.Audio.IMyAudio.GetCategories ( )

MySoundData VRage.Audio.IMyAudio.GetCue ( MyCueId cue )

IMySourceVoice VRage.Audio.IMyAudio.GetSound	(	MyCueId	cueId,
		IMy3DSoundEmitter	source = `null`,
		MySoundDimensions	type = `MySoundDimensions.D2`
	)

IMySourceVoice VRage.Audio.IMyAudio.GetSound	(	IMy3DSoundEmitter	source,
		int	sampleRate,
		int	channels,
		MySoundDimensions	dimension
	)

int VRage.Audio.IMyAudio.GetSoundInstancesTotal2D ( )

Implemented in VRage.Audio.MyXAudio2.

int VRage.Audio.IMyAudio.GetSoundInstancesTotal3D ( )

Implemented in VRage.Audio.MyXAudio2.

int VRage.Audio.IMyAudio.GetUpdating3DSoundsCount ( )

Implemented in VRage.Audio.MyXAudio2.

bool VRage.Audio.IMyAudio.HasAnyTransition ( )

Implemented in VRage.Audio.MyXAudio2.

bool VRage.Audio.IMyAudio.IsLoopable ( MyCueId cueId )

Implemented in VRage.Audio.MyXAudio2.

bool VRage.Audio.IMyAudio.IsValidTransitionCategory	(	MyStringId	transitionCategory,
		MyStringId	musicCategory
	)

Implemented in VRage.Audio.MyXAudio2.

void VRage.Audio.IMyAudio.LoadData	(	MyAudioInitParams	initParams,
		ListReader< MySoundData >	cues,
		ListReader< MyAudioEffect >	effects
	)

Implemented in VRage.Audio.MyXAudio2.

void VRage.Audio.IMyAudio.MuteHud ( bool mute )

Implemented in VRage.Audio.MyXAudio2.

void VRage.Audio.IMyAudio.Pause ( )

Implemented in VRage.Audio.MyXAudio2.

void VRage.Audio.IMyAudio.PauseGameSounds ( )

Implemented in VRage.Audio.MyXAudio2.

void VRage.Audio.IMyAudio.PlayMusic	(	MyMusicTrack?	track = `null`,
		int	priorityForRandom = `0`
	)

Implemented in VRage.Audio.MyXAudio2.

IMySourceVoice VRage.Audio.IMyAudio.PlayMusicCue	(	MyCueId	musicCue,
		bool	overrideMusicAllowed
	)

Implemented in VRage.Audio.MyXAudio2.

IMySourceVoice VRage.Audio.IMyAudio.PlaySound	(	MyCueId	cueId,
		IMy3DSoundEmitter	source = `null`,
		MySoundDimensions	type = `MySoundDimensions.D2`,
		bool	skipIntro = `false`,
		bool	skipToEnd = `false`
	)