Interface AvatarPublisherOptions

What an AvatarPublisher works with.

interface AvatarPublisherOptions {
    Decoders?: AvatarDecoderFactory;
    LeadMs?: number;
    Now?: () => number;
    OnStatus: (status: NativeAvatarStatus) => void;
    Probe?: () => Promise<FfmpegProbeResult>;
    SampleRate: number;
    Video: AvatarVideoOutlet;
    Voice: AvatarVoiceQueue;
}

Index

Properties

Decoders? LeadMs? Now? OnStatus Probe? SampleRate Video Voice

Properties

`Optional`Decoders

Decoders?: AvatarDecoderFactory

Creates the decoders. Default FfmpegAvatarDecoders.

`Optional`LeadMs

LeadMs?: number

How much earlier than its audio a frame is shown (ms). Default 0.

`Optional`Now

Now?: () => number

Monotonic clock (ms). Default performance.now().

OnStatus

OnStatus: (status: NativeAvatarStatus) => void

Receives each change in what the room is shown.

`Optional`Probe

Probe?: () => Promise<FfmpegProbeResult>

Finds ffmpeg. Default: this thread's FfmpegLocator.

SampleRate

SampleRate: number

The voice track's rate (Hz): the voice decoder's output rate.

Video

Video: AvatarVideoOutlet

The room side of the video.

Voice

Voice: AvatarVoiceQueue

The bot's voice queue.