@twilio/video-node-sdk - v1.0.0-rc.3
    Preparing search index...

    Interface VideoFrameInput

    An I420 video frame to push into a LocalVideoTrack via its write method. Uses the same planar layout as the delivered VideoFrame, so a received frame can be re-published without reshaping it.

    Each plane's data must be at least stride * height bytes (ceil(height / 2) for the 2x-subsampled u/v planes). width and height must be positive and even; odd dimensions are rejected with a RangeError.

    Buffers are copied synchronously during write(), so the caller may reuse or free them as soon as it returns.

    interface VideoFrameInput {
        format?: "I420";
        height: number;
        rotation?: 0 | 90 | 180 | 270;
        timestamp?: number;
        u: I420Plane;
        v: I420Plane;
        width: number;
        y: I420Plane;
    }
    Index
    format? height rotation? timestamp? u v width y
    format?: "I420"

    Always 'I420'. Optional; rejected if present and not 'I420'.

    height: number

    Frame height in pixels. Must be positive and even.

    rotation?: 0 | 90 | 180 | 270

    Clockwise rotation to apply on display, in degrees. Defaults to 0.

    timestamp?: number

    Presentation time in microseconds. Defaults to the current monotonic time when omitted, which is correct for an application-paced live source.

    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. Must be positive and even.

    y: I420Plane

    Luminance plane.

    Settings
    Member Visibility

    On This Page
    Properties