Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias TrickplayOptions

    Class TrickplayOptions.

    type TrickplayOptions = {
        EnableHwAcceleration?: boolean;
        EnableHwEncoding?: boolean;
        EnableKeyFrameOnlyExtraction?: boolean;
        ScanBehavior?: "Blocking" | "NonBlocking";
        ProcessPriority?:
            | "Normal"
            | "Idle"
            | "High"
            | "RealTime"
            | "BelowNormal"
            | "AboveNormal";
        Interval?: number;
        WidthResolutions?: number[];
        TileWidth?: number;
        TileHeight?: number;
        Qscale?: number;
        JpegQuality?: number;
        ProcessThreads?: number;
    }
    Index
    EnableHwAcceleration? EnableHwEncoding? EnableKeyFrameOnlyExtraction? ScanBehavior? ProcessPriority? Interval? WidthResolutions? TileWidth? TileHeight? Qscale? JpegQuality? ProcessThreads?
    EnableHwAcceleration?: boolean

    Gets or sets a value indicating whether or not to use HW acceleration.

    EnableHwEncoding?: boolean

    Gets or sets a value indicating whether or not to use HW accelerated MJPEG encoding.

    EnableKeyFrameOnlyExtraction?: boolean

    Gets or sets a value indicating whether to only extract key frames. Significantly faster, but is not compatible with all decoders and/or video files.

    ScanBehavior?: "Blocking" | "NonBlocking"

    Gets or sets the behavior used by trickplay provider on library scan/update.

    ProcessPriority?:
        | "Normal"
        | "Idle"
        | "High"
        | "RealTime"
        | "BelowNormal"
        | "AboveNormal"

    Gets or sets the process priority for the ffmpeg process.

    Interval?: number

    Gets or sets the interval, in ms, between each new trickplay image.

    WidthResolutions?: number[]

    Gets or sets the target width resolutions, in px, to generates preview images for.

    TileWidth?: number

    Gets or sets number of tile images to allow in X dimension.

    TileHeight?: number

    Gets or sets number of tile images to allow in Y dimension.

    Qscale?: number

    Gets or sets the ffmpeg output quality level.

    JpegQuality?: number

    Gets or sets the jpeg quality to use for image tiles.

    ProcessThreads?: number

    Gets or sets the number of threads to be used by ffmpeg.

    Settings
    Member Visibility

    On This Page
    Properties