pxt-ev3/libs/music/docs/reference/music/play-sound-effect.md
Galen Nickel 60ec3f1c99 Add 'playSound' api docs (#340)
* Add 'playSound' api docs

* Linkup summary
2018-02-22 16:23:07 -08:00

1.0 KiB

play Sound Effect

Play a sound from one of the built-in sound effects.

music.playSoundEffect(null)

There are several sound effects you can play. Use the sounds list in the block to pick the sound you want to play. When the sounds starts, your program continues on and doesn't wait for the sound to finish. This lets your program do other things while your sound plays in the background.

Many of the built-in sound effects make sounds match to the actions that your @boardname@ is doing. For example, you can add the mechanical motor start sound to your program to indicate that your motors are running.

Parameters

  • sound: a built-in sound effect from the list of available sounds.

Example

Drive the brick backwards and play a backup alert sound.

music.playSoundEffect(sounds.mechanicalBackingAlert);
motors.largeBC.tank(-50, -50, 15, MoveUnit.Rotations);
music.stopAllSounds();

See also

play sound effect until done, stop all sounds