@jellyfin/sdk
    Preparing search index...

    Interface EncodingOptions

    Class EncodingOptions.

    EncodingOptions

    interface EncodingOptions {
        AllowAv1Encoding?: boolean;
        AllowHevcEncoding?: boolean;
        AllowOnDemandMetadataBasedKeyframeExtractionForExtensions?: string[] | null;
        DeinterlaceDoubleRate?: boolean;
        DeinterlaceMethod?: DeinterlaceMethod;
        DownMixAudioBoost?: number;
        DownMixStereoAlgorithm?: DownMixStereoAlgorithms;
        EnableAudioVbr?: boolean;
        EnableDecodingColorDepth10Hevc?: boolean;
        EnableDecodingColorDepth10HevcRext?: boolean;
        EnableDecodingColorDepth10Vp9?: boolean;
        EnableDecodingColorDepth12HevcRext?: boolean;
        EnableEnhancedNvdecDecoder?: boolean;
        EnableFallbackFont?: boolean;
        EnableHardwareEncoding?: boolean;
        EnableIntelLowPowerH264HwEncoder?: boolean;
        EnableIntelLowPowerHevcHwEncoder?: boolean;
        EnableSegmentDeletion?: boolean;
        EnableSubtitleExtraction?: boolean;
        EnableThrottling?: boolean;
        EnableTonemapping?: boolean;
        EnableVideoToolboxTonemapping?: boolean;
        EnableVppTonemapping?: boolean;
        EncoderAppPath?: string | null;
        EncoderAppPathDisplay?: string | null;
        EncoderPreset?: EncoderPreset;
        EncodingThreadCount?: number;
        FallbackFontPath?: string | null;
        H264Crf?: number;
        H265Crf?: number;
        HardwareAccelerationType?: HardwareAccelerationType;
        HardwareDecodingCodecs?: string[] | null;
        MaxMuxingQueueSize?: number;
        PreferSystemNativeHwDecoder?: boolean;
        QsvDevice?: string | null;
        SegmentKeepSeconds?: number;
        ThrottleDelaySeconds?: number;
        TonemappingAlgorithm?: TonemappingAlgorithm;
        TonemappingDesat?: number;
        TonemappingMode?: TonemappingMode;
        TonemappingParam?: number;
        TonemappingPeak?: number;
        TonemappingRange?: TonemappingRange;
        TranscodingTempPath?: string | null;
        VaapiDevice?: string | null;
        VppTonemappingBrightness?: number;
        VppTonemappingContrast?: number;
    }
    Index

    Properties

    AllowAv1Encoding? AllowHevcEncoding? AllowOnDemandMetadataBasedKeyframeExtractionForExtensions? DeinterlaceDoubleRate? DeinterlaceMethod? DownMixAudioBoost? DownMixStereoAlgorithm? EnableAudioVbr? EnableDecodingColorDepth10Hevc? EnableDecodingColorDepth10HevcRext? EnableDecodingColorDepth10Vp9? EnableDecodingColorDepth12HevcRext? EnableEnhancedNvdecDecoder? EnableFallbackFont? EnableHardwareEncoding? EnableIntelLowPowerH264HwEncoder? EnableIntelLowPowerHevcHwEncoder? EnableSegmentDeletion? EnableSubtitleExtraction? EnableThrottling? EnableTonemapping? EnableVideoToolboxTonemapping? EnableVppTonemapping? EncoderAppPath? EncoderAppPathDisplay? EncoderPreset? EncodingThreadCount? FallbackFontPath? H264Crf? H265Crf? HardwareAccelerationType? HardwareDecodingCodecs? MaxMuxingQueueSize? PreferSystemNativeHwDecoder? QsvDevice? SegmentKeepSeconds? ThrottleDelaySeconds? TonemappingAlgorithm? TonemappingDesat? TonemappingMode? TonemappingParam? TonemappingPeak? TonemappingRange? TranscodingTempPath? VaapiDevice? VppTonemappingBrightness? VppTonemappingContrast?

    Properties

    AllowAv1Encoding?: boolean

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

    EncodingOptions

    AllowHevcEncoding?: boolean

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

    EncodingOptions

    AllowOnDemandMetadataBasedKeyframeExtractionForExtensions?: string[] | null

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

    EncodingOptions

    DeinterlaceDoubleRate?: boolean

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

    EncodingOptions

    DeinterlaceMethod?: DeinterlaceMethod

    EncodingOptions

    DownMixAudioBoost?: number

    Gets or sets the audio boost applied when downmixing audio.

    EncodingOptions

    DownMixStereoAlgorithm?: DownMixStereoAlgorithms

    EncodingOptions

    EnableAudioVbr?: boolean

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

    EncodingOptions

    EnableDecodingColorDepth10Hevc?: boolean

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

    EncodingOptions

    EnableDecodingColorDepth10HevcRext?: boolean

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

    EncodingOptions

    EnableDecodingColorDepth10Vp9?: boolean

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

    EncodingOptions

    EnableDecodingColorDepth12HevcRext?: boolean

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

    EncodingOptions

    EnableEnhancedNvdecDecoder?: boolean

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

    EncodingOptions

    EnableFallbackFont?: boolean

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

    EncodingOptions

    EnableHardwareEncoding?: boolean

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

    EncodingOptions

    EnableIntelLowPowerH264HwEncoder?: boolean

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

    EncodingOptions

    EnableIntelLowPowerHevcHwEncoder?: boolean

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

    EncodingOptions

    EnableSegmentDeletion?: boolean

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

    EncodingOptions

    EnableSubtitleExtraction?: boolean

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

    EncodingOptions

    EnableThrottling?: boolean

    Gets or sets a value indicating whether throttling is enabled.

    EncodingOptions

    EnableTonemapping?: boolean

    Gets or sets a value indicating whether tonemapping is enabled.

    EncodingOptions

    EnableVideoToolboxTonemapping?: boolean

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

    EncodingOptions

    EnableVppTonemapping?: boolean

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

    EncodingOptions

    EncoderAppPath?: string | null

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

    EncodingOptions

    EncoderAppPathDisplay?: string | null

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

    EncodingOptions

    EncoderPreset?: EncoderPreset

    EncodingOptions

    EncodingThreadCount?: number

    Gets or sets the thread count used for encoding.

    EncodingOptions

    FallbackFontPath?: string | null

    Gets or sets the path to the fallback font.

    EncodingOptions

    H264Crf?: number

    Gets or sets the H264 CRF.

    EncodingOptions

    H265Crf?: number

    Gets or sets the H265 CRF.

    EncodingOptions

    HardwareAccelerationType?: HardwareAccelerationType

    EncodingOptions

    HardwareDecodingCodecs?: string[] | null

    Gets or sets the codecs hardware encoding is used for.

    EncodingOptions

    MaxMuxingQueueSize?: number

    Gets or sets the maximum size of the muxing queue.

    EncodingOptions

    PreferSystemNativeHwDecoder?: boolean

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

    EncodingOptions

    QsvDevice?: string | null

    Gets or sets the QSV device.

    EncodingOptions

    SegmentKeepSeconds?: number

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

    EncodingOptions

    ThrottleDelaySeconds?: number

    Gets or sets the delay after which throttling happens.

    EncodingOptions

    TonemappingAlgorithm?: TonemappingAlgorithm

    EncodingOptions

    TonemappingDesat?: number

    Gets or sets the tone-mapping desaturation.

    EncodingOptions

    TonemappingMode?: TonemappingMode

    EncodingOptions

    TonemappingParam?: number

    Gets or sets the tone-mapping parameters.

    EncodingOptions

    TonemappingPeak?: number

    Gets or sets the tone-mapping peak.

    EncodingOptions

    TonemappingRange?: TonemappingRange

    EncodingOptions

    TranscodingTempPath?: string | null

    Gets or sets the temporary transcoding path.

    EncodingOptions

    VaapiDevice?: string | null

    Gets or sets the VA-API device.

    EncodingOptions

    VppTonemappingBrightness?: number

    Gets or sets the VPP tone-mapping brightness.

    EncodingOptions

    VppTonemappingContrast?: number

    Gets or sets the VPP tone-mapping contrast.

    EncodingOptions

    Settings

    Member Visibility

    On This Page

    Properties
    AllowAv1EncodingAllowHevcEncodingAllowOnDemandMetadataBasedKeyframeExtractionForExtensionsDeinterlaceDoubleRateDeinterlaceMethodDownMixAudioBoostDownMixStereoAlgorithmEnableAudioVbrEnableDecodingColorDepth10HevcEnableDecodingColorDepth10HevcRextEnableDecodingColorDepth10Vp9EnableDecodingColorDepth12HevcRextEnableEnhancedNvdecDecoderEnableFallbackFontEnableHardwareEncodingEnableIntelLowPowerH264HwEncoderEnableIntelLowPowerHevcHwEncoderEnableSegmentDeletionEnableSubtitleExtractionEnableThrottlingEnableTonemappingEnableVideoToolboxTonemappingEnableVppTonemappingEncoderAppPathEncoderAppPathDisplayEncoderPresetEncodingThreadCountFallbackFontPathH264CrfH265CrfHardwareAccelerationTypeHardwareDecodingCodecsMaxMuxingQueueSizePreferSystemNativeHwDecoderQsvDeviceSegmentKeepSecondsThrottleDelaySecondsTonemappingAlgorithmTonemappingDesatTonemappingModeTonemappingParamTonemappingPeakTonemappingRangeTranscodingTempPathVaapiDeviceVppTonemappingBrightnessVppTonemappingContrast