getSoundProperties: Difference between revisions
Jump to navigation
Jump to search
m (Phergus moved page getStreamProperties to getSoundProperties: Function renamed for support of both streams and clips) |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (7 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{stub|Needs examples of function use and output}} | |||
{{MacroFunction | {{MacroFunction | ||
|name= | |name=getSoundProperties | ||
|version=1.5.5 | |version=1.5.5 | ||
|description= | |description= | ||
Get the properties of an audio | Get the properties of an audio source currently loaded in memory. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getSoundProperties() | |||
getSoundProperties(uri) | |||
</ | </syntaxhighlight> | ||
'''Parameter''' | '''Parameter''' | ||
{{param|uri|The uri/url of the | {{param|uri|The uri/url of the audio source to edit. If set to "*", a [[JSON Array]] containing the properties of all audio sources is returned. Defaults to "*".}} | ||
Properties returned: uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status. | Properties returned for streams: nicknames, uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status. | ||
Properties returned for clips: nicknames, uri, cycleCount, volume. | |||
|changes= | |||
* '''1.5.7''' - Renamed to support both audio 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 of function use and output
getSoundProperties() Function
• Introduced in version 1.5.5
Get the properties of an audio source currently loaded in memory.
Usage
getSoundProperties()
getSoundProperties(uri)Parameter
uri- The uri/url of the audio source to edit. If set to "*", a JSON Array containing the properties of all audio sources is returned. Defaults to "*".
Properties returned for streams: nicknames, uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status.
Properties returned for clips: nicknames, uri, cycleCount, volume.
Version Changes
- 1.5.7 - Renamed to support both audio streams and clips.