getSoundProperties: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getSoundProperties() | getSoundProperties() | ||
getSoundProperties(uri) | getSoundProperties(uri) | ||
</ | </syntaxhighlight> | ||
'''Parameter''' | '''Parameter''' | ||
{{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 "*".}} | {{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 for | Properties returned for streams: nicknames, uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status. | ||
Properties returned for | Properties returned for clips: nicknames, uri, cycleCount, volume. | ||
|changes= | |changes= | ||
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.