playStream

From RPTools Wiki
Jump to navigationJump to search

playStream() Function

Introduced in version 1.5.5
Play an audio stream for the current player, from an online source or from a local file. Can be disabled in the sound preferences. Multiple files can be played at the same time. If attempting to play the same audio file twice, the previous streaming is stopped. Supports AIFF, MP3 and Wave formats.


Known Issues: Currently a bug in the underlying JavaFX code makes the cycle count unreliable. Audio clips will often play some number of times less than the requested count. This will be fixed when a new JavaFX version is incorporated.

Usage

playStream(uri)
playStream(uri, cycleCount)
playStream(uri, cycleCount, volume)
playStream(uri, cycleCount, volume, start)
playStream(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

To play a song from an online source to all clients, the GM can create the macro "playSong" on a Lib token, say, "Lib:MusicPlayer":
[playStream(macro.args)]

To play the song, the GM can then use execLink:

[H: songUrl = "http://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3"]
[H: audioByte = macroLinkText("playSong@Lib:MusicPlayer", "none", songUrl)]
[H: execLink(audioByte,0,"all")]

Alternatively, the GM can use execFunction:

[H: songUrl = json.append("[]","http://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3")]
[H: execFunction("playStream", songUrl, 0, "all")

Dropbox URLs

After creating the dropbox share link you have to replace www.dropbox.com with dl.dropboxusercontent.com. That provides a direct link that playStream can use. Thanks to Full Bleed on the forums for the tip.

Also note that dropbox no longer supports the "http" protocol, and only supports "https". If the "s" is omitted, the sound will not play.

Technical Info

The JavaFX docs provide more information about the supported media types. The MapTool macro functions only support the audio types.

[JavaFX Media Package]