Class Song

Namespace

OmegaEngine.Audio

Assembly

OmegaEngine.dll

A streamed sound that is played in the background as music.

public class Song : EngineElement, IDisposable, IAudio

Inheritance

object

EngineElement

Song

Implements

IDisposable

IAudio

Inherited Members

EngineElement.RegisterChild(EngineElement, bool)

EngineElement.UnregisterChild(EngineElement)

EngineElement.Engine

EngineElement.IsEngineSet

EngineElement.IsDisposed

EngineElement.Dispose()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

XmlStorage.SaveXmlZip<T>(T, Stream, string?, params EmbeddedFile[])

XmlStorage.SaveXmlZip<T>(T, string, string?, params EmbeddedFile[])

XmlStorage.SaveXml<T>(T, Stream, string?)

XmlStorage.SaveXml<T>(T, string, string?)

XmlStorage.ToXmlString<T>(T, string?)

Constructors

Song(string)

Loads a song from an OGG file

public Song(string id)

Parameters

id string

The OGG file to load the song from

Exceptions

IOException

There was a problem loading the song.

Properties

ID

The ID of this song

public string ID { get; }

Property Value

string

Looping

Is this sound set to loop?

public bool Looping { get; }

Property Value

bool

Playing

Is this sound currently being played?

public bool Playing { get; }

Property Value

bool

Volume

The playback volume for the asset.

public int Volume { get; set; }

Property Value

int

Methods

OnDispose()

Hook that is called when the object needs to dispose its internal resources.

protected override void OnDispose()

OnEngineSet()

Hook that is called when Engine is set for the first time.

protected override void OnEngineSet()

StartPlayback(bool)

Starts the song playback

public void StartPlayback(bool looping)

Parameters

looping bool

StopPlayback()

Stops the song playback

public void StopPlayback()