VerticesEngine.Audio.vxAudioManager Class Reference

Audio manager keeps track of what 3D sounds are playing, updating their settings as the camera and entities move around the world, and automatically disposing sound effect instances after they finish playing. More...

Classes
class	ActiveSound
	Internal helper class for keeping track of an active 3D sound, and remembering which emitter object it is attached to. More...
class	Music
	Music Song Collections. More...

Static Public Member Functions
static void	Dispose ()
	Unloads the sound effect data.
static void	Clear ()
static void	LoadSoundEffect (ContentManager Content, object key, string Path)
static SoundEffect	GetSound (object key)
static SoundEffectInstance	CreateInstance (object key)
static void	Stop ()
	Stops all Sound Effects.
static SoundEffectInstance	PlaySoundNow (object key, float Volume=1, float Pitch=0, bool UseTransitionAlpha=true, bool isLooping=false)
	Plays a sound right now.
static void	PlaySound (object sender, object key, float Volume=1, float Pitch=0, bool UseTransitionAlpha=true)
	Plays a sound. This is placed into a queue to be played as soon as possible. Certain plaftorms will only allow so many Sound Effects at a time.
static void	PlaySound3D (object sender, object key, bool isLooped, Vector3 position, float pitch=0)
	Plays a sound. This is placed into a queue to be played as soon as possible. Certain plaftorms will only allow so many Sound Effects at a time.
static void	Update ()
	Updates the state of the 3D audio system.
static SoundEffectInstance	Play3DSound (object key, bool isLooped, vxEntity3D emitter)
static SoundEffectInstance	Play3DSound (SoundEffect soundEffect, bool isLooped, vxEntity3D emitter)
	Triggers a new 3D sound Based off of Entity.
static SoundEffectInstance	Play3DSound (SoundEffect soundEffect, bool isLooped, Vector3 position, Vector3 velocity)
static SoundEffectInstance	Play3DSound (SoundEffect soundEffect, bool isLooped, Vector3 position, Vector3 velocity, float pitch)
	Triggers a new 3D sound Based off of Entity Position.

Static Public Attributes
static float	MainVolume = 0.5f
static float	SoundEffectVolume = 0.5f
static float	MusicVolume = 0.5f
static List< ActiveSound >	active3DSounds = new List<ActiveSound>()

Properties
static AudioListener	Listener [get]

Detailed Description

Audio manager keeps track of what 3D sounds are playing, updating their settings as the camera and entities move around the world, and automatically disposing sound effect instances after they finish playing.

Member Function Documentation

PlaySound()

static void VerticesEngine.Audio.vxAudioManager.PlaySound ( object sender, object key, float Volume = 1, float Pitch = 0, bool UseTransitionAlpha = true )

static

Plays a sound. This is placed into a queue to be played as soon as possible. Certain plaftorms will only allow so many Sound Effects at a time.

Parameters

sender
key
Volume
Pitch
UseTransitionAlpha

PlaySound3D()

static void VerticesEngine.Audio.vxAudioManager.PlaySound3D ( object sender, object key, bool isLooped, Vector3 position, float pitch = 0 )

static

Plays a sound. This is placed into a queue to be played as soon as possible. Certain plaftorms will only allow so many Sound Effects at a time.

Parameters

sender
key
isLooped
position
pitch

PlaySoundNow()

static SoundEffectInstance VerticesEngine.Audio.vxAudioManager.PlaySoundNow ( object key, float Volume = 1, float Pitch = 0, bool UseTransitionAlpha = true, bool isLooping = false )

static

Plays a sound right now.

Parameters

sender
key
Volume
Pitch
UseTransitionAlpha

---

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

• /github/workspace/src/VerticesEngine/src.shared/Audio/vxAudioManager.cs