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) |
(Updated for 1.5.7) |
||
| 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= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getSoundProperties() | |||
getSoundProperties(uri) | |||
</source> | </source> | ||
'''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: uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status. | ||
|changes= | |||
* '''1.5.7''' - Renamed to support both audio streams and clips. | |||
}} | }} | ||
[[Category:Audio Function]] | [[Category:Audio Function]] | ||
Revision as of 16:51, 21 October 2019
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: uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status.
Version Changes
- 1.5.7 - Renamed to support both audio streams and clips.