pxt-calliope/docs/reference/music/stop-melody.md
Peli de Halleux 61c06ad969
stop melody block (#1633)
* docs

* updated strings
2018-12-02 07:56:47 -08:00

28 lines
506 B
Markdown

# Stop Melody
Stops playing a musical melody.
## Simulator
```sig
music.stopMelody(MelodyStopOptions.All)
```
## Parameters
* ``options`` specifies which melodies (foreground, background or both) need to be stopped
## Example
This example plays the ``Entertainer`` built-in melody.
```blocks
music.beginMelody(music.builtInMelody(Melodies.Entertainer), MelodyOptions.Forever)
basic.pause(5000)
music.stopMelody(MelodyStopOptions.All)
```
## See also
[start melody](/reference/music/begin-melody)