Delete audio playback

Deletes an audio playback instance with the given ID.

Deletes an audio playback instance with the given ID.

After the instance has been deleted, the first output is triggered. Any ongoing playback is stopped, the audio file is removed from memory, and the playback ID is freed to be used for another playback instance.

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

Input arguments

Label

Key

Type

Required?

Default

Description

Audio playback ID

playbackId

String

Yes

ID of the audio playback instance to delete.

Output arguments

Number of outputs: 2

No output arguments.

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 deleting the playback instance.