AudioEngineΒΆ

class AudioEngine : System.Object, System.IDisposable

Class used to create and manipulate code audio objects.

int ContentVersion

The current content version.

readonly bool IsDisposed

Is true if the AudioEngine has been disposed.

Microsoft.Xna.Framework.Audio.AudioCategory[] get_Categories()
Microsoft.Xna.Framework.Audio.RpcVariable[] CreateCueVariables()
System.IO.Stream OpenStream(string filePath)
Parameters:
  • filePath (string) –
int GetRpcIndex(uint fileOffset)
Parameters:
  • fileOffset (uint) –
public void Update()

Performs periodic work required by the audio engine.

public AudioCategory GetCategory(string name)

Returns an audio category by name.

Parameters:
  • name (string) – Friendly name of the category to get.
Returns:

The AudioCategory with a matching name. Throws an exception if not found.
public float GetGlobalVariable(string name)

Gets the value of a global variable.

Parameters:
  • name (string) – Friendly name of the variable.
Returns:

float value of the queried variable.
float GetGlobalVariable(int index)
Parameters:
  • index (int) –
public void SetGlobalVariable(string name, float value)

Sets the value of a global variable.

Parameters:
  • name (string) – Friendly name of the variable.
  • value (float) – Value of the global variable.
public void add_Disposing(System.EventHandler<EventArgs> value)
Parameters:
  • value (System.EventHandler<EventArgs>) –
public void remove_Disposing(System.EventHandler<EventArgs> value)
Parameters:
  • value (System.EventHandler<EventArgs>) –
public void Dispose()

Disposes the AudioEngine.