omni-compress - v2.3.1
    Preparing search index...

    Interface CompressorOptions

    interface CompressorOptions {
        type: "image" | "audio" | "video";
        format: string;
        maxSizeMB?: number;
        quality?: number;
        onProgress?: (percent: number) => void;
        originalFileName?: string;
        useWorker?: boolean;
        strict?: boolean;
        maxWidth?: number;
        maxHeight?: number;
        preserveMetadata?: boolean;
        bitrate?: string;
        channels?: 1 | 2;
        sampleRate?: number;
        videoBitrate?: string;
        fps?: number;
    }
    Index

    Properties

    type format maxSizeMB? quality? onProgress? originalFileName? useWorker? strict? maxWidth? maxHeight? preserveMetadata? bitrate? channels? sampleRate? videoBitrate? fps?

    Properties

    type: "image" | "audio" | "video"
    format: string
    maxSizeMB?: number
    quality?: number
    onProgress?: (percent: number) => void
    originalFileName?: string
    useWorker?: boolean

    Explicitly force Web Worker usage (true) or Main Thread usage (false).

    strict?: boolean

    If the compressed file is larger than the original, return the original. Default: false.

    maxWidth?: number
    maxHeight?: number
    preserveMetadata?: boolean
    bitrate?: string
    channels?: 1 | 2
    sampleRate?: number
    videoBitrate?: string
    fps?: number

    Settings

    Member Visibility

    On This Page

    Properties