Sounds and music Reference

GDevelop provides several conditions and actions to play audio files. They can be either long music or short sound effects. Read more explanations about it.

Actions

Fade the volume of a music played on a channel.
Fade the volume of a music played on a channel to the specified volume within the specified duration.

See parameters

Parameter 1 (🔢 Number): Channel identifier
Parameter 2 (🔢 Number): Final volume (0-100)
Parameter 3 (🔢 Number): Fading time in seconds

Fade the volume of a sound played on a channel.
Fade the volume of a sound played on a channel to the specified volume within the specified duration.

See parameters

Parameter 1 (🔢 Number): Channel identifier
Parameter 2 (🔢 Number): Final volume (0-100)
Parameter 3 (🔢 Number): Fading time in seconds

Game global volume
This action modifies the global volume of the game.

See parameters

Parameter 1: 🟰 Operator
Parameter 2 (🔢 Number): Volume (0-100)

Pitch of the music on a channel
This action modifies the pitch of the music on the specified channel.

See parameters

Parameter 1 (🔢 Number): Channel identifier
Parameter 2: 🟰 Operator
Parameter 3 (🔢 Number): Pitch (1 by default)

Pitch of the sound of a channel
This action modifies the pitch (speed) of the sound on a channel.

See parameters

Parameter 1 (🔢 Number): Channel identifier
Parameter 2: 🟰 Operator
Parameter 3 (🔢 Number): Pitch (1 by default)

Playing offset of the music on a channel
This action modifies the playing offset of the music on the specified channel

See parameters

Parameter 1 (🔢 Number): Channel identifier
Parameter 2: 🟰 Operator
Parameter 3 (🔢 Number): Position (in seconds)

Playing offset of the sound on a channel
This action modifies the playing offset of the sound on a channel

See parameters

Parameter 1 (🔢 Number): Channel identifier
Parameter 2: 🟰 Operator
Parameter 3 (🔢 Number): Position (in seconds)

Volume of the music on a channel
This action modifies the volume of the music on the specified channel.

See parameters

Parameter 1 (🔢 Number): Channel identifier
Parameter 2: 🟰 Operator
Parameter 3 (🔢 Number): Volume (0-100)

Volume of the sound on a channel
This action modifies the volume of the sound on the specified channel.

See parameters

Parameter 1 (🔢 Number): Channel identifier
Parameter 2: 🟰 Operator
Parameter 3 (🔢 Number): Volume (0-100)

Pause the music of a channel
Pause the music on the specified channel.

See parameters

Parameter 1 (🔢 Number): Channel identifier

Pause the sound of a channel
Pause the sound played on the specified channel.

See parameters

Parameter 1 (🔢 Number): Channel identifier

Play a music file
Play a music file.

See parameters

Parameter 1 (musicfile): Audio file (or audio resource name)
Parameter 2 (❓ Yes or No): Repeat the sound
Parameter 3 (🔢 Number): Volume From 0 to 100, 100 by default.
Parameter 4 (🔢 Number): Pitch (speed) 1 by default.

Play a music file on a channel
Play a music file on a specific channel,
so you'll be able to interact with it later.

See parameters

Parameter 1 (musicfile): Audio file (or audio resource name)
Parameter 2 (🔢 Number): Channel identifier
Parameter 3 (❓ Yes or No): Repeat the sound
Parameter 4 (🔢 Number): Volume From 0 to 100, 100 by default.
Parameter 5 (🔢 Number): Pitch (speed) 1 by default.

Play a sound
Play a sound.

See parameters

Parameter 1 (soundfile): Audio file (or audio resource name)
Parameter 2 (❓ Yes or No): Repeat the sound
Parameter 3 (🔢 Number): Volume From 0 to 100, 100 by default.
Parameter 4 (🔢 Number): Pitch (speed) 1 by default.

Play a sound on a channel
Play a sound (small audio file) on a specific channel,
so you'll be able to manipulate it.

See parameters

Parameter 1 (soundfile): Audio file (or audio resource name)
Parameter 2 (🔢 Number): Channel identifier
Parameter 3 (❓ Yes or No): Repeat the sound
Parameter 4 (🔢 Number): Volume From 0 to 100, 100 by default.
Parameter 5 (🔢 Number): Pitch (speed) 1 by default.

Preload a music file
Preload a music file in memory.

See parameters

Parameter 1 (musicfile): Audio file (or audio resource name)

Preload a sound file
Preload a sound file in memory.

See parameters

Parameter 1 (soundfile): Sound file (or sound resource name)

Resume playing a music on a channel
Resume playing a music on a channel that was paused.

See parameters

Parameter 1 (🔢 Number): Channel identifier

Resume playing a sound on a channel
Resume playing a sound on a channel that was paused.

See parameters

Parameter 1 (🔢 Number): Channel identifier

Stop the music on a channel
Stop the music on the specified channel

See parameters

Parameter 1 (🔢 Number): Channel identifier

Stop the sound of a channel
Stop the sound on the specified channel.

See parameters

Parameter 1 (🔢 Number): Channel identifier

Unload all audio
Unload all the audio in memory. This will cause every sound and music of the game to stop.

See parameters

Unload a music file
Unload a music file from memory. Unloading a music file will cause any music playing it to stop.

See parameters

Parameter 1 (musicfile): Audio file (or audio resource name)

Unload a sound file
Unload a sound file from memory. Unloading a sound file will cause any sounds playing it to stop.

See parameters

Parameter 1 (soundfile): Sound file (or sound resource name)

Conditions

Global volume
Test the global sound level. The volume is between 0 and 100.

See parameters

Parameter 1: 🟰 Relational operator
Parameter 2 (🔢 Number): Volume to compare to (0-100)

Volume of the music on a channel
Test the volume of the music on a specified channel. The volume is between 0 and 100.

See parameters

Parameter 1 (🔢 Number): Channel identifier
Parameter 2: 🟰 Relational operator
Parameter 3 (🔢 Number): Volume to compare to (0-100)

Pitch of the music on a channel
Test the pitch (speed) of the music on a specified channel.

See parameters

Parameter 1 (🔢 Number): Channel identifier
Parameter 2: 🟰 Relational operator
Parameter 3 (🔢 Number): Pitch to compare to (1 by default)

Playing offset of the music on a channel
Test the playing offset of the music on the specified channel.

See parameters

Parameter 1 (🔢 Number): Channel identifier
Parameter 2: 🟰 Relational operator
Parameter 3 (🔢 Number): Position to compare to (in seconds)

A music file is paused
Test if the music on the specified channel is paused.

See parameters

Parameter 1 (🔢 Number): Channel

A music file is being played
Test if the music on a channel is being played

See parameters

Parameter 1 (🔢 Number): Channel

A music file is stopped
Test if the music on the specified channel is stopped.

See parameters

Parameter 1 (🔢 Number): Channel

Volume of the sound on a channel
Test the volume of the sound on the specified channel.

See parameters

Parameter 1 (🔢 Number): Channel identifier
Parameter 2: 🟰 Relational operator
Parameter 3 (🔢 Number): Volume to compare to (0-100)

Pitch of the sound of a channel
Test the pitch of the sound on the specified channel. 1 is the default pitch.

See parameters

Parameter 1 (🔢 Number): Channel identifier
Parameter 2: 🟰 Relational operator
Parameter 3 (🔢 Number): Pitch to compare to (1 by default)

Playing offset of the sound on a channel
Test the playing offset of the sound on the specified channel.

See parameters

Parameter 1 (🔢 Number): Channel identifier
Parameter 2: 🟰 Relational operator
Parameter 3 (🔢 Number): Position to compare to (in seconds)

A sound is paused
Test if the sound on the specified channel is paused.

See parameters

Parameter 1 (🔢 Number): Channel

A sound is being played
Test if the sound on a channel is being played.

See parameters

Parameter 1 (🔢 Number): Channel

A sound is stopped
Test if the sound on the specified channel is stopped.

See parameters

Parameter 1 (🔢 Number): Channel

Expressions

Expression	Description
`GlobalVolume()`	Global volume value
`MusicChannelPitch(number)`	Music's pitch
	🔢 Number	Channel
`MusicChannelPlayingOffset(number)`	Music playing offset
	🔢 Number	Channel
`MusicChannelVolume(number)`	Music volume
	🔢 Number	Channel
`SoundChannelPitch(number)`	Sound's pitch
	🔢 Number	Channel
`SoundChannelPlayingOffset(number)`	Sound playing offset
	🔢 Number	Channel
`SoundChannelVolume(number)`	Sound volume
	🔢 Number	Channel

The Sounds and music extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager.

This page is an auto-generated reference page about the Sounds and music feature of GDevelop, the open-source, cross-platform game engine designed for everyone. Learn more about all GDevelop features here.