Member Junction
    Preparing search index...

    Settings of LiveKitRtcNodeRoomClient beyond its audio rates.

    interface LiveKitRtcNodeRoomClientOptions {
        Avatar?: Pick<
            AvatarPublisherOptions,
            "Probe"
            | "Decoders"
            | "Now"
            | "LeadMs",
        >;
        AvatarStatus?: NativeAvatarStatus;
        Now?: () => number;
        Timer?: RoomVideoWatcherTimer;
        Video?: NativeRoomVideoOptions;
        VideoEncoder?: IRoomVideoFrameEncoder;
    }
    Index

    Properties

    Avatar?: Pick<AvatarPublisherOptions, "Probe" | "Decoders" | "Now" | "LeadMs">

    How the avatar finds ffmpeg and creates its decoders (tests pass fakes). Default: the real ones.

    AvatarStatus?: NativeAvatarStatus

    Where the agent's avatar stands when the client joins: a media worker rejoining after the avatar was taken down passes audio-only, so the bot re-applies its attribute and publishes no avatar. Absent: a fresh join.

    Now?: () => number

    Monotonic millisecond clock for video pacing, the speaker hold, the encode round trip and the in-process encoder's timing (tests inject one). Default performance.now().

    Schedules the ranking a delayed switch of video source needs, on the Now clock (tests inject one). Default: an unref'd setTimeout.

    What to read for the agent when it watches the meeting (from NativeRoomClientOptions.Video). Absent: the client reads no video. Either way, video the bot does not read is unsubscribed.

    VideoEncoder?: IRoomVideoFrameEncoder

    Where participant video is encoded. Default: in-process, on the thread that hosts the room. The module factory passes this thread's VideoEncodeWorkerHost unless the encode worker is turned off.