getSoundProperties: Difference between revisions
Jump to navigation
Jump to search
(Updated for 1.5.7) |
No edit summary |
||
| Line 15: | Line 15: | ||
{{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: uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status. | Properties returned for stream: nicknames, uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status. | ||
Properties returned for clip: nicknames, uri, cycleCount, volume. | |||
|changes= | |changes= | ||
Revision as of 13:12, 23 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 for stream: nicknames, uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status.
Properties returned for clip: nicknames, uri, cycleCount, volume.
Version Changes
- 1.5.7 - Renamed to support both audio streams and clips.