stopSound: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
stopStream() | |||
stopStream(uri) | |||
stopStream(uri, remove) | |||
stopStream(uri, remove, fadeout) | |||
</source> | </source> | ||
'''Parameter''' | '''Parameter''' | ||
{{param|uri|The uri/url of the stream to stop. If set to "*", all audio streams are stopped.}} | {{param|uri|The uri/url of the stream to stop. If set to "*", all audio streams are stopped. Defaults to "*".}} | ||
{{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.}} | ||
Revision as of 19:22, 10 September 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 closing the stream. If set to 0, closes as soon as possible. Defaults to 0.