Interface OutputVideo

Represents the statistics object for an output video stream.

interface OutputVideo {
    bitrate?: number;
    bytesSentDelta?: number;
    frameHeight?: number;
    frameWidth?: number;
    framesPerSecond?: number;
    framesSent?: 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 full)

Properties

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

Properties

Optionalbitrate

bitrate?: number

Current bitrate in bytes per second.

OptionalbytesSentDelta

bytesSentDelta?: number

Number of bytes sent for this SSRC since last collection.

OptionalframeHeight

frameHeight?: number

Represents the height of the last encoded frame.

OptionalframeWidth

frameWidth?: number

Represents the width of the last encoded frame.

OptionalframesPerSecond

framesPerSecond?: number

The number of encoded frames during the last second.

OptionalframesSent

framesSent?: number

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

id

id: string

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

Optionalmid

mid?: string

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

OptionalmimeType

mimeType?: string

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

OptionalpacketRate

packetRate?: number

Current packet rate in packets per second.

OptionalpacketsSentDelta

packetsSentDelta?: number

Number of packets sent for this SSRC since last collection.

OptionalqualityLimitationDurations

qualityLimitationDurations?: Record<string, number>

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

qualityLimitationReason

qualityLimitationReason: QualityLimitationReason

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

OptionalretransmittedBytesSent

retransmittedBytesSent?: number

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

OptionalretransmittedBytesSentDelta

retransmittedBytesSentDelta?: number

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

OptionalretransmittedPacketsSent

retransmittedPacketsSent?: number

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

OptionalretransmittedPacketsSentDelta

retransmittedPacketsSentDelta?: number

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

OptionaltargetBitrate

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

timestamp: number

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

OptionaltotalBytesSent

totalBytesSent?: number

Total number of bytes sent for this SSRC.

OptionaltotalPacketsSent

totalPacketsSent?: number

Total number of packets sent for this SSRC.

Settings

Member Visibility

On This Page

Properties