Class XSound

Namespace

OmegaEngine.Assets

Assembly

OmegaEngine.dll

A sound loaded from an audio file, decoded into in-memory IEEE-float samples ready for playback.

public class XSound : Asset, IReferenceCount, IDisposable, INamed, IComparable<Asset>

Inheritance

object

Asset

XSound

Implements

IReferenceCount

IDisposable

INamed

IComparable<Asset>

Inherited Members

Asset.Name

Asset.ToString()

Asset.ReferenceCount

Asset.HoldReference()

Asset.ReleaseReference()

Asset.Disposed

Asset.Dispose()

Asset.Dispose(bool)

Constructors

XSound(WaveStream)

Loads a sound from an audio file stream.

protected XSound(WaveStream stream)

Parameters

stream WaveStream

The audio file to load the sound from.

Remarks

This should only be called by Get(Engine, string?) to prevent unnecessary duplicates.

Properties

Format

The format of Samples (IEEE-float, SampleRate, native channel count).

public WaveFormat Format { get; }

Property Value

WaveFormat

Samples

The decoded, interleaved IEEE-float samples at SampleRate.

public float[] Samples { get; }

Property Value

float[]

Methods

Get(Engine, string?)

Returns a cached XSound or creates a new one if the requested ID is not cached.

public static XSound? Get(Engine engine, string? id)

Parameters

engine Engine

The Engine providing the cache.

id string

The ID of the asset to be returned.

Returns

XSound

The requested asset; null if id was empty.

Remarks

Remember to call Clean() when done, otherwise this object will never be released.

Exceptions

FileNotFoundException

The specified file could not be found.

IOException

There was an error reading the file.

UnauthorizedAccessException

Read access to the file is not permitted.

InvalidDataException

The file does not contain valid sound data.