Class ParticipantAudioOutput

Optional sampleRate

Static Readonly EVENT_PLAYBACK_FINISHED

Static Readonly EVENT_PLAYBACK_STARTED

canPause

• get canPause(): boolean

• Whether this output and all outputs in the chain support pause/resume.

  Returns boolean

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

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)