Music

Object Hierarchy:

Description:

[ Compact ]
[ CCode ( cprefix = "sfMusic_" , free_function = "sfMusic_destroy" ) ]
public class Music

Streamed music played from an audio file.

Musics are sounds that are streamed rather than completely loaded in memory.

This is especially useful for compressed musics that usually take hundreds of MB when they are uncompressed: by streaming it instead of loading it entirely, you avoid saturating the memory and have almost no loading delay. This implies that the underlying resource (file, stream or memory buffer) must remain valid for the lifetime of the sf.Music object.

Apart from that, a sf.Music has almost the same features as the sf.SoundBuffer / sf.Sound pair: you can play/pause/stop it, request its parameters (channels, sample rate), change the way it is played (pitch, volume, 3D position, ...), etc.

As a sound stream, a music is played in its own thread in order not to block the rest of the program. This means that you can leave the music alone after calling play(), it will manage itself very well.

Usage example:

// Declare a new music
var music = new Music.fromFile("music.ogg");
 
if (music == null)) {
    // error...
}
 
// Change some parameters
music.setPosition(0, 1, 10); // change its 3D position
music.setPitch(2);           // increase the pitch
music.setVolume(50);         // reduce the volume
music.setLoop(true);         // make it loop
 
// Play it
music.play();

Content:

Creation methods:

public Music.fromFile (string filename)
public Music.fromMemory (void* data, size_t sizeInBytes)
public Music.fromStream (InputStream stream)

Methods:

public float getAttenuation ()
public uint getChannelCount ()
public Time getDuration ()
public bool getLoop ()
public TimeSpan getLoopPoints ()
public float getMinDistance ()
public float getPitch ()
public Time getPlayingOffset ()
public Vector3f getPosition ()
public uint getSampleRate ()
public SoundStatus getStatus ()
public float getVolume ()
public bool isRelativeToListener ()
public void pause ()
public void play ()
public void setAttenuation (float attenuation)
public void setLoop (bool loop)
public void setLoopPoints (TimeSpan timePoints)
public void setMinDistance (float distance)
public void setPitch (float pitch)
public void setPlayingOffset (Time timeOffset)
public void setPosition (Vector3f position)
public void setRelativeToListener (bool relative)
public void setVolume (float volume)
public void stop ()