getSoundProperties

From RPTools Wiki
Revision as of 19:43, 14 March 2023 by Taustin (talk | contribs) (Text replacement - "source>" to "syntaxhighlight>")
Jump to navigation Jump to search

 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

<source lang="mtmacro" line> getSoundProperties() getSoundProperties(uri) </syntaxhighlight>

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.