IAudioUtilities

interface IAudioUtilities

The AudioUtilities interface.

IAudioHandle GetHandle(Protogame.IAssetReference<AudioAsset> asset)

Obtains an audio handle instance for an audio asset. This instance can then be played, looped or stopped through the T:Protogame.IAudioHandle interface.

Parameters:

• asset (Protogame.IAssetReference<AudioAsset>) – The audio asset to obtain an instance handle for.

Returns:

The T:Protogame.IAudioHandle instance handle.

IAudioHandle Loop(Protogame.IAssetReference<AudioAsset> asset)

Obtains an audio handle instance for an audio asset and starts playing it looped. This instance can then be controlled through the T:Protogame.IAudioHandle interface.

Parameters:

• asset (Protogame.IAssetReference<AudioAsset>) – The audio asset to obtain an instance handle for.

Returns:

The T:Protogame.IAudioHandle instance handle.

IAudioHandle Play(Protogame.IAssetReference<AudioAsset> asset)

Obtains an audio handle instance for an audio asset and plays it once. This instance can then be controlled through the T:Protogame.IAudioHandle interface.

Parameters:

• asset (Protogame.IAssetReference<AudioAsset>) – The audio asset to obtain an instance handle for.

Returns:

The T:Protogame.IAudioHandle instance handle.