pxt-calliope/docs/reference/music/play-until-done.md
Juri Wolf 5f7a8e5301
Updates for V4 (#197)
* update yotta defaults for 16kb devices

* refactor deprecated blocks

* updates for button events

* update button events

* update refference

* update docs

* update docs

* update button event blocks

* update docs

* update block id
2022-08-10 09:36:19 -07:00

1.2 KiB

play Until Done

Play a sound expression until it finishes.

soundExpression.giggle.playUntilDone()

A sound expression is a preformatted set of tones that create a certain sound. There are several sounds to choose from. The sound is started and your program waits until the sound stops playing.

~ reminder

works with micro:bit V2 only image

This block requires the micro:bit V2 hardware. If you use this block with a micro:bit v1 board, you will see the 927 error code on the screen.

~

Parameters

In blocks, the sound is selected from the list in the ||music:play sound until done|| block.

soundExpression.giggle.playUntilDone()

When coding in JavaScript or Python, the sound is a soundExpression object which from which you run the playUntilDone() function from. For example, to play the soaring sound, select soaring from the soundExpression namespace and run playUntilDone():

soundExpression.soaring.playUntilDone()

Example

Play the twinkle sound on the speaker and wait until it finishes.

soundExpression.twinkle.playUntilDone()
basic.showString("twinkle has stopped")

See also

play