supervision-js
    Preparing search index...

    Interface PresentedFrame

    A frame delivered to the host. Acknowledging means its pixels and matching layers reached the host surface. A frame discarded before display is closed without being acknowledged.

    interface PresentedFrame {
        paintSeq: number;
        frameId: FrameId;
        mediaTimeS: number;
        mediaTimeMs: number;
        quality: FrameQuality;
        rotation: Rotation;
        frame: VideoFrame;
        acknowledgePresentation(): void;
    }

    Hierarchy

    • Omit<PresentedFramePayload, "navigationGeneration">
      • PresentedFrame
    Index
    paintSeq: number
    frameId: FrameId

    Which frame of the source these pixels are.

    mediaTimeS: number

    frameId.ticks / tickRate, the one seconds value anyone publishes.

    mediaTimeMs: number

    The same position on the whole-millisecond plane, for a host that still speaks it. Derived, never an input to anything.

    quality: FrameQuality
    rotation: Rotation

    Degrees clockwise the pixels still need. A VideoFrame carries no display matrix, so a host that draws these pixels as they arrive draws a portrait recording sideways unless it applies this.

    frame: VideoFrame

    Dimensions are the frame's own (codedWidth/codedHeight), so they are not restated alongside it.

    • Returns void