Roaudioplayermx – BrightSign Object Reference Manual (FW 5.1) User Manual
Page 57
49
roAudioPlayerMx
This object allows you to mix audio files, as well as HLS audio streams. Each
roAudioPlayerMx object conatins two
internal audio players: The main audio playlist consists of queued audio tracks that play sequentially, while the audio
overlay plays files on top of the main playlist. A fade will not occur if it is called while an overlay is playing, but the next
audio track will start playing as expected.
Tracks are queued to
PlayFile with their fade parameters specified in an
. These are the parameters
you can pass to
PlayFile:
•
Filename: The filename of the track
•
FrontPorch: The length, in milliseconds (ms), to skip from the start of the track. This value is 0 by default.
•
FadeOutLocation: The location, in milliseconds (ms), of the fade out relative to the value of the FrontPorch. If the
value is 0 (which is the default setting), and the
FadeOutLength has a non-zero value, then the fade out is
calculated back from the end of the file.
•
FadeOutLength: The length of the fade out in milliseconds (ms). This value is 0 by default.
•
SegueLocation: The location, in milliseconds (ms), of the event that triggers the next audio file to play. This
location is relative to the first audio file that is played. If the
SegueLocation parameter is not passed to
PlayFile,
the value defaults to the
FadeOutLocation.
•
BackPorchLocation: The location, in milliseconds (ms), of the termination point for the audio track. This location is
relative to the first audio file that is played. If the
BackPorchLocation parameter is not passed to
PlayFile, the
audio file plays to the end. The value is 0 by default, which disables the back porch.
•
TrackVolume: The relative volume of of the audio track, measured as a percentage. Specify the percentage using
values between 0 and 100.
•
EventID: The ID for an audio event
•
EventTimeStamp: The timestamp for the audio event. There can only be one event per audio file.
•
QueueNext: The queuing of an audio track. Set the parameter value to 1 to queue an audio file to play after the
current track.