Class DataStreamAudioOutput

AudioOutput implementation that streams audio to a remote avatar worker using LiveKit DataStream.

Hierarchy

  • AudioOutput
    • DataStreamAudioOutput

Constructors

constructor

Properties

sampleRate? EVENT_PLAYBACK_FINISHED _playbackFinishedHandlers _playbackFinishedRpcRegistered

Methods

captureFrame clearBuffer flush onAttached onDetached onPlaybackFinished waitForPlayout registerPlaybackFinishedRpc

Constructors

constructor

Properties

Optional sampleRate

sampleRate?: number

Static Readonly EVENT_PLAYBACK_FINISHED

EVENT_PLAYBACK_FINISHED: "playbackFinished" = 'playbackFinished'

Static _playbackFinishedHandlers

_playbackFinishedHandlers: Record<string, ((data) => string)> = {}

Type declaration

    • (data): string

    • Parameters

      • data: RpcInvocationData

      Returns string

Static _playbackFinishedRpcRegistered

_playbackFinishedRpcRegistered: boolean = false

Methods

captureFrame

clearBuffer

flush

onAttached

onDetached

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

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)

Static registerPlaybackFinishedRpc

  • registerPlaybackFinishedRpc(__namedParameters): void

  • Parameters

    • __namedParameters: {
          callerIdentity: string;
          handler: ((data) => string);
          room: Room;
      }
      • callerIdentity: string
      • handler: ((data) => string)
          • (data): string

          • Parameters

            • data: RpcInvocationData

            Returns string

      • room: Room

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorsampleRateEVENT_PLAYBACK_FINISHED_playbackFinishedHandlers_playbackFinishedRpcRegisteredcaptureFrameclearBufferflushonAttachedonDetachedonPlaybackFinishedwaitForPlayoutregisterPlaybackFinishedRpc