65 lines
3.2 KiB
Markdown
65 lines
3.2 KiB
Markdown
|
# start Melody
|
||
|
|
|
||
|
|
Start playing a musical melody through pin ``P0`` of the @boardname@.
|
||
|
|
|
||
|
|
```sig
|
||
|
|
music.startMelody(music.builtInMelody(Melodies.Entertainer), MelodyOptions.Once)
|
||
|
|
```
|
||
|
|
|
||
|
|
## ~ hint
|
||
|
|
|
||
|
|
**Simulator**: This function only works on the @boardname@ and in some browsers.
|
||
|
|
|
||
|
|
## ~
|
||
|
|
|
||
|
|
There are built-in melodies that you can choose from the ``||start melody||`` block. These are already composed for you and are easy to use by just selecting the one you want. If you want to play your own melody, you can [compose](/reference/music/making-melodies) one and use it instead of one of the built-in ones.
|
||
|
|
|
||
|
|
Melodies are a sequence of notes, each played for some small amount time, one after the other. The notes in a melody are held in an [array](/types/array) of [strings](/types/string). Each string in the array is a note of the melody. You make a melody by assembling the notes along with the _duration_ that the note plays for. The melody is [formed](/reference/music/making-melodies) like this:
|
||
|
|
|
||
|
|
``NOTE[octave][:duration] eg: ['g5:1']``
|
||
|
|
|
||
|
|
```block
|
||
|
|
music.startMelody(['g4:1', 'c5', 'e', 'g:2', 'e:1', 'g:3'], MelodyOptions.Once)
|
||
|
|
```
|
||
|
|
|
||
|
|
Melodies are played either in the _foreground_ or _background_. This allows more than one melody to be active at once. If a melody is set to play in the background, it can be interrupeted, or paused, temporarily while a melody set for the foreground is played. If the foreground melody is not set to play ``forever``, then the background melody resumes when the foreground melody is finished.
|
||
|
|
|
||
|
|
You can set options for how you want the melody to play. You can ask that the melody plays just one time, ``once``, or have it keep repeating, ``forever``. With these options the melody will play in the foreground either once or continue to repeat. Of course, if you set ``forever``, any melody that was started in background will never play unless you [stop](/reference/music/stop-melody) the foreground melody. To make a background melody, set the option to ``once in background`` or ``forever in background``.
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
* **melody**: A built-in melody or an [array](/types/array) representation of a [melody](reference/music/making-melodies) you wish to play.
|
||
|
|
* **options**: the play option for the melody:
|
||
|
|
>* ``once``: play the melody in the foreground one time
|
||
|
|
>* ``forever``: play the melody in the foreground and keep repeating it
|
||
|
|
>* ``once in background``: play the melody in the background one time
|
||
|
|
>* ``forever in background``: play the melody in the background and keep repeating it
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
### Play the "Entertainer"
|
||
|
|
|
||
|
|
This example plays the ``Entertainer`` built-in melody.
|
||
|
|
|
||
|
|
```blocks
|
||
|
|
music.startMelody(music.builtInMelody(Melodies.Entertainer), MelodyOptions.Once)
|
||
|
|
```
|
||
|
|
|
||
|
|
### Play a composed melody forever
|
||
|
|
|
||
|
|
Play a made-up melody in the background forever.
|
||
|
|
|
||
|
|
```blocks
|
||
|
|
music.startMelody(['g4:1', 'c5', 'e', 'g:2', 'e:1', 'g:3'], MelodyOptions.ForeverInBackground)
|
||
|
|
```
|
||
|
|
|
||
|
|
## See also
|
||
|
|
|
||
|
|
[stop melody](/reference/music/stop-melody), [play tone](/reference/music/play-tone),
|
||
|
|
[rest](/reference/music/rest), [ring tone](/reference/music/ring-tone),
|
||
|
|
[tempo](/reference/music/tempo), [set tempo](/reference/music/set-tempo),
|
||
|
|
[change tempo by](/reference/music/change-tempo-by)
|
||
|
|
|
||
|
|
[Making Melodies](/reference/music/making-melodies)
|
||
|
|
|