Start/resume audio playback

Starts or resumes playback for an audio playback instance with the given ID.

Starts or resumes playback for an audio playback instance with the given ID.

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

This flow function always changes the state of the audio playback instance to ongoing, so paused playbacks will be resumed, stopped playbacks started and ongoing playbacks unaffected.

When the playback has started, the first output is triggered with a playback instance object.

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

Input arguments

Label

Key

Type

Required?

Default

Description

Playback ID

playbackId

String

Yes

Unique ID for this 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

Audio playback instance

playback

Object

Object representing the playback instance after it has started playing.

  • 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

Playback instance not found

playbackInstanceNotFound

Thrown if no audio playback instance with the given ID could be found.

Unknown error

unknown

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