Interface EncodeRequest

Plugin-worker encoding request; its temporary raster buffer is transferred.

interface EncodeRequest {
    format: string;
    kind: "encode";
    options?: Record<string, unknown>;
    output: OutputSettings;
    raster: Raster;
}

Properties

format: string

Plugin encoder ID; must match the chosen worker.

kind: "encode"

Encoding operation discriminator.

options?: Record<string, unknown>

Serializable format options, such as JPEG quality/background.

Revisioned raster settings passed to the encoder.

raster: Raster

Temporary full-resolution raster. Its buffer is detached on submission and returned in EngineResult.raster.