@3dsource/metabox-front-api
    Preparing search index...

    Interface VideoStats

    Video stream statistics reported by the Metabox player.

    Real-time video quality metrics from the WebRTC stream — useful for monitoring bitrate, frame rate, latency, and packet loss.

    Delivered as the payload of the videoStatsUpdated event. Use it to build quality-of-service dashboards or trigger adaptive behavior (e.g. show a warning when packetsLost climbs or framesDropped is high).

    Subscribe via api.addEventListener('videoStatsUpdated', (stats: VideoStats) => {...}).

    interface VideoStats {
        bitrate?: number;
        framesDecoded?: number;
        framesDropped?: number;
        framesPerSecond?: number;
        framesReceived?: number;
        jitter?: number;
        packetsLost?: number;
        qp?: number;
        rtt?: number;
    }
    Index

    Properties

    bitrate?: number

    Current bitrate in bits per second.

    framesDecoded?: number

    The total number of frames successfully decoded.

    framesDropped?: number

    The total number of frames dropped.

    framesPerSecond?: number

    Decoded frames per second.

    framesReceived?: number

    Total number of frames received.

    jitter?: number

    Inter-arrival jitter in seconds.

    packetsLost?: number

    Total number of packets lost.

    qp?: number

    Video encoder quantization parameter (lower = better quality).

    rtt?: number

    Current round-trip time in seconds.