Sound

Thin wrap around Mix_Chunk including loading [FLAC, MikMod, Ogg Vorbis, MP3, Wav] using SDL_Mixer.

class Sound : IVerifiable, IDisposable {

Mix_Chunk* handle [@property getter];

bool valid [@property getter];

this(string path);

static Sound fromChunk(Mix_Chunk* chunk);

static string error [@property getter];

void dispose();

int play(int loops = 0, int channel = -1, int maxTicks = -1);

int fadeIn(int ms, int loops = 1, int channel = -1, int maxTicks = -1);

static void stop(int channel = -1);

static void pause(int channel = -1);

static void resume(int channel = -1);

static float getVolume(int channel = -1);

static void setVolume(float value, int channel = -1);

static int isPlaying [@property setter];

static int isPaused [@property setter];

static int fadingStatus [@property setter];

}

Constructors

this this(string path): Loads a sound file

Destructor

A destructor is present on this object, but not explicitly documented in the source.

Members

Functions

dispose void dispose(): Deallocates the memory and invalidates this.
fadeIn int fadeIn(int ms, int loops = 1, int channel = -1, int maxTicks = -1): Plays this sound in the selected channel with a fade in effect.
play int play(int loops = 0, int channel = -1, int maxTicks = -1): Plays this sound in the selected channel.

Properties

error string error [@property getter]: Returns the latest sound related error
fadingStatus int fadingStatus [@property setter]
handle Mix_Chunk* handle [@property getter]: Handle to the Mix_Chunk*.
isPaused int isPaused [@property setter]: Tells you how many channels are paused if set to -1
isPlaying int isPlaying [@property setter]: Tells you how many channels are playing if set to -1
valid bool valid [@property getter]: Checks if the handle is not null.

Static functions

fromChunk Sound fromChunk(Mix_Chunk* chunk): Creates sound from a Mix_Chunk*.
getVolume float getVolume(int channel = -1): Returns the current volume as float in range 0.0 to 1.0
pause void pause(int channel = -1): Pause the sound playback. You may halt paused sounds.
resume void resume(int channel = -1): Unpause the sound. This is safe to use on halted, paused, and already playing sounds.
setVolume void setVolume(float value, int channel = -1): Sets the current volume as float in range 0.0 to 1.0
stop void stop(int channel = -1): Halt playback of sound. This interrupts sound fader effects.

Meta

Source

See Implementation

d2d audio sound modules