Member Junction
    Preparing search index...

    Interface RoomVideoTelemetry

    Participant-video telemetry: what the bot read from people's cameras and screens, and what it cost. Present while the bot watches the meeting (the client was created with video options).

    interface RoomVideoTelemetry {
        activeSpeakerUpdates?: number;
        bytesSent: number;
        encodeDispatchMsMax?: number;
        encodeFailures?: number;
        encodeInFlight?: number;
        encodeMsLast?: number;
        encodeMsMax: number;
        encodeQueueDepth?: number;
        encoder?: VideoEncodeLocation;
        encodeRoundTripMsLast?: number;
        encodeRoundTripMsMax?: number;
        encodeWorkerRestarts?: number;
        framesDroppedAfterEncode?: number;
        framesReceived: number;
        framesSent: number;
        framesSkippedEncoding?: number;
        framesSkippedNotDue: number;
        selectedSources: number;
        sourceSwitches?: number;
        switchesHeld?: number;
        switchGapMsLast?: number;
        switchGapMsMax?: number;
    }
    Index

    Properties

    activeSpeakerUpdates? bytesSent encodeDispatchMsMax? encodeFailures? encodeInFlight? encodeMsLast? encodeMsMax encodeQueueDepth? encoder? encodeRoundTripMsLast? encodeRoundTripMsMax? encodeWorkerRestarts? framesDroppedAfterEncode? framesReceived framesSent framesSkippedEncoding? framesSkippedNotDue selectedSources sourceSwitches? switchesHeld? switchGapMsLast? switchGapMsMax?

    Properties

    activeSpeakerUpdates?: number

    Active-speaker updates LiveKit sent the bot.

    bytesSent: number

    JPEG bytes handed to the bridge.

    encodeDispatchMsMax?: number

    Longest cost to the room's thread of sending one sampled frame, in ms: the copy and the post to the encode worker, or the whole encode when frames are encoded in-process.

    encodeFailures?: number

    Frames that failed to encode: a rejected frame, a request that timed out, or the encode worker failing with it in flight.

    encodeInFlight?: number

    This room's frames being encoded now: its queue depth.

    encodeMsLast?: number

    Duration of the most recent encode (scale, rotate, JPEG), in ms, on the thread that encoded it.

    encodeMsMax: number

    Longest encode so far, in ms.

    encodeQueueDepth?: number

    Frames sent to the encode worker and not answered yet, from every room on this thread.

    encoder?: VideoEncodeLocation

    Where frames are encoded now.

    encodeRoundTripMsLast?: number

    Most recent time from sending a frame to the encoder to its reply, in ms, on the room's thread: queueing behind other rooms' frames, the hops between threads, and the encode.

    encodeRoundTripMsMax?: number

    Longest round trip so far, in ms.

    encodeWorkerRestarts?: number

    Encode worker failures on this thread since the process started.

    framesDroppedAfterEncode?: number

    Frames encoded, then dropped: consent withdrawn, the source ended or the bot left while they were encoded.

    framesReceived: number

    Frames decoded from the selected sources (every frame is drained, sampled or not).

    framesSent: number

    Frames encoded and handed to the bridge.

    framesSkippedEncoding?: number

    Due frames dropped because the source's previous frame was still being encoded.

    framesSkippedNotDue: number

    Frames dropped because the source's next frame was not due yet (pacing to the session's rate).

    selectedSources: number

    Sources selected now (being read, or subscribed and waiting for their track).

    sourceSwitches?: number

    Sources the ranking replaced while they could still be read: a screen was shared, or a speaker took the view. Not counted: a source that ended (an opt-out, a leave, an unpublish, a mute, its stream ending).

    switchesHeld?: number

    Changes the hold delayed (a speaker who had not led long enough, a camera inside its dwell), each counted once.

    switchGapMsLast?: number

    Most recent time from picking a source to its first frame reaching the bridge, in ms (subscription, first keyframe, sampling, encode): after a switch, how long the model saw nothing.

    switchGapMsMax?: number

    Longest such gap so far, in ms.

    Settings

    Member Visibility

    On This Page

    Properties