Audio

Audio

SplashKit Audio allows you to load and play music and sound effects.

Functions

Audio Ready

Checks if SplashKit audio currently ready to be used. Should this return false, you may want to use Open Audio to enable audio.

Return Type: Boolean

Signatures:

C++

bool audio_ready()

C#

public static bool Audio.IsReady { get }
public static bool SplashKit.AudioReady();

Python

def audio_ready():

Pascal

function AudioReady(): Boolean

---

Close Audio

Turns off audio, stopping all current sounds effects and music.

Signatures:

C++

void close_audio()

C#

public static void SplashKit.CloseAudio();

Python

def close_audio():

Pascal

procedure CloseAudio()

---

Open Audio

Starts the SplashKit audio system working.

Signatures:

C++

void open_audio()

C#

public static void SplashKit.OpenAudio();

Python

def open_audio():

Pascal

procedure OpenAudio()

---

Fade Music In

Note

This function is overloaded. The following versions exist:

• Fade Music In (name: string, ms: int)
• Fade Music In (name: string, times: int, ms: int)
• Fade Music In (data: music, ms: int)
• Fade Music In (data: music, times: int, ms: int)

Fade Music In

Fades music file matching the name to full volume over a specified number of milliseconds

Parameters:

Name	Type	Description
name	String	The name of the Music file to play.
ms	Integer	How many milliseconds it takes to fade the Music to full volume

Signatures:

C++

void fade_music_in(const string &name, int ms)

C#

public static void SplashKit.FadeMusicIn(string name, int ms);

Python

def fade_music_in_named(name, ms):

Pascal

procedure FadeMusicIn(const name: String; ms: Integer)

---

Fade Music In

Fades music file matching the name to full volume over a specified number of milliseconds and loops a specified number of times

Parameters:

Name	Type	Description
name	String	The name of the Music file to play.
times	Integer	Controls the number of times the music is played.
ms	Integer	How many milliseconds it takes to fade the Music to full volume

Signatures:

C++

void fade_music_in(const string &name, int times, int ms)

C#

public static void SplashKit.FadeMusicIn(string name, int times, int ms);

Python

def fade_music_in_named_with_times(name, times, ms):

Pascal

procedure FadeMusicIn(const name: String; times: Integer; ms: Integer)

---

Fade Music In

Fades music up to full volume over a specified number of milliseconds.

Parameters:

Name	Type	Description
data	Music	The name of the Music to play.
ms	Integer	How many milliseconds it takes to fade the Music to full volume

Signatures:

C++

void fade_music_in(music data, int ms)

C#

public void Music.FadeIn(int ms);
public static void SplashKit.FadeMusicIn(Music data, int ms);

Python

def fade_music_in(data, ms):

Pascal

procedure FadeMusicIn(data: Music; ms: Integer)

---

Fade Music In

Fades music up to full volume over a specified number of milliseconds for a specified number of times.

Parameters:

Name	Type	Description
data	Music	The name of the Music to play.
times	Integer	Controls the number of times the music is played.
ms	Integer	How many milliseconds it takes to fade the Music to full volume

Signatures:

C++

void fade_music_in(music data, int times, int ms)

C#

public void Music.FadeIn(int times, int ms);
public static void SplashKit.FadeMusicIn(Music data, int times, int ms);

Python

def fade_music_in_with_times(data, times, ms):

Pascal

procedure FadeMusicIn(data: Music; times: Integer; ms: Integer)

---

Fade Music Out

Fades music outover a specified number of milliseconds

Parameters:

Name	Type	Description
ms	Integer	How many milliseconds it takes to fade the Music out

Signatures:

C++

void fade_music_out(int ms)

C#

public static void Audio.FadeOut(int ms);
public static void SplashKit.FadeMusicOut(int ms);

Python

def fade_music_out(ms):

Pascal

procedure FadeMusicOut(ms: Integer)

---

Free All Music

Releases all of the music files that have been loaded.

Signatures:

C++

void free_all_music()

C#

public static void Audio.FreeAllMusic();
public static void SplashKit.FreeAllMusic();

Python

def free_all_music():

Pascal

procedure FreeAllMusic()

---

Free Music

Releases the SplashKit resources associated with music.

Parameters:

Name	Type	Description
effect	Music	The music file whose resources should be released.

Signatures:

C++

void free_music(music effect)

C#

public static void SplashKit.FreeMusic(Music effect);

Python

def free_music(effect):

Pascal

procedure FreeMusic(effect: Music)

---

Has Music

Determines if SplashKit has a music file loaded for the supplied name. This checks against all music files loaded, those loaded without a name are assigned the filename as a default. If this returns false, you may want to use Load Music to load in a specific sound effect and give it the desired name.

Parameters:

Name	Type	Description
name	String	The name to check if a music file is loaded.

Return Type: Boolean

Signatures:

C++

bool has_music(const string &name)

C#

public static bool SplashKit.HasMusic(string name);

Python

def has_music(name):

Pascal

function HasMusic(const name: String): Boolean

---

Load Music

Loads and returns a music value. The supplied filename is used to locate the music file to load. The supplied name indicates the name to use to refer to this Music value. The Music can then be retrieved by passing this name to the Music Named function.

Parameters:

Name	Type	Description
name	String	The name of the resource for SplashKit
filename	String	The filename to load

Return Type: Music

Signatures:

C++

music load_music(const string &name, const string &filename)

C#

public static Music SplashKit.LoadMusic(string name, string filename);
public Music(string name, string filename);

Python

def load_music(name, filename):

Pascal

function LoadMusic(const name: String; const filename: String): Music

---

Music Filename

Returns the filename the of the music data

Parameters:

Name	Type	Description
data	Music	The music resource

Return Type: String

Signatures:

C++

string music_filename(music data)

C#

public string Music.Filename { get }
public static string SplashKit.MusicFilename(Music data);

Python

def music_filename(data):

Pascal

function MusicFilename(data: Music): String

---

Music Name

Returns the name that SplashKit uses to refer to this music data

Parameters:

Name	Type	Description
data	Music	The music resource

Return Type: String

Signatures:

C++

string music_name(music data)

C#

public string Music.Name { get }
public static string SplashKit.MusicName(Music data);

Python

def music_name(data):

Pascal

function MusicName(data: Music): String

---

Music Named

Retrieves a Music that has been loaded into SplashKit.

Parameters:

Name	Type	Description
name	String	The name of the music file to return.

Return Type: Music

Signatures:

C++

music music_named(const string &name)

C#

public static Music SplashKit.MusicNamed(string name);

Python

def music_named(name):

Pascal

function MusicNamed(const name: String): Music

---

Music Playing

Checks whether music is currently playing.

Return Type: Boolean

Signatures:

C++

bool music_playing()

C#

public static bool Audio.Playing { get }
public static bool SplashKit.MusicPlaying();

Python

def music_playing():

Pascal

function MusicPlaying(): Boolean

---

Music Valid

Lets you test if music value is valid. This will return true when it is a valid music.

Parameters:

Name	Type	Description
m	Music	the music source to test

Return Type: Boolean

Signatures:

C++

bool music_valid(music m)

C#

public static bool SplashKit.MusicValid(Music m);

Python

def music_valid(m):

Pascal

function MusicValid(m: Music): Boolean

---

Music Volume

Returns the volume of the currently playing Music.

Return Type: Double

Signatures:

C++

double music_volume()

C#

public static double Audio.Volume { get }
public static double SplashKit.MusicVolume();

Python

def music_volume():

Pascal

function MusicVolume(): Double

---

Pause Music

Pauses currently playing music - see resume_music to continue playing.

Signatures:

C++

void pause_music()

C#

public static void Audio.Pause();
public static void SplashKit.PauseMusic();

Python

def pause_music():

Pascal

procedure PauseMusic()

---

Play Music

Note

This function is overloaded. The following versions exist:

• Play Music (name: string)
• Play Music (name: string, times: int)
• Play Music (data: music)
• Play Music (data: music, times: int)
• Play Music (data: music, times: int, volume: double)

Play Music

Plays the music file that matches the name once at full volume.

Parameters:

Name	Type	Description
name	String	The name of the Music to play.

Signatures:

C++

void play_music(const string &name)

C#

public static void SplashKit.PlayMusic(string name);

Python

def play_music_named(name):

Pascal

procedure PlayMusic(const name: String)

---

Play Music

Plays the music file that matches the name a specified number of times at full volume.

Parameters:

Name	Type	Description
name	String	The name of the Music to play.
times	Integer	Controls the number of times the music is played.

Signatures:

C++

void play_music(const string &name, int times)

C#

public static void SplashKit.PlayMusic(string name, int times);

Python

def play_music_named_with_times(name, times):

Pascal

procedure PlayMusic(const name: String; times: Integer)

---

Play Music

Plays a music file once at full volume.

Parameters:

Name	Type	Description
data	Music	The name of the Music to play.

Signatures:

C++

void play_music(music data)

C#

public void Music.Play();
public static void SplashKit.PlayMusic(Music data);

Python

def play_music(data):

Pascal

procedure PlayMusic(data: Music)

---

Play Music

Plays a music file a specified number of times at full volume.

Parameters:

Name	Type	Description
data	Music	The name of the Music to play.
times	Integer	Controls the number of times the music is played.

Signatures:

C++

void play_music(music data, int times)

C#

public void Music.Play(int times);
public static void SplashKit.PlayMusic(Music data, int times);

Python

def play_music_with_times(data, times):

Pascal

procedure PlayMusic(data: Music; times: Integer)

---

Play Music

Plays a music file for a specified number of times and playback volume.

Parameters:

Name	Type	Description
data	Music	The name of the Music to play.
times	Integer	Controls the number of times the music is played.
volume	Double	Indicates the percentage of the original volume to play the Music at. This must be between 0 and 1.

Signatures:

C++

void play_music(music data, int times, double volume)

C#

public void Music.Play(int times, double volume);
public static void SplashKit.PlayMusic(Music data, int times, double volume);

Python

def play_music_with_times_and_volume(data, times, volume):

Pascal

procedure PlayMusic(data: Music; times: Integer; volume: Double)

---

Resume Music

Resumes currently paused music - see pause_music to pause playing music.

Signatures:

C++

void resume_music()

C#

public static void Audio.Resume();
public static void SplashKit.ResumeMusic();

Python

def resume_music():

Pascal

procedure ResumeMusic()

---

Set Music Volume

Sets the volume of the currently playing Music. Must be between 0 and 1, e.g. 0.1 is 10%.

Parameters:

Name	Type	Description
volume	Double	Indicates the percentage of the original volume to play the Music at. This must be between 0 and 1.

Signatures:

C++

void set_music_volume(double volume)

C#

public static void Audio.Volume { set }
public static void SplashKit.SetMusicVolume(double volume);

Python

def set_music_volume(volume):

Pascal

procedure SetMusicVolume(volume: Double)

---

Stop Music

Stops currently playing music.

Signatures:

C++

void stop_music()

C#

public static void Audio.Stop();
public static void SplashKit.StopMusic();

Python

def stop_music():

Pascal

procedure StopMusic()

---

Fade All Sound Effects Out

Fades out all Sound Effects over the specified milliseconds.

Parameters:

Name	Type	Description
ms	Integer	The number of milliseconds to fade out all sound effects.

Signatures:

C++

void fade_all_sound_effects_out(int ms)

C#

public static void SplashKit.FadeAllSoundEffectsOut(int ms);

Python

def fade_all_sound_effects_out(ms):

Pascal

procedure FadeAllSoundEffectsOut(ms: Integer)

---

Fade Sound Effect Out

Fades out the Sound Effect over the specified milliseconds.

Parameters:

Name	Type	Description
effect	Sound Effect	The Sound Effect to fade out.
ms	Integer	The number of milliseconds to fade out the Sound Effect.

Signatures:

C++

void fade_sound_effect_out(sound_effect effect, int ms)

C#

public void SoundEffect.FadeOut(int ms);
public static void SplashKit.FadeSoundEffectOut(SoundEffect effect, int ms);

Python

def fade_sound_effect_out(effect, ms):

Pascal

procedure FadeSoundEffectOut(effect: SoundEffect; ms: Integer)

---

Free All Sound Effects

Releases all of the sound effects that have been loaded.

Signatures:

C++

void free_all_sound_effects()

C#

public static void SplashKit.FreeAllSoundEffects();

Python

def free_all_sound_effects():

Pascal

procedure FreeAllSoundEffects()

---

Free Sound Effect

Releases the SplashKit resources associated with the sound effect.

Parameters:

Name	Type	Description
effect	Sound Effect	The Sound Effect whose resources should be released.

Signatures:

C++

void free_sound_effect(sound_effect effect)

C#

public void SoundEffect.Close();
public static void SplashKit.FreeSoundEffect(SoundEffect effect);

Python

def free_sound_effect(effect):

Pascal

procedure FreeSoundEffect(effect: SoundEffect)

---

Has Sound Effect

Determines if SplashKit has a sound effect loaded for the supplied name. This checks against all sounds loaded, those loaded without a name are assigned the filename as a default. If this returns false, you may want to use Load Sound Effect to load in a specific sound effect and give it the desired name.

Parameters:

Name	Type	Description
name	String	The name to check if a sound effect is loaded.

Return Type: Boolean

Signatures:

C++

bool has_sound_effect(const string &name)

C#

public static bool SplashKit.HasSoundEffect(string name);

Python

def has_sound_effect(name):

Pascal

function HasSoundEffect(const name: String): Boolean

---

Load Sound Effect

The supplied filename is used to locate the sound effect to load. The supplied name indicates the name to use to refer to this Sound Effect. The Sound Effect can then be retrieved by passing this name to the Sound Effect Named function.

Parameters:

Name	Type	Description
name	String	The name used to refer to the sound effect.
filename	String	The filename used to locate the sound effect to use.

Return Type: Sound Effect

Usage:

See Implemenations in Guides

• Get Started with SplashKit Audio

Signatures:

C++

sound_effect load_sound_effect(const string &name, const string &filename)

C#

public static SoundEffect SplashKit.LoadSoundEffect(string name, string filename);
public SoundEffect(string name, string filename);

Python

def load_sound_effect(name, filename):

Pascal

function LoadSoundEffect(const name: String; const filename: String): SoundEffect

---

Play Sound Effect

Note

This function is overloaded. The following versions exist:

• Play Sound Effect (name: string)
• Play Sound Effect (name: string, volume: double)
• Play Sound Effect (name: string, times: int)
• Play Sound Effect (name: string, times: int, volume: double)
• Play Sound Effect (effect: sound_effect)
• Play Sound Effect (effect: sound_effect, volume: double)
• Play Sound Effect (effect: sound_effect, times: int)
• Play Sound Effect (effect: sound_effect, times: int, volume: double)

Play Sound Effect

Plays a sound effect once at full volume.

Parameters:

Name	Type	Description
name	String	The name of the effect to play.

Signatures:

C++

void play_sound_effect(const string &name)

C#

public static void SplashKit.PlaySoundEffect(string name);

Python

def play_sound_effect_named(name):

Pascal

procedure PlaySoundEffect(const name: String)

---

Play Sound Effect

Plays a sound effect once at full volume.

Parameters:

Name	Type	Description
name	String	The name of the effect to play.
volume	Double	The volume to play the Sound Effect

Signatures:

C++

void play_sound_effect(const string &name, double volume)

C#

public static void SplashKit.PlaySoundEffect(string name, double volume);

Python

def play_sound_effect_named_with_volume(name, volume):

Pascal

procedure PlaySoundEffect(const name: String; volume: Double)

---

Play Sound Effect

Plays a sound effect for a specified number of times at full volume.

Parameters:

Name	Type	Description
name	String	The name of the effect to play.
times	Integer	Controls the number of times the sound effect is played.

Signatures:

C++

void play_sound_effect(const string &name, int times)

C#

public static void SplashKit.PlaySoundEffect(string name, int times);

Python

def play_sound_effect_named_with_times(name, times):

Pascal

procedure PlaySoundEffect(const name: String; times: Integer)

---

Play Sound Effect

Plays a sound effect for a specified number of times and playback volume.

Parameters:

Name	Type	Description
name	String	The name of the effect to play.
times	Integer	Controls the number of times the sound effect is played.
volume	Double	Indicates the percentage of the original volume to play the Sound Effect at. This must be between 0 and 1.

Signatures:

C++

void play_sound_effect(const string &name, int times, double volume)

C#

public static void SplashKit.PlaySoundEffect(string name, int times, double volume);

Python

def play_sound_effect_named_with_times_and_volume(name, times, volume):

Pascal

procedure PlaySoundEffect(const name: String; times: Integer; volume: Double)

---

Play Sound Effect

Plays a sound effect once at full volume.

Parameters:

Name	Type	Description
effect	Sound Effect	The effect indicates which sound effect to start playing.

Usage:

See Implemenations in Guides

• Get Started with SplashKit Audio

Signatures:

C++

void play_sound_effect(sound_effect effect)

C#

public void SoundEffect.Play();
public static void SplashKit.PlaySoundEffect(SoundEffect effect);

Python

def play_sound_effect(effect):

Pascal

procedure PlaySoundEffect(effect: SoundEffect)

---

Play Sound Effect

Plays a sound effect once at playback volume.

Parameters:

Name	Type	Description
effect	Sound Effect	The effect indicates which sound effect to start playing.
volume	Double	Indicates the percentage of the original volume to play the Sound Effect at. This must be between 0 and 1.

Signatures:

C++

void play_sound_effect(sound_effect effect, double volume)

C#

public void SoundEffect.Play(double volume);
public static void SplashKit.PlaySoundEffect(SoundEffect effect, double volume);

Python

def play_sound_effect_with_volume(effect, volume):

Pascal

procedure PlaySoundEffect(effect: SoundEffect; volume: Double)

---

Play Sound Effect

Plays a sound effect once at full volume.

Parameters:

Name	Type	Description
effect	Sound Effect	The effect indicates which sound effect to start playing.
times	Integer	Controls the number of times the sound effect is played.

Signatures:

C++

void play_sound_effect(sound_effect effect, int times)

C#

public void SoundEffect.Play(int times);
public static void SplashKit.PlaySoundEffect(SoundEffect effect, int times);

Python

def play_sound_effect_with_times(effect, times):

Pascal

procedure PlaySoundEffect(effect: SoundEffect; times: Integer)

---

Play Sound Effect

This version of Play Sound Effect allows you to control both the number of times the Sound Effect is repeated and its playback volume.

Parameters:

Name	Type	Description
effect	Sound Effect	The effect indicates which sound effect to start playing.
times	Integer	Controls the number of times the sound effect is played.
volume	Double	Indicates the percentage of the original volume to play the Sound Effect at. This must be between 0 and 1.

Signatures:

C++

void play_sound_effect(sound_effect effect, int times, double volume)

C#

public void SoundEffect.Play(int times, double volume);
public static void SplashKit.PlaySoundEffect(SoundEffect effect, int times, double volume);

Python

def play_sound_effect_with_times_and_volume(effect, times, volume):

Pascal

procedure PlaySoundEffect(effect: SoundEffect; times: Integer; volume: Double)

---

Sound Effect Filename

Returns the filename of the Sound Effect that has been loaded by SplashKit

Parameters:

Name	Type	Description
effect	Sound Effect	The Sound Effect to check

Return Type: String

Signatures:

C++

string sound_effect_filename(sound_effect effect)

C#

public string SoundEffect.Filename { get }
public static string SplashKit.SoundEffectFilename(SoundEffect effect);

Python

def sound_effect_filename(effect):

Pascal

function SoundEffectFilename(effect: SoundEffect): String

---

Sound Effect Name

Returns the name of the Sound Effect that has been loaded by SplashKit

Parameters:

Name	Type	Description
effect	Sound Effect	The Sound Effect to check

Return Type: String

Signatures:

C++

string sound_effect_name(sound_effect effect)

C#

public string SoundEffect.Name { get }
public static string SplashKit.SoundEffectName(SoundEffect effect);

Python

def sound_effect_name(effect):

Pascal

function SoundEffectName(effect: SoundEffect): String

---

Sound Effect Named

Retrieves a Sound Effect that has been loaded into SplashKit. If the sound effect has not been loaded, this will attempt to use the name to locate the file for you. If a file can be found, the sound effect is loaded and returned.

Parameters:

Name	Type	Description
name	String	The name of the sound effect to return.

Return Type: Sound Effect

Usage:

See Implemenations in Guides

• Get Started with SplashKit Audio

Signatures:

C++

sound_effect sound_effect_named(const string &name)

C#

public static SoundEffect SplashKit.SoundEffectNamed(string name);

Python

def sound_effect_named(name):

Pascal

function SoundEffectNamed(const name: String): SoundEffect

---

Sound Effect Playing

Note

This function is overloaded. The following versions exist:

• Sound Effect Playing (name: string)
• Sound Effect Playing (effect: sound_effect)

Sound Effect Playing

Checks whether the Sound Effect that matches the name is currently playing

Parameters:

Name	Type	Description
name	String	The name of the Sound Effect

Return Type: Boolean

Signatures:

C++

bool sound_effect_playing(const string &name)

C#

public static bool SplashKit.SoundEffectPlaying(string name);

Python

def sound_effect_playing_named(name):

Pascal

function SoundEffectPlaying(const name: String): Boolean

---

Sound Effect Playing

Checks whether the Sound Effect is currently playing

Parameters:

Name	Type	Description
effect	Sound Effect	The Sound Effect to be tested.

Return Type: Boolean

Signatures:

C++

bool sound_effect_playing(sound_effect effect)

C#

public bool SoundEffect.IsPlaying { get }
public static bool SplashKit.SoundEffectPlaying(SoundEffect effect);

Python

def sound_effect_playing(effect):

Pascal

function SoundEffectPlaying(effect: SoundEffect): Boolean

---

Sound Effect Valid

Lets you test if a sound effect is valid. This will return true when it is a valid sound effect.

Parameters:

Name	Type	Description
effect	Sound Effect	the effect to test

Return Type: Boolean

Signatures:

C++

bool sound_effect_valid(sound_effect effect)

C#

public static bool SplashKit.SoundEffectValid(SoundEffect effect);

Python

def sound_effect_valid(effect):

Pascal

function SoundEffectValid(effect: SoundEffect): Boolean

---

Stop Sound Effect

Note

This function is overloaded. The following versions exist:

• Stop Sound Effect (name: string)
• Stop Sound Effect (effect: sound_effect)

Stop Sound Effect

Stops the Sound Effect that matches the name, if it is currently playing.

Parameters:

Name	Type	Description
name	String	The name of the Sound Effect to stop.

Signatures:

C++

void stop_sound_effect(const string &name)

C#

public static void SplashKit.StopSoundEffect(string name);

Python

def stop_sound_effect_named(name):

Pascal

procedure StopSoundEffect(const name: String)

---

Stop Sound Effect

Stops the Sound Effect if it is currently playing

Parameters:

Name	Type	Description
effect	Sound Effect	The Sound Effect to stop.

Signatures:

C++

void stop_sound_effect(sound_effect effect)

C#

public void SoundEffect.Stop();
public static void SplashKit.StopSoundEffect(SoundEffect effect);

Python

def stop_sound_effect(effect):

Pascal

procedure StopSoundEffect(effect: SoundEffect)

---

Types

Music

The Music type is used to refer to music that can be played by SplashKit. Music files are loaded with Load Music, played using Play Music, and must be released using Free Music.

Unlike Sound Effects, there can only be one music track playing at a time. Playing an new track will stop the currently playing music and switch to the new track.

---

Sound Effect

The Sound Effect type is used to refer to sound effects that can be played by the SplashKit audio code. Sound effects are:

• loaded with Load Sound Effect,

• played using Play Sound Effect,

• and must be released using delete_sound_effect (to release a specific sound effect) or delete_all_sound_effects (to release all loaded sound effects).

SplashKit will mix the audio from multiple sound effects, making it possible to play multiple Sound Effects, or even to play the one Sound Effect multiple times.

You can check if a Sound Effect is currently playing using Sound Effect Playing.

To stop a Sound Effect playing use Stop Sound Effect. This will stop all instances of this one sound effect from playing.

Use Music for background music for your games.

---