jellyfin-model/org.jellyfin.sdk.model.api/EncodingOptions

EncodingOptions

@Serializable

data class EncodingOptions(val encodingThreadCount: Int, val transcodingTempPath: String? = null, val fallbackFontPath: String? = null, val enableFallbackFont: Boolean, val enableAudioVbr: Boolean, val downMixAudioBoost: Double, val downMixStereoAlgorithm: DownMixStereoAlgorithms, val maxMuxingQueueSize: Int, val enableThrottling: Boolean, val throttleDelaySeconds: Int, val enableSegmentDeletion: Boolean, val segmentKeepSeconds: Int, val hardwareAccelerationType: HardwareAccelerationType, val encoderAppPath: String? = null, val encoderAppPathDisplay: String? = null, val vaapiDevice: String? = null, val qsvDevice: String? = null, val enableTonemapping: Boolean, val enableVppTonemapping: Boolean, val enableVideoToolboxTonemapping: Boolean, val tonemappingAlgorithm: TonemappingAlgorithm, val tonemappingMode: TonemappingMode, val tonemappingRange: TonemappingRange, val tonemappingDesat: Double, val tonemappingPeak: Double, val tonemappingParam: Double, val vppTonemappingBrightness: Double, val vppTonemappingContrast: Double, val h264Crf: Int, val h265Crf: Int, val encoderPreset: EncoderPreset? = null, val deinterlaceDoubleRate: Boolean, val deinterlaceMethod: DeinterlaceMethod, val enableDecodingColorDepth10Hevc: Boolean, val enableDecodingColorDepth10Vp9: Boolean, val enableDecodingColorDepth10HevcRext: Boolean, val enableDecodingColorDepth12HevcRext: Boolean, val enableEnhancedNvdecDecoder: Boolean, val preferSystemNativeHwDecoder: Boolean, val enableIntelLowPowerH264HwEncoder: Boolean, val enableIntelLowPowerHevcHwEncoder: Boolean, val enableHardwareEncoding: Boolean, val allowHevcEncoding: Boolean, val allowAv1Encoding: Boolean, val enableSubtitleExtraction: Boolean, val hardwareDecodingCodecs: List<String>? = null, val allowOnDemandMetadataBasedKeyframeExtractionForExtensions: List<String>? = null)

Class EncodingOptions.

Constructors

EncodingOptions

constructor(encodingThreadCount: Int, transcodingTempPath: String? = null, fallbackFontPath: String? = null, enableFallbackFont: Boolean, enableAudioVbr: Boolean, downMixAudioBoost: Double, downMixStereoAlgorithm: DownMixStereoAlgorithms, maxMuxingQueueSize: Int, enableThrottling: Boolean, throttleDelaySeconds: Int, enableSegmentDeletion: Boolean, segmentKeepSeconds: Int, hardwareAccelerationType: HardwareAccelerationType, encoderAppPath: String? = null, encoderAppPathDisplay: String? = null, vaapiDevice: String? = null, qsvDevice: String? = null, enableTonemapping: Boolean, enableVppTonemapping: Boolean, enableVideoToolboxTonemapping: Boolean, tonemappingAlgorithm: TonemappingAlgorithm, tonemappingMode: TonemappingMode, tonemappingRange: TonemappingRange, tonemappingDesat: Double, tonemappingPeak: Double, tonemappingParam: Double, vppTonemappingBrightness: Double, vppTonemappingContrast: Double, h264Crf: Int, h265Crf: Int, encoderPreset: EncoderPreset? = null, deinterlaceDoubleRate: Boolean, deinterlaceMethod: DeinterlaceMethod, enableDecodingColorDepth10Hevc: Boolean, enableDecodingColorDepth10Vp9: Boolean, enableDecodingColorDepth10HevcRext: Boolean, enableDecodingColorDepth12HevcRext: Boolean, enableEnhancedNvdecDecoder: Boolean, preferSystemNativeHwDecoder: Boolean, enableIntelLowPowerH264HwEncoder: Boolean, enableIntelLowPowerHevcHwEncoder: Boolean, enableHardwareEncoding: Boolean, allowHevcEncoding: Boolean, allowAv1Encoding: Boolean, enableSubtitleExtraction: Boolean, hardwareDecodingCodecs: List<String>? = null, allowOnDemandMetadataBasedKeyframeExtractionForExtensions: List<String>? = null)

Properties

allowAv1Encoding

@SerialName(value = "AllowAv1Encoding")

val allowAv1Encoding: Boolean

A value indicating whether AV1 encoding is enabled.

allowHevcEncoding

@SerialName(value = "AllowHevcEncoding")

val allowHevcEncoding: Boolean

A value indicating whether HEVC encoding is enabled.

allowOnDemandMetadataBasedKeyframeExtractionForExtensions

@SerialName(value = "AllowOnDemandMetadataBasedKeyframeExtractionForExtensions")

val allowOnDemandMetadataBasedKeyframeExtractionForExtensions: List<String>?

The file extensions on-demand metadata based keyframe extraction is enabled for.

deinterlaceDoubleRate

@SerialName(value = "DeinterlaceDoubleRate")

val deinterlaceDoubleRate: Boolean

A value indicating whether the framerate is doubled when deinterlacing.

deinterlaceMethod

@SerialName(value = "DeinterlaceMethod")

val deinterlaceMethod: DeinterlaceMethod

The deinterlace method.

downMixAudioBoost

@SerialName(value = "DownMixAudioBoost")

val downMixAudioBoost: Double

The audio boost applied when downmixing audio.

downMixStereoAlgorithm

@SerialName(value = "DownMixStereoAlgorithm")

val downMixStereoAlgorithm: DownMixStereoAlgorithms

The algorithm used for downmixing audio to stereo.

enableAudioVbr

@SerialName(value = "EnableAudioVbr")

val enableAudioVbr: Boolean

A value indicating whether audio VBR is enabled.

enableDecodingColorDepth10Hevc

@SerialName(value = "EnableDecodingColorDepth10Hevc")

val enableDecodingColorDepth10Hevc: Boolean

A value indicating whether 10bit HEVC decoding is enabled.

enableDecodingColorDepth10HevcRext

@SerialName(value = "EnableDecodingColorDepth10HevcRext")

val enableDecodingColorDepth10HevcRext: Boolean

A value indicating whether 8/10bit HEVC RExt decoding is enabled.

enableDecodingColorDepth10Vp9

@SerialName(value = "EnableDecodingColorDepth10Vp9")

val enableDecodingColorDepth10Vp9: Boolean

A value indicating whether 10bit VP9 decoding is enabled.

enableDecodingColorDepth12HevcRext

@SerialName(value = "EnableDecodingColorDepth12HevcRext")

val enableDecodingColorDepth12HevcRext: Boolean

A value indicating whether 12bit HEVC RExt decoding is enabled.

enableEnhancedNvdecDecoder

@SerialName(value = "EnableEnhancedNvdecDecoder")

val enableEnhancedNvdecDecoder: Boolean

A value indicating whether the enhanced NVDEC is enabled.

enableFallbackFont

@SerialName(value = "EnableFallbackFont")

val enableFallbackFont: Boolean

A value indicating whether to use the fallback font.

enableHardwareEncoding

@SerialName(value = "EnableHardwareEncoding")

val enableHardwareEncoding: Boolean

A value indicating whether hardware encoding is enabled.

enableIntelLowPowerH264HwEncoder

@SerialName(value = "EnableIntelLowPowerH264HwEncoder")

val enableIntelLowPowerH264HwEncoder: Boolean

A value indicating whether the Intel H264 low-power hardware encoder should be used.

enableIntelLowPowerHevcHwEncoder

@SerialName(value = "EnableIntelLowPowerHevcHwEncoder")

val enableIntelLowPowerHevcHwEncoder: Boolean

A value indicating whether the Intel HEVC low-power hardware encoder should be used.

enableSegmentDeletion

@SerialName(value = "EnableSegmentDeletion")

val enableSegmentDeletion: Boolean

A value indicating whether segment deletion is enabled.

enableSubtitleExtraction

@SerialName(value = "EnableSubtitleExtraction")

val enableSubtitleExtraction: Boolean

A value indicating whether subtitle extraction is enabled.

enableThrottling

@SerialName(value = "EnableThrottling")

val enableThrottling: Boolean

A value indicating whether throttling is enabled.

enableTonemapping

@SerialName(value = "EnableTonemapping")

val enableTonemapping: Boolean

A value indicating whether tonemapping is enabled.

enableVideoToolboxTonemapping

@SerialName(value = "EnableVideoToolboxTonemapping")

val enableVideoToolboxTonemapping: Boolean

A value indicating whether videotoolbox tonemapping is enabled.

enableVppTonemapping

@SerialName(value = "EnableVppTonemapping")

val enableVppTonemapping: Boolean

A value indicating whether VPP tonemapping is enabled.

encoderAppPath

@SerialName(value = "EncoderAppPath")

val encoderAppPath: String?

The FFmpeg path as set by the user via the UI.

encoderAppPathDisplay

@SerialName(value = "EncoderAppPathDisplay")

val encoderAppPathDisplay: String?

The current FFmpeg path being used by the system and displayed on the transcode page.

encoderPreset

@SerialName(value = "EncoderPreset")

val encoderPreset: EncoderPreset?

The encoder preset.

encodingThreadCount

@SerialName(value = "EncodingThreadCount")

val encodingThreadCount: Int

The thread count used for encoding.

fallbackFontPath

@SerialName(value = "FallbackFontPath")

val fallbackFontPath: String?

The path to the fallback font.

h264Crf

@SerialName(value = "H264Crf")

val h264Crf: Int

The H264 CRF.

h265Crf

@SerialName(value = "H265Crf")

val h265Crf: Int

The H265 CRF.

hardwareAccelerationType

@SerialName(value = "HardwareAccelerationType")

val hardwareAccelerationType: HardwareAccelerationType

The hardware acceleration type.

hardwareDecodingCodecs

@SerialName(value = "HardwareDecodingCodecs")

val hardwareDecodingCodecs: List<String>?

The codecs hardware encoding is used for.

maxMuxingQueueSize

@SerialName(value = "MaxMuxingQueueSize")

val maxMuxingQueueSize: Int

The maximum size of the muxing queue.

preferSystemNativeHwDecoder

@SerialName(value = "PreferSystemNativeHwDecoder")

val preferSystemNativeHwDecoder: Boolean

A value indicating whether the system native hardware decoder should be used.

qsvDevice

@SerialName(value = "QsvDevice")

val qsvDevice: String?

The QSV device.

segmentKeepSeconds

@SerialName(value = "SegmentKeepSeconds")

val segmentKeepSeconds: Int

Seconds for which segments should be kept before being deleted.

throttleDelaySeconds

@SerialName(value = "ThrottleDelaySeconds")

val throttleDelaySeconds: Int

The delay after which throttling happens.

tonemappingAlgorithm

@SerialName(value = "TonemappingAlgorithm")

val tonemappingAlgorithm: TonemappingAlgorithm

The tone-mapping algorithm.

tonemappingDesat

@SerialName(value = "TonemappingDesat")

val tonemappingDesat: Double

The tone-mapping desaturation.

tonemappingMode

@SerialName(value = "TonemappingMode")

val tonemappingMode: TonemappingMode

The tone-mapping mode.

tonemappingParam

@SerialName(value = "TonemappingParam")

val tonemappingParam: Double

The tone-mapping parameters.

tonemappingPeak

@SerialName(value = "TonemappingPeak")

val tonemappingPeak: Double

The tone-mapping peak.

tonemappingRange

@SerialName(value = "TonemappingRange")

val tonemappingRange: TonemappingRange

The tone-mapping range.

transcodingTempPath

@SerialName(value = "TranscodingTempPath")

val transcodingTempPath: String?

The temporary transcoding path.

vaapiDevice

@SerialName(value = "VaapiDevice")

val vaapiDevice: String?

The VA-API device.

vppTonemappingBrightness

@SerialName(value = "VppTonemappingBrightness")

val vppTonemappingBrightness: Double

The VPP tone-mapping brightness.

vppTonemappingContrast

@SerialName(value = "VppTonemappingContrast")

val vppTonemappingContrast: Double

The VPP tone-mapping contrast.