pxt-calliope/docs/reference/music/builtin-sound-effect.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

897 B

builtin Sound Effect

Get a sound expression string for a built-in sound effect.

music.builtinSoundEffect(soundExpression.giggle)

A collection of built-in sound effects are available as sound expressions. You choose one by selecting the name of the effect

Parameters

  • soundExpression: A sound expression name. The available effects are:
  • giggle
  • happy
  • hello
  • mysterious
  • sad
  • slide
  • soaring
  • spring
  • twinkle
  • yawn

Returns

  • a sound expression string with the the named sound effect.

Example

Play the built-in sound effect for giggle.

music.playSoundEffect(music.builtinSoundEffect(soundExpression.giggle), SoundExpressionPlayMode.UntilDone)

See also

play sound effect, create sound effect