Preloads an audio file to memory, so that it can be played instantaneously.
After the file has been preloaded and is ready for instant playback, the first output is triggered. The given playback ID can then be used with the Play audio flow function to immediately play the audio file.
If a playback instance with the given ID already exists, any ongoing audio playback will be stopped and the new source file will be loaded into memory, creating a new audio playback instance under the given playback ID.
If there is an error, the second output is triggered.
External URL or local filesystem path to the audio file to preload.
Audio playback ID
Unique ID for the preloaded audio playback instance.
Number of outputs: 2
Audio playback instance
Object representing the playback instance after it was preloaded to memory.
Unique ID for this audio playback
Duration of the audio file, in milliseconds.
Current time of the ongoing playback, in milliseconds.
Status of the current playback.
True/false value describing if the audio file is set to loop.
If looping, the number of remaining loops until the playback stops.
Absolute local filesystem path or external URL to the audio file being played
ISO 8601 timestamp for when the playback was started. Can be used to calculate e.g. elapsed time.
File not found
Thrown if the audio source file could not be found.
File not an audio file
Thrown if the audio source file could not be opened as an audio file.
Thrown if an unknown error occurred while preloading the audio file.