Class DataStreamAudioOutput

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

Hierarchy (view full)

AudioOutput
- DataStreamAudioOutput

Constructors

constructor

new DataStreamAudioOutput(opts): DataStreamAudioOutput
Parameters
- opts: DataStreamAudioOutputOptions
Returns DataStreamAudioOutput
Overrides AudioOutput.constructor
- Defined in agents/src/voice/avatar/datastream_io.ts:65

Properties

`Optional` sampleRate

sampleRate?: number

`Static` `Readonly` EVENT_PLAYBACK_FINISHED

EVENT_PLAYBACK_FINISHED: "playbackFinished" = 'playbackFinished'

`Static` `Readonly` EVENT_PLAYBACK_STARTED

EVENT_PLAYBACK_STARTED: "playbackStarted" = 'playbackStarted'

`Static` _playbackFinishedHandlers

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

Type declaration

- (data): string
- Parameters
  - data: RpcInvocationData
  Returns string

`Static` _playbackFinishedRpcRegistered

_playbackFinishedRpcRegistered: boolean = false

`Static` _playbackStartedHandlers

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

Type declaration

- (data): string
- Parameters
  - data: RpcInvocationData
  Returns string

`Static` _playbackStartedRpcRegistered

_playbackStartedRpcRegistered: boolean = false

Accessors

canPause

get canPause(): boolean
Whether this output and all outputs in the chain support pause/resume.

Returns boolean
Inherited from AudioOutput.canPause
- Defined in agents/src/voice/io.ts:141

Methods

captureFrame

captureFrame(frame): Promise<void>
Capture an audio frame for playback, frames can be pushed faster than real-time
Parameters
- frame: AudioFrame
Returns Promise<void>
Overrides AudioOutput.captureFrame
- Defined in agents/src/voice/avatar/datastream_io.ts:162

clearBuffer

clearBuffer(): void
Clear the buffer, stopping playback immediately

Returns void
Overrides AudioOutput.clearBuffer
- Defined in agents/src/voice/avatar/datastream_io.ts:211

flush

flush(): void
Returns void
Overrides AudioOutput.flush
- Defined in agents/src/voice/avatar/datastream_io.ts:197

onAttached

onAttached(): void
Returns void
Inherited from AudioOutput.onAttached
- Defined in agents/src/voice/io.ts:204

onDetached

onDetached(): void
Returns void
Inherited from AudioOutput.onDetached
- Defined in agents/src/voice/io.ts:210

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
Inherited from AudioOutput.onPlaybackFinished
- Defined in agents/src/voice/io.ts:183

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
Inherited from AudioOutput.onPlaybackStarted
- Defined in agents/src/voice/io.ts:175

pause

pause(): void
Pause the audio playback

Returns void
Inherited from AudioOutput.pause
- Defined in agents/src/voice/io.ts:219

resume

resume(): void
Resume the audio playback

Returns void
Inherited from AudioOutput.resume
- Defined in agents/src/voice/io.ts:228

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)
Inherited from AudioOutput.waitForPlayout
- Defined in agents/src/voice/io.ts:160

`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
- Defined in agents/src/voice/avatar/datastream_io.ts:245

`Static` registerPlaybackStartedRpc

registerPlaybackStartedRpc(__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
- Defined in agents/src/voice/avatar/datastream_io.ts:296

Class DataStreamAudioOutput

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DataStreamAudioOutput

Properties

Optional sampleRate

Static Readonly EVENT_PLAYBACK_FINISHED

Static Readonly EVENT_PLAYBACK_STARTED

Static _playbackFinishedHandlers

Type declaration

Parameters

Returns string

Static _playbackFinishedRpcRegistered

Static _playbackStartedHandlers

Type declaration

Parameters

Returns string

Static _playbackStartedRpcRegistered

Accessors

canPause

Returns boolean

Methods

captureFrame

Parameters

Returns Promise<void>

clearBuffer

Returns void

flush

Returns void

onAttached

Returns void

onDetached

Returns void

onPlaybackFinished

Parameters

Returns void

onPlaybackStarted

Parameters

Returns void

pause

Returns void

resume

Returns void

waitForPlayout

Returns Promise<PlaybackFinishedEvent>

Static registerPlaybackFinishedRpc

Parameters

callerIdentity: string

handler: ((data) => string)

Parameters

Returns string

room: Room

Returns void

Static registerPlaybackStartedRpc

Parameters

callerIdentity: string

handler: ((data) => string)

Parameters

Returns string

room: Room

Returns void

Settings

Member Visibility

Theme

On This Page

`Optional` sampleRate

`Static` `Readonly` EVENT_PLAYBACK_FINISHED

`Static` `Readonly` EVENT_PLAYBACK_STARTED

`Static` _playbackFinishedHandlers

`Static` _playbackFinishedRpcRegistered

`Static` _playbackStartedHandlers

`Static` _playbackStartedRpcRegistered

`Static` registerPlaybackFinishedRpc

`Static` registerPlaybackStartedRpc