Seek audio playback to

Seeks an ongoing audio playback with the given ID to a new time.

Seeks an ongoing audio playback with the given ID to a new time.
Will not stop an ongoing playback.
Seeking a stopped playback to a time greater than 0 will cause the status to change to paused.
Seeking a paused playback to 0 time will cause the status to change to stopped.
If a negative number or a number higher than the duration of the audio file is given, the playback is set to the beginning or end of the file, respectively.
Input arguments
Label
Key
Type
Required?
Default
Description
Audio playback ID
playbackId
String
Yes
–
ID of the audio playback to stop.
Seek to
seekTo
Number(integer)
Yes
–
Time to seek to, in seconds from the beginning of the audio file.
Output arguments
Number of outputs: 2
Label
Key
Type
Description
Playback instance
playback
Object
Object representing the playback instance after it has been sought to the new time.
Playback ID
playback.playbackId
String
Unique ID for this audio playback
Duration
playback.duration
Number
Duration of the audio file, in seconds.
Current time
playback.currentTime
Number
Current time of the ongoing playback, in seconds.
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 seeking the audio file to a new position.

Preload audio for playback

Start recording audio

Last updated 5 months ago

Label	Key	Type	Required?	Default	Description
Audio playback ID	`playbackId`	String	Yes	–	ID of the audio playback to stop.
Seek to	`seekTo`	Number(integer)	Yes	–	Time to seek to, in seconds from the beginning of the audio file.

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 seeking the audio file to a new position.