stopSound: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Phergus moved page stopStream to stopSound: Function renamed.)
No edit summary
Line 18: Line 18:
{{param|fadeout|Optional fadeout (in seconds) before stopping the stream. If set to 0, stop as soon as possible. Defaults to 0.}}
{{param|fadeout|Optional fadeout (in seconds) before stopping the stream. If set to 0, stop as soon as possible. Defaults to 0.}}


|changes=
* '''1.5.7''' - Renamed from {{code|stopStream}} to support both streams and clips.
}}
}}
[[Category:Audio Function]]
[[Category:Audio Function]]

Revision as of 16:47, 21 October 2019

stopStream() Function

Introduced in version 1.5.5
Stop an audio stream currently playing.

Usage

stopStream()
stopStream(uri)
stopStream(uri, remove)
stopStream(uri, remove, fadeout)

Parameter

  • uri - The uri/url of the stream to stop. If set to "*", all audio streams 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. 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.