getSoundProperties: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=getStreamProperties |version=1.5.5 |description= Get the properties of an audio stream currently loaded in memory. |usage= <source lang="mtmacro" line>...")
 
No edit summary
Line 13: Line 13:
'''Parameter'''
'''Parameter'''
{{param|uri|The uri/url of the stream to edit. If set to "*", a [[JSON Array]] containing the properties of all streams is returned. Defaults to "*".}}
{{param|uri|The uri/url of the stream to edit. If set to "*", a [[JSON Array]] containing the properties of all streams is returned. Defaults to "*".}}
Properties returned: uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime,  currentCount, status.


}}
}}
[[Category:Audio Function]]
[[Category:Audio Function]]

Revision as of 17:19, 11 September 2019

getStreamProperties() Function

Introduced in version 1.5.5
Get the properties of an audio stream currently loaded in memory.

Usage

getStreamProperties()
getStreamProperties(uri)

Parameter

  • uri - The uri/url of the stream to edit. If set to "*", a JSON Array containing the properties of all streams is returned. Defaults to "*".

Properties returned: uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status.