Class AudioPlayer

Namespace

Axolotl2D.Audio

Assembly

Axolotl2D.dll

Plays shared SoundAssets through an OpenAL device.

public sealed class AudioPlayer : IDisposable

Inheritance

object

AudioPlayer

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AudioPlayer()

public AudioPlayer()

Properties

ListenerPosition

The listener position in game-defined 2D world units.

public Vector2 ListenerPosition { get; set; }

Property Value

Vector2

ListenerVelocity

public Vector2 ListenerVelocity { get; set; }

Property Value

Vector2

MasterVolume

public float MasterVolume { get; set; }

Property Value

float

Muted

public bool Muted { get; set; }

Property Value

bool

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

PauseAll()

public void PauseAll()

Play(SoundAsset, bool, float, float, float)

public SoundPlayback Play(SoundAsset asset, bool loop = false, float volume = 1, float pitch = 1, float pan = 0)

Parameters

asset SoundAsset

loop bool

volume float

pitch float

pan float

Returns

SoundPlayback

PlayOneShot(SoundAsset, float, float, float)

public void PlayOneShot(SoundAsset asset, float volume = 1, float pitch = 1, float pan = 0)

Parameters

asset SoundAsset

volume float

pitch float

pan float

PlayOneShotSpatial(SoundAsset, Vector2, float, float, float, float, float)

public void PlayOneShotSpatial(SoundAsset asset, Vector2 position, float volume = 1, float pitch = 1, float referenceDistance = 100, float maximumDistance = 1000, float rolloffFactor = 1)

Parameters

asset SoundAsset

position Vector2

volume float

pitch float

referenceDistance float

maximumDistance float

rolloffFactor float

PlaySpatial(SoundAsset, Vector2, bool, float, float, float, float, float)

public SoundPlayback PlaySpatial(SoundAsset asset, Vector2 position, bool loop = false, float volume = 1, float pitch = 1, float referenceDistance = 100, float maximumDistance = 1000, float rolloffFactor = 1)

Parameters

asset SoundAsset

position Vector2

loop bool

volume float

pitch float

referenceDistance float

maximumDistance float

rolloffFactor float

Returns

SoundPlayback

ResumeAll()

public void ResumeAll()

StopAll()

public void StopAll()