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

    Type Alias EncodingOptions

    Class EncodingOptions.

    type EncodingOptions = {
        EncodingThreadCount?: number;
        TranscodingTempPath?: string | null;
        FallbackFontPath?: string | null;
        EnableFallbackFont?: boolean;
        EnableAudioVbr?: boolean;
        DownMixAudioBoost?: number;
        DownMixStereoAlgorithm?:
            | "None"
            | "Dave750"
            | "NightmodeDialogue"
            | "Rfc7845"
            | "Ac4";
        MaxMuxingQueueSize?: number;
        EnableThrottling?: boolean;
        ThrottleDelaySeconds?: number;
        EnableSegmentDeletion?: boolean;
        SegmentKeepSeconds?: number;
        HardwareAccelerationType?: | "none"
        | "amf"
        | "qsv"
        | "nvenc"
        | "v4l2m2m"
        | "vaapi"
        | "videotoolbox"
        | "rkmpp";
        EncoderAppPath?: string
        | null;
        EncoderAppPathDisplay?: string | null;
        VaapiDevice?: string | null;
        QsvDevice?: string | null;
        EnableTonemapping?: boolean;
        EnableVppTonemapping?: boolean;
        EnableVideoToolboxTonemapping?: boolean;
        TonemappingAlgorithm?:
            | "none"
            | "clip"
            | "linear"
            | "gamma"
            | "reinhard"
            | "hable"
            | "mobius"
            | "bt2390";
        TonemappingMode?: "auto"
        | "max"
        | "rgb"
        | "lum"
        | "itp";
        TonemappingRange?: "auto" | "tv" | "pc";
        TonemappingDesat?: number;
        TonemappingPeak?: number;
        TonemappingParam?: number;
        VppTonemappingBrightness?: number;
        VppTonemappingContrast?: number;
        H264Crf?: number;
        H265Crf?: number;
        EncoderPreset?:
            | "auto"
            | "placebo"
            | "veryslow"
            | "slower"
            | "slow"
            | "medium"
            | "fast"
            | "faster"
            | "veryfast"
            | "superfast"
            | "ultrafast";
        DeinterlaceDoubleRate?: boolean;
        DeinterlaceMethod?: "yadif"
        | "bwdif";
        EnableDecodingColorDepth10Hevc?: boolean;
        EnableDecodingColorDepth10Vp9?: boolean;
        EnableDecodingColorDepth10HevcRext?: boolean;
        EnableDecodingColorDepth12HevcRext?: boolean;
        EnableEnhancedNvdecDecoder?: boolean;
        PreferSystemNativeHwDecoder?: boolean;
        EnableIntelLowPowerH264HwEncoder?: boolean;
        EnableIntelLowPowerHevcHwEncoder?: boolean;
        EnableHardwareEncoding?: boolean;
        AllowHevcEncoding?: boolean;
        AllowAv1Encoding?: boolean;
        EnableSubtitleExtraction?: boolean;
        SubtitleExtractionTimeoutMinutes?: number;
        HardwareDecodingCodecs?: string[] | null;
        AllowOnDemandMetadataBasedKeyframeExtractionForExtensions?: string[] | null;
        HlsAudioSeekStrategy?: "TrimCopiedAudio" | "TranscodeAudio";
    }
    Index
    EncodingThreadCount? TranscodingTempPath? FallbackFontPath? EnableFallbackFont? EnableAudioVbr? DownMixAudioBoost? DownMixStereoAlgorithm? MaxMuxingQueueSize? EnableThrottling? ThrottleDelaySeconds? EnableSegmentDeletion? SegmentKeepSeconds? HardwareAccelerationType? EncoderAppPath? EncoderAppPathDisplay? VaapiDevice? QsvDevice? EnableTonemapping? EnableVppTonemapping? EnableVideoToolboxTonemapping? TonemappingAlgorithm? TonemappingMode? TonemappingRange? TonemappingDesat? TonemappingPeak? TonemappingParam? VppTonemappingBrightness? VppTonemappingContrast? H264Crf? H265Crf? EncoderPreset? DeinterlaceDoubleRate? DeinterlaceMethod? EnableDecodingColorDepth10Hevc? EnableDecodingColorDepth10Vp9? EnableDecodingColorDepth10HevcRext? EnableDecodingColorDepth12HevcRext? EnableEnhancedNvdecDecoder? PreferSystemNativeHwDecoder? EnableIntelLowPowerH264HwEncoder? EnableIntelLowPowerHevcHwEncoder? EnableHardwareEncoding? AllowHevcEncoding? AllowAv1Encoding? EnableSubtitleExtraction? SubtitleExtractionTimeoutMinutes? HardwareDecodingCodecs? AllowOnDemandMetadataBasedKeyframeExtractionForExtensions? HlsAudioSeekStrategy?
    EncodingThreadCount?: number

    Gets or sets the thread count used for encoding.

    TranscodingTempPath?: string | null

    Gets or sets the temporary transcoding path.

    FallbackFontPath?: string | null

    Gets or sets the path to the fallback font.

    EnableFallbackFont?: boolean

    Gets or sets a value indicating whether to use the fallback font.

    EnableAudioVbr?: boolean

    Gets or sets a value indicating whether audio VBR is enabled.

    DownMixAudioBoost?: number

    Gets or sets the audio boost applied when downmixing audio.

    DownMixStereoAlgorithm?:
        | "None"
        | "Dave750"
        | "NightmodeDialogue"
        | "Rfc7845"
        | "Ac4"

    Gets or sets the algorithm used for downmixing audio to stereo.

    MaxMuxingQueueSize?: number

    Gets or sets the maximum size of the muxing queue.

    EnableThrottling?: boolean

    Gets or sets a value indicating whether throttling is enabled.

    ThrottleDelaySeconds?: number

    Gets or sets the delay after which throttling happens.

    EnableSegmentDeletion?: boolean

    Gets or sets a value indicating whether segment deletion is enabled.

    SegmentKeepSeconds?: number

    Gets or sets seconds for which segments should be kept before being deleted.

    HardwareAccelerationType?:
        | "none"
        | "amf"
        | "qsv"
        | "nvenc"
        | "v4l2m2m"
        | "vaapi"
        | "videotoolbox"
        | "rkmpp"

    Gets or sets the hardware acceleration type.

    EncoderAppPath?: string | null

    Gets or sets the FFmpeg path as set by the user via the UI.

    EncoderAppPathDisplay?: string | null

    Gets or sets the current FFmpeg path being used by the system and displayed on the transcode page.

    VaapiDevice?: string | null

    Gets or sets the VA-API device.

    QsvDevice?: string | null

    Gets or sets the QSV device.

    EnableTonemapping?: boolean

    Gets or sets a value indicating whether tonemapping is enabled.

    EnableVppTonemapping?: boolean

    Gets or sets a value indicating whether VPP tonemapping is enabled.

    EnableVideoToolboxTonemapping?: boolean

    Gets or sets a value indicating whether videotoolbox tonemapping is enabled.

    TonemappingAlgorithm?:
        | "none"
        | "clip"
        | "linear"
        | "gamma"
        | "reinhard"
        | "hable"
        | "mobius"
        | "bt2390"

    Gets or sets the tone-mapping algorithm.

    TonemappingMode?: "auto" | "max" | "rgb" | "lum" | "itp"

    Gets or sets the tone-mapping mode.

    TonemappingRange?: "auto" | "tv" | "pc"

    Gets or sets the tone-mapping range.

    TonemappingDesat?: number

    Gets or sets the tone-mapping desaturation.

    TonemappingPeak?: number

    Gets or sets the tone-mapping peak.

    TonemappingParam?: number

    Gets or sets the tone-mapping parameters.

    VppTonemappingBrightness?: number

    Gets or sets the VPP tone-mapping brightness.

    VppTonemappingContrast?: number

    Gets or sets the VPP tone-mapping contrast.

    H264Crf?: number

    Gets or sets the H264 CRF.

    H265Crf?: number

    Gets or sets the H265 CRF.

    EncoderPreset?:
        | "auto"
        | "placebo"
        | "veryslow"
        | "slower"
        | "slow"
        | "medium"
        | "fast"
        | "faster"
        | "veryfast"
        | "superfast"
        | "ultrafast"

    Gets or sets the encoder preset.

    DeinterlaceDoubleRate?: boolean

    Gets or sets a value indicating whether the framerate is doubled when deinterlacing.

    DeinterlaceMethod?: "yadif" | "bwdif"

    Gets or sets the deinterlace method.

    EnableDecodingColorDepth10Hevc?: boolean

    Gets or sets a value indicating whether 10bit HEVC decoding is enabled.

    EnableDecodingColorDepth10Vp9?: boolean

    Gets or sets a value indicating whether 10bit VP9 decoding is enabled.

    EnableDecodingColorDepth10HevcRext?: boolean

    Gets or sets a value indicating whether 8/10bit HEVC RExt decoding is enabled.

    EnableDecodingColorDepth12HevcRext?: boolean

    Gets or sets a value indicating whether 12bit HEVC RExt decoding is enabled.

    EnableEnhancedNvdecDecoder?: boolean

    Gets or sets a value indicating whether the enhanced NVDEC is enabled.

    PreferSystemNativeHwDecoder?: boolean

    Gets or sets a value indicating whether the system native hardware decoder should be used.

    EnableIntelLowPowerH264HwEncoder?: boolean

    Gets or sets a value indicating whether the Intel H264 low-power hardware encoder should be used.

    EnableIntelLowPowerHevcHwEncoder?: boolean

    Gets or sets a value indicating whether the Intel HEVC low-power hardware encoder should be used.

    EnableHardwareEncoding?: boolean

    Gets or sets a value indicating whether hardware encoding is enabled.

    AllowHevcEncoding?: boolean

    Gets or sets a value indicating whether HEVC encoding is enabled.

    AllowAv1Encoding?: boolean

    Gets or sets a value indicating whether AV1 encoding is enabled.

    EnableSubtitleExtraction?: boolean

    Gets or sets a value indicating whether subtitle extraction is enabled.

    SubtitleExtractionTimeoutMinutes?: number

    Gets or sets the timeout for subtitle extraction in minutes.

    HardwareDecodingCodecs?: string[] | null

    Gets or sets the codecs hardware encoding is used for.

    AllowOnDemandMetadataBasedKeyframeExtractionForExtensions?: string[] | null

    Gets or sets the file extensions on-demand metadata based keyframe extraction is enabled for.

    HlsAudioSeekStrategy?: "TrimCopiedAudio" | "TranscodeAudio"

    Gets or sets the method used for audio seeking in HLS.

    Settings
    Member Visibility

    On This Page
    Properties
    EncodingThreadCountTranscodingTempPathFallbackFontPathEnableFallbackFontEnableAudioVbrDownMixAudioBoostDownMixStereoAlgorithmMaxMuxingQueueSizeEnableThrottlingThrottleDelaySecondsEnableSegmentDeletionSegmentKeepSecondsHardwareAccelerationTypeEncoderAppPathEncoderAppPathDisplayVaapiDeviceQsvDeviceEnableTonemappingEnableVppTonemappingEnableVideoToolboxTonemappingTonemappingAlgorithmTonemappingModeTonemappingRangeTonemappingDesatTonemappingPeakTonemappingParamVppTonemappingBrightnessVppTonemappingContrastH264CrfH265CrfEncoderPresetDeinterlaceDoubleRateDeinterlaceMethodEnableDecodingColorDepth10HevcEnableDecodingColorDepth10Vp9EnableDecodingColorDepth10HevcRextEnableDecodingColorDepth12HevcRextEnableEnhancedNvdecDecoderPreferSystemNativeHwDecoderEnableIntelLowPowerH264HwEncoderEnableIntelLowPowerHevcHwEncoderEnableHardwareEncodingAllowHevcEncodingAllowAv1EncodingEnableSubtitleExtractionSubtitleExtractionTimeoutMinutesHardwareDecodingCodecsAllowOnDemandMetadataBasedKeyframeExtractionForExtensionsHlsAudioSeekStrategy