defineAudioSource

From RPTools Wiki
Jump to navigationJump to search

defineAudioSource() Function

Introduced in version 1.5.7
Assign a nickname to an audio source and optionally preload it or set playback values. The resulting nickname can be used instead of the URI in audio functions.

Usage

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

Parameter

  • nickname - The nickname of the file. For example, "tense music"
  • uri - The URI/URL of the file. For example, http://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3
  • preload - A string indicating if the audio should be pre-loaded or not. If set to "clip", preloads it as a clip. If set to "stream", preloads it as a stream. Any other string does not preload the audio source.
  • cycleCount - Set the default number of times the audio should play. If set to -1, the file is played continuously.
  • volume - Set the default volume the audio is to be played at. Can range from 0 to 1.
  • start - Set the default time offset in seconds where audio should start playing, or restart from when repeating. Streams only.
  • stop - Set the default time offset where audio should stop playing or restart when repeating. Streams only.

Examples

An example on how to define an audio source:
[defineAudioSource("no sorrow", "http://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3", "stream", -1, 0.5)]

The source can now be played as

[playStream("no sorrow")]
which will play the file continuously and at 50% volume.