Class ParticipantAudioOutput

Hierarchy

  • AudioOutput
    • ParticipantAudioOutput

Constructors

constructor

Properties

sampleRate? EVENT_PLAYBACK_FINISHED

Accessors

canPause subscribed

Methods

captureFrame clearBuffer close flush onAttached onDetached onPlaybackFinished pause resume start waitForPlayout

Constructors

constructor

Properties

Optional sampleRate

sampleRate?: number

Static Readonly EVENT_PLAYBACK_FINISHED

EVENT_PLAYBACK_FINISHED: "playbackFinished" = 'playbackFinished'

Accessors

canPause

  • get canPause(): boolean

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

    Returns boolean

subscribed

Methods

captureFrame

  • captureFrame(frame): Promise<void>

  • Parameters

    • frame: AudioFrame

    Returns Promise<void>

clearBuffer

close

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

pause

  • pause(): void

  • Pause the audio playback

    Returns void

resume

  • resume(): void

  • Resume the audio playback

    Returns void

start

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)

Settings

Member Visibility

Theme

On This Page

constructorsampleRateEVENT_PLAYBACK_FINISHEDcanPausesubscribedcaptureFrameclearBuffercloseflushonAttachedonDetachedonPlaybackFinishedpauseresumestartwaitForPlayout