Dolby.io WebRTC Statistics - v1.0.4
    Preparing search index...

    Interface OutputVideo

    Represents the statistics object for an output video stream.

    interface OutputVideo {
        bitrate?: number;
        bytesSentDelta?: number;
        frameHeight?: number;
        framesPerSecond?: number;
        framesSent?: number;
        frameWidth?: number;
        id: string;
        mid?: string;
        mimeType?: string;
        packetRate?: number;
        packetsSentDelta?: number;
        qualityLimitationDurations?: Record<string, number>;
        qualityLimitationReason: QualityLimitationReason;
        retransmittedBytesSent?: number;
        retransmittedBytesSentDelta?: number;
        retransmittedPacketsSent?: number;
        retransmittedPacketsSentDelta?: number;
        targetBitrate?: number;
        timestamp: number;
        totalBytesSent?: number;
        totalPacketsSent?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    bitrate? bytesSentDelta? frameHeight? framesPerSecond? framesSent? frameWidth? id mid? mimeType? packetRate? packetsSentDelta? qualityLimitationDurations? qualityLimitationReason retransmittedBytesSent? retransmittedBytesSentDelta? retransmittedPacketsSent? retransmittedPacketsSentDelta? targetBitrate? timestamp totalBytesSent? totalPacketsSent?

    Properties

    bitrate?: number

    Current bitrate in bytes per second.

    bytesSentDelta?: number

    Number of bytes sent for this SSRC since last collection.

    frameHeight?: number

    Represents the height of the last encoded frame.

    framesPerSecond?: number

    The number of encoded frames during the last second.

    framesSent?: number

    Represents the total number of frames sent on this RTP stream.

    frameWidth?: number

    Represents the width of the last encoded frame.

    id: string

    A unique id that is associated with the object that was inspected to produce this StatsBase object.

    mid?: string

    Media stream "identification-tag" negotiated and present in the local and remote descriptions.

    mimeType?: string

    The codec MIME media type/subtype. e.g., video/vp8 or equivalent.

    packetRate?: number

    Current packet rate in packets per second.

    packetsSentDelta?: number

    Number of packets sent for this SSRC since last collection.

    qualityLimitationDurations?: Record<string, number>

    A record of the total time, in seconds, that this stream has spent in each quality limitation state.

    qualityLimitationReason: QualityLimitationReason

    The current reason for limiting the resolution and/or framerate, or "none" if not limited.

    retransmittedBytesSent?: number

    The total number of bytes that were retransmitted for this SSRC, only including payload bytes.

    retransmittedBytesSentDelta?: number

    Number of bytes that were retransmitted for this SSRC, only including payload bytes since last collection.

    retransmittedPacketsSent?: number

    The total number of packets that were retransmitted for this SSRC.

    retransmittedPacketsSentDelta?: number

    Number of packets that were retransmitted for this SSRC since last collection.

    targetBitrate?: number

    Reflects the current encoder target in bits per second. The target is an instantaneous value reflecting the encoder's settings, but the resulting payload bytes sent per second, excluding retransmissions, should closely correlate to the target.

    timestamp: number

    The timestamp, associated with this object. The time is relative to the UNIX epoch (Jan 1, 1970, UTC).

    totalBytesSent?: number

    Total number of bytes sent for this SSRC.

    totalPacketsSent?: number

    Total number of packets sent for this SSRC.

    Settings

    Member Visibility

    On This Page

    Properties