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.
Label | Key | Type | Required? | Default | Description |
Playback ID |
| String | Yes | – | Unique ID for this audio playback instance |
Loop audio? |
| Boolean | No | – | If |
Number of loops |
| Number(integer) | No | – | Used together with Loop audio?, limit the number of times the audio is looped. |
Number of outputs: 2
Label | Key | Type | Description |
Audio playback instance |
| Object | Object representing the playback instance after it has started playing. |
|
| String | Unique ID for this audio playback |
|
| Number | Duration of the audio file, in milliseconds. |
|
| Number | Current time of the ongoing playback, in milliseconds. |
|
| String | Status of the current playback. |
|
| Boolean | True/false value describing if the audio file is set to loop. |
|
| Number | If looping, the number of remaining loops until the playback stops. |
|
| String|String | Absolute local filesystem path or external URL to the audio file being played |
|
| String | ISO 8601 timestamp for when the playback was started. Can be used to calculate e.g. elapsed time. |
No events.
Label | Code | Description |
Playback instance not found |
| Thrown if no audio playback instance with the given ID could be found. |
Unknown error |
| Thrown if an unknown error occurred while playing the audio file. |