Whether this output and all outputs in the chain support pause/resume.
Returns boolean
subscribed
get subscribed(): boolean
Returns boolean
Methods
captureFrame
captureFrame(frame): Promise<void>
Parameters
frame: AudioFrame
Returns Promise<void>
clearBuffer
clearBuffer(): void
Returns void
close
close(): Promise<void>
Returns Promise<void>
flush
flush(): void
Flush any buffered audio, marking the current playback/segment as complete
Returns void
onAttached
onAttached(): void
Returns void
onDetached
onDetached(): void
Returns void
onPlaybackFinished
onPlaybackFinished(options): void
Developers building audio sinks must call this method when a playback/segment is finished.
Segments are segmented by calls to flush() or clearBuffer()
Parameters
options: PlaybackFinishedEvent
Returns void
onPlaybackStarted
onPlaybackStarted(createdAt): void
Called when playback actually starts (first frame is sent to output).
Developers building audio sinks should call this when the first frame is captured.
Parameters
createdAt: number
Returns void
pause
pause(): void
Pause the audio playback
Returns void
resume
resume(): void
Resume the audio playback
Returns void
start
start(signal): Promise<void>
Parameters
signal: AbortSignal
Returns Promise<void>
waitForPlayout
waitForPlayout(): Promise<PlaybackFinishedEvent>
Wait for the past audio segments to finish playing out.
Returns Promise<PlaybackFinishedEvent>
The event that was emitted when the audio finished playing out (only the last segment information)
Whether this output and all outputs in the chain support pause/resume.