Space Engineers
Classes | Public Member Functions | Properties | Events | List of all members
VRage.Audio.MyXAudio2 Class Reference
Inheritance diagram for VRage.Audio.MyXAudio2:
VRage.Audio.IMyAudio

Public Member Functions

void SetReverbParameters (float diffusion, float roomSize)
 
void ChangeGlobalVolume (float level, float time)
 
void EnableMasterLimiter (bool enable)
 
void LoadData (MyAudioInitParams initParams, ListReader< MySoundData > sounds, ListReader< MyAudioEffect > effects)
 
void SetSameSoundLimiter ()
 
void UnloadData ()
 
void ClearSounds ()
 
void ReloadData ()
 
void ReloadData (ListReader< MySoundData > sounds, ListReader< MyAudioEffect > effects)
 
void Pause ()
 
void Resume ()
 
void PauseGameSounds ()
 
void ResumeGameSounds ()
 
bool IsValidTransitionCategory (MyStringId transitionCategory, MyStringId musicCategory)
 
void PlayMusic (MyMusicTrack?track=null, int priorityForRandom=0)
 
IMySourceVoice PlayMusicCue (MyCueId musicCue, bool overrideMusicAllowed=false)
 
void StopMusic ()
 
void MuteHud (bool mute)
 
bool HasAnyTransition ()
 
void Update (int stepSizeInMS, Vector3 listenerPosition, Vector3 listenerUp, Vector3 listenerFront)
 
bool ApplyTransition (MyStringId transitionEnum, int priority=0, MyStringId?category=null, bool loop=true)
 
float SemitonesToFrequencyRatio (float semitones)
 
int GetUpdating3DSoundsCount ()
 
int GetSoundInstancesTotal2D ()
 
int GetSoundInstancesTotal3D ()
 
object CalculateDspSettingsDebug (IMy3DSoundEmitter source)
 
void StopUpdatingAll3DCues ()
 
bool SourceIsCloseEnoughToPlaySound (Vector3 sourcePosition, MyCueId cueId, float?customMaxDistance=0)
 
void WriteDebugInfo (StringBuilder sb)
 
bool IsLoopable (MyCueId cueId)
 
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

MySoundData SoloCue [get, set]
 
bool GameSoundIsPaused [get]
 
bool ApplyReverb [get, set]
 
float VolumeMusic [get, set]
 
float VolumeHud [get, set]
 
float VolumeGame [get, set]
 
float VolumeVoiceChat [get, set]
 
bool EnableVoiceChat [get, set]
 
bool Mute [get, set]
 
bool MusicAllowed [get, set]
 
- Properties inherited from VRage.Audio.IMyAudio
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
 
- Events inherited from VRage.Audio.IMyAudio
Action< bool > VoiceChatEnabled
 

Detailed Description

Definition at line 22 of file MyXAudio2.cs.

Member Function Documentation

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

Creates effect on input emitter

Parameters
inputEmitter to work with
effect
cueIdsadditional cues if effect mixes them (ie. crossfade)
Returns
effect output sound

Implements VRage.Audio.IMyAudio.

Definition at line 1402 of file MyXAudio2.cs.

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

Implements VRage.Audio.IMyAudio.

Definition at line 990 of file MyXAudio2.cs.

object VRage.Audio.MyXAudio2.CalculateDspSettingsDebug ( IMy3DSoundEmitter  source)
inline

Implements VRage.Audio.IMyAudio.

Definition at line 1171 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.ChangeGlobalVolume ( float  level,
float  time 
)
inline

Implements VRage.Audio.IMyAudio.

Definition at line 277 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.ClearSounds ( )
inline

Definition at line 541 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.EnableMasterLimiter ( bool  enable)
inline

Implements VRage.Audio.IMyAudio.

Definition at line 319 of file MyXAudio2.cs.

ListReader<IMy3DSoundEmitter> VRage.Audio.MyXAudio2.Get3DSounds ( )
inline

Implements VRage.Audio.IMyAudio.

Definition at line 1396 of file MyXAudio2.cs.

int VRage.Audio.MyXAudio2.GetSoundInstancesTotal2D ( )
inline

Implements VRage.Audio.IMyAudio.

Definition at line 1121 of file MyXAudio2.cs.

int VRage.Audio.MyXAudio2.GetSoundInstancesTotal3D ( )
inline

Implements VRage.Audio.IMyAudio.

Definition at line 1126 of file MyXAudio2.cs.

int VRage.Audio.MyXAudio2.GetUpdating3DSoundsCount ( )
inline

Implements VRage.Audio.IMyAudio.

Definition at line 1116 of file MyXAudio2.cs.

bool VRage.Audio.MyXAudio2.HasAnyTransition ( )
inline

Implements VRage.Audio.IMyAudio.

Definition at line 873 of file MyXAudio2.cs.

bool VRage.Audio.MyXAudio2.IsLoopable ( MyCueId  cueId)
inline

Implements VRage.Audio.IMyAudio.

Definition at line 1385 of file MyXAudio2.cs.

bool VRage.Audio.MyXAudio2.IsValidTransitionCategory ( MyStringId  transitionCategory,
MyStringId  musicCategory 
)
inline

Implements VRage.Audio.IMyAudio.

Definition at line 798 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.LoadData ( MyAudioInitParams  initParams,
ListReader< MySoundData >  sounds,
ListReader< MyAudioEffect >  effects 
)
inline

Implements VRage.Audio.IMyAudio.

Definition at line 425 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.MuteHud ( bool  mute)
inline

Implements VRage.Audio.IMyAudio.

Definition at line 867 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.Pause ( )
inline

Implements VRage.Audio.IMyAudio.

Definition at line 721 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.PauseGameSounds ( )
inline

Implements VRage.Audio.IMyAudio.

Definition at line 733 of file MyXAudio2.cs.

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

Implements VRage.Audio.IMyAudio.

Definition at line 804 of file MyXAudio2.cs.

IMySourceVoice VRage.Audio.MyXAudio2.PlayMusicCue ( MyCueId  musicCue,
bool  overrideMusicAllowed = false 
)
inline

Implements VRage.Audio.IMyAudio.

Definition at line 831 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.ReloadData ( )
inline

Implements VRage.Audio.IMyAudio.

Definition at line 547 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.ReloadData ( ListReader< MySoundData >  sounds,
ListReader< MyAudioEffect >  effects 
)
inline

Implements VRage.Audio.IMyAudio.

Definition at line 553 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.Resume ( )
inline

Implements VRage.Audio.IMyAudio.

Definition at line 727 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.ResumeGameSounds ( )
inline

Implements VRage.Audio.IMyAudio.

Definition at line 745 of file MyXAudio2.cs.

float VRage.Audio.MyXAudio2.SemitonesToFrequencyRatio ( float  semitones)
inline

Implements VRage.Audio.IMyAudio.

Definition at line 1105 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.SetReverbParameters ( float  diffusion,
float  roomSize 
)
inline

Implements VRage.Audio.IMyAudio.

Definition at line 269 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.SetSameSoundLimiter ( )
inline

Implements VRage.Audio.IMyAudio.

Definition at line 501 of file MyXAudio2.cs.

bool VRage.Audio.MyXAudio2.SourceIsCloseEnoughToPlaySound ( Vector3  sourcePosition,
MyCueId  cueId,
float?  customMaxDistance = 0 
)
inline

Implements VRage.Audio.IMyAudio.

Definition at line 1230 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.StopMusic ( )
inline

Implements VRage.Audio.IMyAudio.

Definition at line 845 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.StopUpdatingAll3DCues ( )
inline

Implements VRage.Audio.IMyAudio.

Definition at line 1222 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.UnloadData ( )
inline

Implements VRage.Audio.IMyAudio.

Definition at line 510 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.Update ( int  stepSizeInMS,
Vector3  listenerPosition,
Vector3  listenerUp,
Vector3  listenerFront 
)
inline

Implements VRage.Audio.IMyAudio.

Definition at line 884 of file MyXAudio2.cs.

void VRage.Audio.MyXAudio2.WriteDebugInfo ( StringBuilder  sb)
inline

Implements VRage.Audio.IMyAudio.

Definition at line 1379 of file MyXAudio2.cs.

Property Documentation

bool VRage.Audio.MyXAudio2.ApplyReverb
getset

Definition at line 560 of file MyXAudio2.cs.

bool VRage.Audio.MyXAudio2.EnableVoiceChat
getset

Definition at line 699 of file MyXAudio2.cs.

bool VRage.Audio.MyXAudio2.GameSoundIsPaused
get

Definition at line 121 of file MyXAudio2.cs.

bool VRage.Audio.MyXAudio2.MusicAllowed
getset

Definition at line 793 of file MyXAudio2.cs.

bool VRage.Audio.MyXAudio2.Mute
getset

Definition at line 760 of file MyXAudio2.cs.

MySoundData VRage.Audio.MyXAudio2.SoloCue
getset

Definition at line 120 of file MyXAudio2.cs.

float VRage.Audio.MyXAudio2.VolumeGame
getset

Definition at line 662 of file MyXAudio2.cs.

float VRage.Audio.MyXAudio2.VolumeHud
getset

Definition at line 633 of file MyXAudio2.cs.

float VRage.Audio.MyXAudio2.VolumeMusic
getset

Definition at line 604 of file MyXAudio2.cs.

float VRage.Audio.MyXAudio2.VolumeVoiceChat
getset

Definition at line 687 of file MyXAudio2.cs.

Event Documentation

Action<bool> VRage.Audio.MyXAudio2.VoiceChatEnabled

Definition at line 719 of file MyXAudio2.cs.

The documentation for this class was generated from the following file:
Generated on Mon Jan 23 2017 01:18:02 for Space Engineers by   doxygen 1.8.8