stopSound: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=stopStream |version=1.5.5 |description= Stop an audio stream currently playing. |usage= <source lang="mtmacro" line> editStream(uri) editStream(uri, rem...")
 
No edit summary
Line 16: Line 16:
{{param|remove|If set to 1, the audio file is removed from memory. Defaults to 1.}}
{{param|remove|If set to 1, the audio file is removed from memory. Defaults to 1.}}
{{param|fadeout|Optional fadeout (in seconds) before closing the stream. If set to 0, closes as soon as possible. Defaults to 0.}}
{{param|fadeout|Optional fadeout (in seconds) before closing the stream. If set to 0, closes as soon as possible. Defaults to 0.}}
}}


}}
}}
[[Category:Audio Function]]
[[Category:Audio Function]]

Revision as of 19:13, 10 September 2019

stopStream() Function

Introduced in version 1.5.5
Stop an audio stream currently playing.

Usage

editStream(uri)
editStream(uri, remove)
editStream(uri, remove, fadeout)

Parameter

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