Interface EncodingOptions

Class EncodingOptions.

Export

EncodingOptions

interface EncodingOptions {
    AllowAv1Encoding?: boolean;
    AllowHevcEncoding?: boolean;
    AllowOnDemandMetadataBasedKeyframeExtractionForExtensions?: null | string[];
    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?: null | string;
    EncoderAppPathDisplay?: null | string;
    EncoderPreset?: EncoderPreset;
    EncodingThreadCount?: number;
    FallbackFontPath?: null | string;
    H264Crf?: number;
    H265Crf?: number;
    HardwareAccelerationType?: HardwareAccelerationType;
    HardwareDecodingCodecs?: null | string[];
    MaxMuxingQueueSize?: number;
    PreferSystemNativeHwDecoder?: boolean;
    QsvDevice?: null | string;
    SegmentKeepSeconds?: number;
    ThrottleDelaySeconds?: number;
    TonemappingAlgorithm?: TonemappingAlgorithm;
    TonemappingDesat?: number;
    TonemappingMode?: TonemappingMode;
    TonemappingParam?: number;
    TonemappingPeak?: number;
    TonemappingRange?: TonemappingRange;
    TranscodingTempPath?: null | string;
    VaapiDevice?: null | string;
    VppTonemappingBrightness?: number;
    VppTonemappingContrast?: number;
}

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

OptionalAllowAv1Encoding

AllowAv1Encoding?: boolean

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

Memberof

EncodingOptions

OptionalAllowHevcEncoding

AllowHevcEncoding?: boolean

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

Memberof

EncodingOptions

OptionalAllowOnDemandMetadataBasedKeyframeExtractionForExtensions

AllowOnDemandMetadataBasedKeyframeExtractionForExtensions?: null | string[]

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

Memberof

EncodingOptions

OptionalDeinterlaceDoubleRate

DeinterlaceDoubleRate?: boolean

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

Memberof

EncodingOptions

OptionalDeinterlaceMethod

DeinterlaceMethod?: DeinterlaceMethod

Memberof

EncodingOptions

OptionalDownMixAudioBoost

DownMixAudioBoost?: number

Gets or sets the audio boost applied when downmixing audio.

Memberof

EncodingOptions

OptionalDownMixStereoAlgorithm

DownMixStereoAlgorithm?: DownMixStereoAlgorithms

Memberof

EncodingOptions

OptionalEnableAudioVbr

EnableAudioVbr?: boolean

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

Memberof

EncodingOptions

OptionalEnableDecodingColorDepth10Hevc

EnableDecodingColorDepth10Hevc?: boolean

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

Memberof

EncodingOptions

OptionalEnableDecodingColorDepth10HevcRext

EnableDecodingColorDepth10HevcRext?: boolean

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

Memberof

EncodingOptions

OptionalEnableDecodingColorDepth10Vp9

EnableDecodingColorDepth10Vp9?: boolean

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

Memberof

EncodingOptions

OptionalEnableDecodingColorDepth12HevcRext

EnableDecodingColorDepth12HevcRext?: boolean

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

Memberof

EncodingOptions

OptionalEnableEnhancedNvdecDecoder

EnableEnhancedNvdecDecoder?: boolean

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

Memberof

EncodingOptions

OptionalEnableFallbackFont

EnableFallbackFont?: boolean

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

Memberof

EncodingOptions

OptionalEnableHardwareEncoding

EnableHardwareEncoding?: boolean

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

Memberof

EncodingOptions

OptionalEnableIntelLowPowerH264HwEncoder

EnableIntelLowPowerH264HwEncoder?: boolean

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

Memberof

EncodingOptions

OptionalEnableIntelLowPowerHevcHwEncoder

EnableIntelLowPowerHevcHwEncoder?: boolean

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

Memberof

EncodingOptions

OptionalEnableSegmentDeletion

EnableSegmentDeletion?: boolean

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

Memberof

EncodingOptions

OptionalEnableSubtitleExtraction

EnableSubtitleExtraction?: boolean

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

Memberof

EncodingOptions

OptionalEnableThrottling

EnableThrottling?: boolean

Gets or sets a value indicating whether throttling is enabled.

Memberof

EncodingOptions

OptionalEnableTonemapping

EnableTonemapping?: boolean

Gets or sets a value indicating whether tonemapping is enabled.

Memberof

EncodingOptions

OptionalEnableVideoToolboxTonemapping

EnableVideoToolboxTonemapping?: boolean

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

Memberof

EncodingOptions

OptionalEnableVppTonemapping

EnableVppTonemapping?: boolean

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

Memberof

EncodingOptions

OptionalEncoderAppPath

EncoderAppPath?: null | string

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

Memberof

EncodingOptions

OptionalEncoderAppPathDisplay

EncoderAppPathDisplay?: null | string

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

Memberof

EncodingOptions

OptionalEncoderPreset

EncoderPreset?: EncoderPreset

Memberof

EncodingOptions

OptionalEncodingThreadCount

EncodingThreadCount?: number

Gets or sets the thread count used for encoding.

Memberof

EncodingOptions

OptionalFallbackFontPath

FallbackFontPath?: null | string

Gets or sets the path to the fallback font.

Memberof

EncodingOptions

OptionalH264Crf

H264Crf?: number

Gets or sets the H264 CRF.

Memberof

EncodingOptions

OptionalH265Crf

H265Crf?: number

Gets or sets the H265 CRF.

Memberof

EncodingOptions

OptionalHardwareAccelerationType

HardwareAccelerationType?: HardwareAccelerationType

Memberof

EncodingOptions

OptionalHardwareDecodingCodecs

HardwareDecodingCodecs?: null | string[]

Gets or sets the codecs hardware encoding is used for.

Memberof

EncodingOptions

OptionalMaxMuxingQueueSize

MaxMuxingQueueSize?: number

Gets or sets the maximum size of the muxing queue.

Memberof

EncodingOptions

OptionalPreferSystemNativeHwDecoder

PreferSystemNativeHwDecoder?: boolean

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

Memberof

EncodingOptions

OptionalQsvDevice

QsvDevice?: null | string

Gets or sets the QSV device.

Memberof

EncodingOptions

OptionalSegmentKeepSeconds

SegmentKeepSeconds?: number

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

Memberof

EncodingOptions

OptionalThrottleDelaySeconds

ThrottleDelaySeconds?: number

Gets or sets the delay after which throttling happens.

Memberof

EncodingOptions

OptionalTonemappingAlgorithm

TonemappingAlgorithm?: TonemappingAlgorithm

Memberof

EncodingOptions

OptionalTonemappingDesat

TonemappingDesat?: number

Gets or sets the tone-mapping desaturation.

Memberof

EncodingOptions

OptionalTonemappingMode

TonemappingMode?: TonemappingMode

Memberof

EncodingOptions

OptionalTonemappingParam

TonemappingParam?: number

Gets or sets the tone-mapping parameters.

Memberof

EncodingOptions

OptionalTonemappingPeak

TonemappingPeak?: number

Gets or sets the tone-mapping peak.

Memberof

EncodingOptions

OptionalTonemappingRange

TonemappingRange?: TonemappingRange

Memberof

EncodingOptions

OptionalTranscodingTempPath

TranscodingTempPath?: null | string

Gets or sets the temporary transcoding path.

Memberof

EncodingOptions

OptionalVaapiDevice

VaapiDevice?: null | string

Gets or sets the VA-API device.

Memberof

EncodingOptions

OptionalVppTonemappingBrightness

VppTonemappingBrightness?: number

Gets or sets the VPP tone-mapping brightness.

Memberof

EncodingOptions

OptionalVppTonemappingContrast

VppTonemappingContrast?: number

Gets or sets the VPP tone-mapping contrast.

Memberof

EncodingOptions

Settings

Member Visibility

On This Page

Properties
AllowAv1EncodingAllowHevcEncodingAllowOnDemandMetadataBasedKeyframeExtractionForExtensionsDeinterlaceDoubleRateDeinterlaceMethodDownMixAudioBoostDownMixStereoAlgorithmEnableAudioVbrEnableDecodingColorDepth10HevcEnableDecodingColorDepth10HevcRextEnableDecodingColorDepth10Vp9EnableDecodingColorDepth12HevcRextEnableEnhancedNvdecDecoderEnableFallbackFontEnableHardwareEncodingEnableIntelLowPowerH264HwEncoderEnableIntelLowPowerHevcHwEncoderEnableSegmentDeletionEnableSubtitleExtractionEnableThrottlingEnableTonemappingEnableVideoToolboxTonemappingEnableVppTonemappingEncoderAppPathEncoderAppPathDisplayEncoderPresetEncodingThreadCountFallbackFontPathH264CrfH265CrfHardwareAccelerationTypeHardwareDecodingCodecsMaxMuxingQueueSizePreferSystemNativeHwDecoderQsvDeviceSegmentKeepSecondsThrottleDelaySecondsTonemappingAlgorithmTonemappingDesatTonemappingModeTonemappingParamTonemappingPeakTonemappingRangeTranscodingTempPathVaapiDeviceVppTonemappingBrightnessVppTonemappingContrast