stopSound: Difference between revisions
Jump to navigation
Jump to search
m (Phergus moved page stopStream to stopSound: Function renamed.) |
No edit summary |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{stub|Needs examples and any info specific to streams/clips added.}} | |||
{{MacroFunction | {{MacroFunction | ||
|name= | |name=stopSound | ||
|version=1.5.5 | |version=1.5.5 | ||
|description= | |description= | ||
Stop an audio stream currently playing. | Stop an audio stream or clip currently playing. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
stopSound() | |||
stopSound(uri) | |||
stopSound(uri, remove) | |||
stopSound(uri, remove, fadeout) | |||
</ | </syntaxhighlight> | ||
'''Parameter''' | '''Parameter''' | ||
{{param|uri|The uri/url of the stream to stop. If set to "*", all audio | {{param|uri|The uri/url of the stream or clip to stop. If set to "*", all audio stream or clips 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 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 or clip. 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]] | ||
Latest revision as of 23:59, 14 March 2023
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
stopStreamto support both streams and clips.