Play audio

Plays an audio file from an external URL or the local filesystem.

Plays an audio file from an external URL or the local filesystem.

By default, the audio file will be played once, but you can set it to loop indefinitely or a certain number of times. You can use the Stop audio playback to stop a looping audio playback.

When the playback starts, the first output is triggered.

If there is an error, the second output is triggered.

Input arguments

Label

Key

Type

Required?

Default

Description

Audio source

source

String(local-filesystem-reference)|String(web-url)

Yes

External URL or absolute local filesystem path to the audio file to play.

Audio playback ID

playbackId

String

Yes

Unique ID for the preloaded audio playback instance.

Loop audio?

loop

Boolean

No

If true, loop the audio file. If Number of loops is not defined, the loop will continue until Stop audio playback is called.

Number of loops

numberOfLoops

Number(integer)

No

Used together with Loop audio?, limit the number of times the audio is looped.

Output arguments

Number of outputs: 2

Label

Key

Type

Description

Playback instance

playback

Object

Object representing the playback instance

  • Playback ID

playback.playbackId

String

Unique ID for this audio playback

  • Duration

playback.duration

Number

Duration of the audio file, in milliseconds.

  • Current time

playback.currentTime

Number

Current time of the ongoing playback, in milliseconds.

  • Status

playback.status

String

Status of the current playback.

  • Looping

playback.looping

Boolean

True/false value describing if the audio file is set to loop.

  • Remaining loops

playback.remainingLoops

Number

If looping, the number of remaining loops until the playback stops.

  • Source URL/path

playback.source

String|String

Absolute local filesystem path or external URL to the audio file being played

  • Current playback started at

playback.currentPlaybackStartedAt

String

ISO 8601 timestamp for when the playback was started. Can be used to calculate e.g. elapsed time.

Events

No events.

Errors

Label

Code

Description

File not found

fileNotFound

Thrown if the audio source file could not be found.

File not an audio file

fileNotAudioFile

Thrown if the audio source file could not be opened as an audio file.

Unknown error

unknown

Thrown if an unknown error occurred while playing the audio file.