Interface AudioOutput
access this type via: io.audio.AudioOutput (provides, requires or uses)
Audio output API. This interface allows you to play audio tracks, and mix tracks together. Note that the audio format of all data sources for tracks playing on a device must be the same as the audio format of the device itself.
Events
trackFinished(TrackInfo ti)
Functions
AudioOutput(optional storeFormat f)
bool play(Track source)
bool loop(Track source)
bool stop(Track source)
void stopAll()
Events
trackFinished Provides notifications of audio tracks reaching the end and stopping. Events are only delivered if the audio track has had its setFinishEvent() status set to true.
AudioOutput(optional storeFormat f)
Initialise audio output, using the system's default audio output device. Output will use the specified audio format, or will use a default format is none is specified.
bool play(Track source)
Plays an audio track on this output device and stops the track when it reaches the end. The track will be mixed together with any other tracks already playing on the device. Each audio track instance can only be played once on any device. If the given track is already playing, this function does nothing; if the track is playing in loop mode this function removes the loop mode from the track.
bool loop(Track source)
Plays an audio track on this output device and loops the track back to the beginning to play again when it reaches the end. The track will be mixed together with any other tracks already playing on the device. Each audio track instance can only be played once on any device; if it is already playing this function does nothing.
bool stop(Track source)
Stops playing of an audio track on this output device.
void stopAll()
Stops playing all audio tracks on this output device.