stopSound

From RPTools Wiki
Revision as of 23:36, 9 February 2023 by Conversion script (talk | contribs) (Conversion script moved page StopSound to stopSound: Converting page titles to lowercase)
Jump to navigation Jump to search

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
 This article needs: Needs examples and any info specific to streams/clips added.

stopSound() Function

Introduced in version 1.5.5
Stop an audio stream or clip currently playing.

Usage

stopSound()
stopSound(uri)
stopSound(uri, remove)
stopSound(uri, remove, fadeout)

Parameter

  • uri - The uri/url of the stream or clip to stop. If set to "*", all audio stream or clips are stopped. Defaults to "*".
  • remove - If set to 1, the audio file is removed from memory. Defaults to 1.
  • fadeout - Optional fadeout (in seconds) before stopping the stream or clip. If set to 0, stop as soon as possible. Defaults to 0.


Version Changes

  • 1.5.7 - Renamed from stopStream to support both streams and clips.