@twilio/video-node-sdk - v1.0.0-beta.2
    Preparing search index...

    Interface VideoFrame

    A decoded I420 video frame delivered by RemoteVideoTrack.frames. frameId increments per frame.

    interface VideoFrame {
        captureTimestamp?: number;
        format: "I420";
        frameId: number;
        height: number;
        rotation?: 0 | 90 | 180 | 270;
        rtpTimestamp?: number;
        timestamp: number;
        u: I420Plane;
        v: I420Plane;
        width: number;
        y: I420Plane;
        close?(): void;
    }
    Index
    captureTimestamp? format frameId height rotation? rtpTimestamp? timestamp u v width y
    close?
    captureTimestamp?: number

    When the sender captured the frame, in microseconds, if the sender reported it.

    format: "I420"

    Always 'I420'. The only pixel format this SDK delivers.

    frameId: number

    SDK-generated monotonic per-track counter, for gap and drop detection.

    height: number

    Frame height in pixels.

    rotation?: 0 | 90 | 180 | 270

    Clockwise rotation to apply on display, in degrees.

    rtpTimestamp?: number

    RTP timestamp from the packet that carried this frame, if available.

    timestamp: number

    Local receive time, in microseconds on a monotonic clock.

    u: I420Plane

    Blue-difference chrominance plane, half resolution in each dimension.

    v: I420Plane

    Red-difference chrominance plane, half resolution in each dimension.

    width: number

    Frame width in pixels.

    y: I420Plane

    Luminance plane.

    • Optional deterministic-release hint. Not required for correctness - the frame is an owned copy and GC reclaims it - but calling it releases the plane buffers promptly. Idempotent; reading plane data after close() throws.

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods