commonMain.aws.sdk.kotlin.services.mediaconvert.model.AvcIntraSettings.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mediaconvert-jvm Show documentation
Show all versions of mediaconvert-jvm Show documentation
The AWS SDK for Kotlin client for MediaConvert
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.mediaconvert.model
import aws.smithy.kotlin.runtime.SdkDsl
/**
* Required when you choose AVC-Intra for your output video codec. For more information about the AVC-Intra settings, see the relevant specification. For detailed information about SD and HD in AVC-Intra, see https://ieeexplore.ieee.org/document/7290936. For information about 4K/2K in AVC-Intra, see https://pro-av.panasonic.net/en/avc-ultra/AVC-ULTRAoverview.pdf.
*/
public class AvcIntraSettings private constructor(builder: Builder) {
/**
* Specify the AVC-Intra class of your output. The AVC-Intra class selection determines the output video bit rate depending on the frame rate of the output. Outputs with higher class values have higher bitrates and improved image quality. Note that for Class 4K/2K, MediaConvert supports only 4:2:2 chroma subsampling.
*/
public val avcIntraClass: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraClass? = builder.avcIntraClass
/**
* Optional when you set AVC-Intra class to Class 4K/2K. When you set AVC-Intra class to a different value, this object isn't allowed.
*/
public val avcIntraUhdSettings: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraUhdSettings? = builder.avcIntraUhdSettings
/**
* If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction.
*/
public val framerateControl: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraFramerateControl? = builder.framerateControl
/**
* Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96.
*/
public val framerateConversionAlgorithm: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraFramerateConversionAlgorithm? = builder.framerateConversionAlgorithm
/**
* When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.
*/
public val framerateDenominator: kotlin.Int? = builder.framerateDenominator
/**
* When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.
*/
public val framerateNumerator: kotlin.Int? = builder.framerateNumerator
/**
* Choose the scan line type for the output. Keep the default value, Progressive to create a progressive output, regardless of the scan type of your input. Use Top field first or Bottom field first to create an output that's interlaced with the same field polarity throughout. Use Follow, default top or Follow, default bottom to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.
*/
public val interlaceMode: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraInterlaceMode? = builder.interlaceMode
/**
* Use this setting for interlaced outputs, when your output frame rate is half of your input frame rate. In this situation, choose Optimized interlacing to create a better quality interlaced output. In this case, each progressive frame from the input corresponds to an interlaced field in the output. Keep the default value, Basic interlacing, for all other output frame rates. With basic interlacing, MediaConvert performs any frame rate conversion first and then interlaces the frames. When you choose Optimized interlacing and you set your output frame rate to a value that isn't suitable for optimized interlacing, MediaConvert automatically falls back to basic interlacing. Required settings: To use optimized interlacing, you must set Telecine to None or Soft. You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode to a value other than Progressive.
*/
public val scanTypeConversionMode: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraScanTypeConversionMode? = builder.scanTypeConversionMode
/**
* Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25.
*/
public val slowPal: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraSlowPal? = builder.slowPal
/**
* When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard telecine to create a smoother picture. When you keep the default value, None, MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.
*/
public val telecine: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraTelecine? = builder.telecine
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.mediaconvert.model.AvcIntraSettings = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("AvcIntraSettings(")
append("avcIntraClass=$avcIntraClass,")
append("avcIntraUhdSettings=$avcIntraUhdSettings,")
append("framerateControl=$framerateControl,")
append("framerateConversionAlgorithm=$framerateConversionAlgorithm,")
append("framerateDenominator=$framerateDenominator,")
append("framerateNumerator=$framerateNumerator,")
append("interlaceMode=$interlaceMode,")
append("scanTypeConversionMode=$scanTypeConversionMode,")
append("slowPal=$slowPal,")
append("telecine=$telecine")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = avcIntraClass?.hashCode() ?: 0
result = 31 * result + (avcIntraUhdSettings?.hashCode() ?: 0)
result = 31 * result + (framerateControl?.hashCode() ?: 0)
result = 31 * result + (framerateConversionAlgorithm?.hashCode() ?: 0)
result = 31 * result + (framerateDenominator ?: 0)
result = 31 * result + (framerateNumerator ?: 0)
result = 31 * result + (interlaceMode?.hashCode() ?: 0)
result = 31 * result + (scanTypeConversionMode?.hashCode() ?: 0)
result = 31 * result + (slowPal?.hashCode() ?: 0)
result = 31 * result + (telecine?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as AvcIntraSettings
if (avcIntraClass != other.avcIntraClass) return false
if (avcIntraUhdSettings != other.avcIntraUhdSettings) return false
if (framerateControl != other.framerateControl) return false
if (framerateConversionAlgorithm != other.framerateConversionAlgorithm) return false
if (framerateDenominator != other.framerateDenominator) return false
if (framerateNumerator != other.framerateNumerator) return false
if (interlaceMode != other.interlaceMode) return false
if (scanTypeConversionMode != other.scanTypeConversionMode) return false
if (slowPal != other.slowPal) return false
if (telecine != other.telecine) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.mediaconvert.model.AvcIntraSettings = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* Specify the AVC-Intra class of your output. The AVC-Intra class selection determines the output video bit rate depending on the frame rate of the output. Outputs with higher class values have higher bitrates and improved image quality. Note that for Class 4K/2K, MediaConvert supports only 4:2:2 chroma subsampling.
*/
public var avcIntraClass: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraClass? = null
/**
* Optional when you set AVC-Intra class to Class 4K/2K. When you set AVC-Intra class to a different value, this object isn't allowed.
*/
public var avcIntraUhdSettings: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraUhdSettings? = null
/**
* If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction.
*/
public var framerateControl: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraFramerateControl? = null
/**
* Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96.
*/
public var framerateConversionAlgorithm: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraFramerateConversionAlgorithm? = null
/**
* When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.
*/
public var framerateDenominator: kotlin.Int? = null
/**
* When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.
*/
public var framerateNumerator: kotlin.Int? = null
/**
* Choose the scan line type for the output. Keep the default value, Progressive to create a progressive output, regardless of the scan type of your input. Use Top field first or Bottom field first to create an output that's interlaced with the same field polarity throughout. Use Follow, default top or Follow, default bottom to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.
*/
public var interlaceMode: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraInterlaceMode? = null
/**
* Use this setting for interlaced outputs, when your output frame rate is half of your input frame rate. In this situation, choose Optimized interlacing to create a better quality interlaced output. In this case, each progressive frame from the input corresponds to an interlaced field in the output. Keep the default value, Basic interlacing, for all other output frame rates. With basic interlacing, MediaConvert performs any frame rate conversion first and then interlaces the frames. When you choose Optimized interlacing and you set your output frame rate to a value that isn't suitable for optimized interlacing, MediaConvert automatically falls back to basic interlacing. Required settings: To use optimized interlacing, you must set Telecine to None or Soft. You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode to a value other than Progressive.
*/
public var scanTypeConversionMode: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraScanTypeConversionMode? = null
/**
* Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25.
*/
public var slowPal: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraSlowPal? = null
/**
* When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard telecine to create a smoother picture. When you keep the default value, None, MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.
*/
public var telecine: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraTelecine? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraSettings) : this() {
this.avcIntraClass = x.avcIntraClass
this.avcIntraUhdSettings = x.avcIntraUhdSettings
this.framerateControl = x.framerateControl
this.framerateConversionAlgorithm = x.framerateConversionAlgorithm
this.framerateDenominator = x.framerateDenominator
this.framerateNumerator = x.framerateNumerator
this.interlaceMode = x.interlaceMode
this.scanTypeConversionMode = x.scanTypeConversionMode
this.slowPal = x.slowPal
this.telecine = x.telecine
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.mediaconvert.model.AvcIntraSettings = AvcIntraSettings(this)
/**
* construct an [aws.sdk.kotlin.services.mediaconvert.model.AvcIntraUhdSettings] inside the given [block]
*/
public fun avcIntraUhdSettings(block: aws.sdk.kotlin.services.mediaconvert.model.AvcIntraUhdSettings.Builder.() -> kotlin.Unit) {
this.avcIntraUhdSettings = aws.sdk.kotlin.services.mediaconvert.model.AvcIntraUhdSettings.invoke(block)
}
internal fun correctErrors(): Builder {
return this
}
}
}