Interface OptimizeOptions

interface OptimizeOptions {
    limit?: number;
    location?: { id: number } | "alongside-original";
    target: OptimizationPreset | CustomOptimizationTarget;
    title?: string;
    unwatchedOnly?: boolean;
}

Properties

limit?: number

Maximum number of matching videos to optimize. Omit to optimize all matches.

location?: { id: number } | "alongside-original"

Store beside the original media by default, or select a library location by ID.

Built-in preset or an explicit custom encoding target.

title?: string

Display name for the optimized group. Defaults to the media item's title.

unwatchedOnly?: boolean

Only optimize unwatched videos.