stopSound: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 16: | Line 16: | ||
{{param|uri|The uri/url of the stream to stop. If set to "*", all audio streams are stopped. Defaults to "*".}} | {{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 | {{param|fadeout|Optional fadeout (in seconds) before stopping the stream. If set to 0, stop as soon as possible. Defaults to 0.}} | ||
}} | }} | ||
[[Category:Audio Function]] | [[Category:Audio Function]] |
Revision as of 19:24, 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 stopping the stream. If set to 0, stop as soon as possible. Defaults to 0.