HomeGuidesAPI Reference
HubBlogChangelogSupport ForumLog In
API Reference

Web SDK - ReportEntry

Home > @rainway/web > ReportEntry

ReportEntry type

An entry in the stream metrics report, describing some event or stats probe in the stream.

This is intentionally "stringy" for ease of JSON exporting.

Signature:

export declare type ReportEntry = {
    type: SimpleEvent;
} | {
    type: "started";
    localPeerId: string;
    hostPeerId: string;
    streamId: number;
    videoCodec: string;
    streamType: "fullDesktop" | "appIsolation" | "byofb";
} | {
    type: "videoReadyState";
    state: keyof typeof VideoReadyState;
} | {
    type: "videoBitrateChange";
    newKbps: number;
    oldKbps: number;
    direction: "up" | "down";
} | {
    type: "stats";
    stats: StatsSummary;
};

References: SimpleEvent, VideoReadyState, StatsSummary