defineAudioSource

From RPTools Wiki
Revision as of 16:57, 21 October 2019 by Phergus (talk | contribs) (Created page with "{{stub|Just a skeleton.} {{MacroFunction |name=defineAudioSource |version=1.5.7 |description= Description... |usage= <source lang="mtmacro" line> defineAudioSource(uri) defin...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

{{stub|Just a skeleton.}

defineAudioSource() Function

Introduced in version 1.5.7
Description...

Usage

defineAudioSource(uri)
defineAudioSource(uri, cycleCount)
defineAudioSource(uri, cycleCount, volume)
defineAudioSource(uri, cycleCount, volume, start)
defineAudioSource(uri, cycleCount, volume, start, stop)

Parameter

  • uri - The uri/url of the file. For example, http://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3
  • cycleCount - The number of times the audio should play. If set to 0, the file is cached but not played; if set to -1, the file is played continuously. Defaults to 1.
  • volume - The volume the audio is to be played at. Can range from 0 to 1. Defaults to 1.
  • start - The time offset in seconds where audio should start playing, or restart from when repeating. Defaults to 0.
  • stop - The time offset where audio should stop playing or restart when repeating. Defaults to the end of the audio.

Examples