software.amazon.awssdk.services.mediaconvert.model

Class XavcHdProfileSettings

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.XavcHdProfileSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<XavcHdProfileSettings.Builder,XavcHdProfileSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class XavcHdProfileSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<XavcHdProfileSettings.Builder,XavcHdProfileSettings>

Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVC_HD.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XavcHdProfileSettings.Builder

Method Summary

Modifier and Type	Method and Description
XavcHdProfileBitrateClass	bitrateClass() Specify the XAVC HD (Long GOP) Bitrate Class to set the bitrate of your output.
String	bitrateClassAsString() Specify the XAVC HD (Long GOP) Bitrate Class to set the bitrate of your output.
static XavcHdProfileSettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
XavcFlickerAdaptiveQuantization	flickerAdaptiveQuantization() The best way to set up adaptive quantization is to keep the default value, Auto (AUTO), for the setting Adaptive quantization (XavcAdaptiveQuantization).
String	flickerAdaptiveQuantizationAsString() The best way to set up adaptive quantization is to keep the default value, Auto (AUTO), for the setting Adaptive quantization (XavcAdaptiveQuantization).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
XavcGopBReference	gopBReference() Specify whether the encoder uses B-frames as reference frames for other pictures in the same GOP.
String	gopBReferenceAsString() Specify whether the encoder uses B-frames as reference frames for other pictures in the same GOP.
Integer	gopClosedCadence() Frequency of closed GOPs.
int	hashCode()
Integer	hrdBufferSize() Specify the size of the buffer that MediaConvert uses in the HRD buffer model for this output.
XavcInterlaceMode	interlaceMode() Choose the scan line type for the output.
String	interlaceModeAsString() Choose the scan line type for the output.
XavcHdProfileQualityTuningLevel	qualityTuningLevel() Optional.
String	qualityTuningLevelAsString() Optional.
List<SdkField<?>>	sdkFields()
static Class<? extends XavcHdProfileSettings.Builder>	serializableBuilderClass()
Integer	slices() Number of slices per picture.
XavcHdProfileTelecine	telecine() Ignore this setting unless you set Frame rate (framerateNumerator divided by framerateDenominator) to 29.970.
String	telecineAsString() Ignore this setting unless you set Frame rate (framerateNumerator divided by framerateDenominator) to 29.970.
XavcHdProfileSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

bitrateClass

public final XavcHdProfileBitrateClass bitrateClass()

Specify the XAVC HD (Long GOP) Bitrate Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points that are valid for that class.

If the service returns an enum value that is not available in the current SDK version, bitrateClass will return XavcHdProfileBitrateClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bitrateClassAsString().

Returns:

Specify the XAVC HD (Long GOP) Bitrate Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points that are valid for that class.

See Also:

XavcHdProfileBitrateClass

bitrateClassAsString

public final String bitrateClassAsString()

Specify the XAVC HD (Long GOP) Bitrate Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points that are valid for that class.

If the service returns an enum value that is not available in the current SDK version, bitrateClass will return XavcHdProfileBitrateClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bitrateClassAsString().

Returns:

Specify the XAVC HD (Long GOP) Bitrate Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points that are valid for that class.

See Also:

XavcHdProfileBitrateClass

flickerAdaptiveQuantization

public final XavcFlickerAdaptiveQuantization flickerAdaptiveQuantization()

The best way to set up adaptive quantization is to keep the default value, Auto (AUTO), for the setting Adaptive quantization (XavcAdaptiveQuantization). When you do so, MediaConvert automatically applies the best types of quantization for your video content. Include this setting in your JSON job specification only when you choose to change the default value for Adaptive quantization. Enable this setting to have the encoder reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. This setting is disabled by default. Related setting: In addition to enabling this setting, you must also set Adaptive quantization (adaptiveQuantization) to a value other than Off (OFF) or Auto (AUTO). Use Adaptive quantization to adjust the degree of smoothing that Flicker adaptive quantization provides.

If the service returns an enum value that is not available in the current SDK version, flickerAdaptiveQuantization will return XavcFlickerAdaptiveQuantization.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from flickerAdaptiveQuantizationAsString().

Returns:

The best way to set up adaptive quantization is to keep the default value, Auto (AUTO), for the setting Adaptive quantization (XavcAdaptiveQuantization). When you do so, MediaConvert automatically applies the best types of quantization for your video content. Include this setting in your JSON job specification only when you choose to change the default value for Adaptive quantization. Enable this setting to have the encoder reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. This setting is disabled by default. Related setting: In addition to enabling this setting, you must also set Adaptive quantization (adaptiveQuantization) to a value other than Off (OFF) or Auto (AUTO). Use Adaptive quantization to adjust the degree of smoothing that Flicker adaptive quantization provides.

See Also:

XavcFlickerAdaptiveQuantization

flickerAdaptiveQuantizationAsString

public final String flickerAdaptiveQuantizationAsString()

The best way to set up adaptive quantization is to keep the default value, Auto (AUTO), for the setting Adaptive quantization (XavcAdaptiveQuantization). When you do so, MediaConvert automatically applies the best types of quantization for your video content. Include this setting in your JSON job specification only when you choose to change the default value for Adaptive quantization. Enable this setting to have the encoder reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. This setting is disabled by default. Related setting: In addition to enabling this setting, you must also set Adaptive quantization (adaptiveQuantization) to a value other than Off (OFF) or Auto (AUTO). Use Adaptive quantization to adjust the degree of smoothing that Flicker adaptive quantization provides.

If the service returns an enum value that is not available in the current SDK version, flickerAdaptiveQuantization will return XavcFlickerAdaptiveQuantization.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from flickerAdaptiveQuantizationAsString().

Returns:

The best way to set up adaptive quantization is to keep the default value, Auto (AUTO), for the setting Adaptive quantization (XavcAdaptiveQuantization). When you do so, MediaConvert automatically applies the best types of quantization for your video content. Include this setting in your JSON job specification only when you choose to change the default value for Adaptive quantization. Enable this setting to have the encoder reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. This setting is disabled by default. Related setting: In addition to enabling this setting, you must also set Adaptive quantization (adaptiveQuantization) to a value other than Off (OFF) or Auto (AUTO). Use Adaptive quantization to adjust the degree of smoothing that Flicker adaptive quantization provides.

See Also:

XavcFlickerAdaptiveQuantization

gopBReference

public final XavcGopBReference gopBReference()

Specify whether the encoder uses B-frames as reference frames for other pictures in the same GOP. Choose Allow (ENABLED) to allow the encoder to use B-frames as reference frames. Choose Don't allow (DISABLED) to prevent the encoder from using B-frames as reference frames.

If the service returns an enum value that is not available in the current SDK version, gopBReference will return XavcGopBReference.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gopBReferenceAsString().

Returns:

Specify whether the encoder uses B-frames as reference frames for other pictures in the same GOP. Choose Allow (ENABLED) to allow the encoder to use B-frames as reference frames. Choose Don't allow (DISABLED) to prevent the encoder from using B-frames as reference frames.

See Also:

XavcGopBReference

gopBReferenceAsString

public final String gopBReferenceAsString()

Specify whether the encoder uses B-frames as reference frames for other pictures in the same GOP. Choose Allow (ENABLED) to allow the encoder to use B-frames as reference frames. Choose Don't allow (DISABLED) to prevent the encoder from using B-frames as reference frames.

If the service returns an enum value that is not available in the current SDK version, gopBReference will return XavcGopBReference.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gopBReferenceAsString().

Returns:

Specify whether the encoder uses B-frames as reference frames for other pictures in the same GOP. Choose Allow (ENABLED) to allow the encoder to use B-frames as reference frames. Choose Don't allow (DISABLED) to prevent the encoder from using B-frames as reference frames.

See Also:

XavcGopBReference

gopClosedCadence

public final Integer gopClosedCadence()

Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.

Returns:

Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.

hrdBufferSize

public final Integer hrdBufferSize()

Specify the size of the buffer that MediaConvert uses in the HRD buffer model for this output. Specify this value in bits; for example, enter five megabits as 5000000. When you don't set this value, or you set it to zero, MediaConvert calculates the default by doubling the bitrate of this output point.

Returns:

Specify the size of the buffer that MediaConvert uses in the HRD buffer model for this output. Specify this value in bits; for example, enter five megabits as 5000000. When you don't set this value, or you set it to zero, MediaConvert calculates the default by doubling the bitrate of this output point.

interlaceMode

public final XavcInterlaceMode interlaceMode()

Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) 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.

If the service returns an enum value that is not available in the current SDK version, interlaceMode will return XavcInterlaceMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from interlaceModeAsString().

Returns:

Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) 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.

See Also:

XavcInterlaceMode

interlaceModeAsString

public final String interlaceModeAsString()

Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) 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.

If the service returns an enum value that is not available in the current SDK version, interlaceMode will return XavcInterlaceMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from interlaceModeAsString().

Returns:

Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) 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.

See Also:

XavcInterlaceMode

qualityTuningLevel

public final XavcHdProfileQualityTuningLevel qualityTuningLevel()

Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.

If the service returns an enum value that is not available in the current SDK version, qualityTuningLevel will return XavcHdProfileQualityTuningLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from qualityTuningLevelAsString().

Returns:

Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.

See Also:

XavcHdProfileQualityTuningLevel

qualityTuningLevelAsString

public final String qualityTuningLevelAsString()

Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.

If the service returns an enum value that is not available in the current SDK version, qualityTuningLevel will return XavcHdProfileQualityTuningLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from qualityTuningLevelAsString().

Returns:

Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.

See Also:

XavcHdProfileQualityTuningLevel

slices

public final Integer slices()

Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.

Returns:

Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.

telecine

public final XavcHdProfileTelecine telecine()

Ignore this setting unless you set Frame rate (framerateNumerator divided by framerateDenominator) to 29.970. If your input framerate is 23.976, choose Hard (HARD). Otherwise, keep the default value None (NONE). For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-telecine-and-inverse-telecine.html.

If the service returns an enum value that is not available in the current SDK version, telecine will return XavcHdProfileTelecine.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from telecineAsString().

Returns:

Ignore this setting unless you set Frame rate (framerateNumerator divided by framerateDenominator) to 29.970. If your input framerate is 23.976, choose Hard (HARD). Otherwise, keep the default value None (NONE). For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-telecine-and-inverse-telecine.html.

See Also:

XavcHdProfileTelecine

telecineAsString

public final String telecineAsString()

Ignore this setting unless you set Frame rate (framerateNumerator divided by framerateDenominator) to 29.970. If your input framerate is 23.976, choose Hard (HARD). Otherwise, keep the default value None (NONE). For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-telecine-and-inverse-telecine.html.

If the service returns an enum value that is not available in the current SDK version, telecine will return XavcHdProfileTelecine.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from telecineAsString().

Returns:

Ignore this setting unless you set Frame rate (framerateNumerator divided by framerateDenominator) to 29.970. If your input framerate is 23.976, choose Hard (HARD). Otherwise, keep the default value None (NONE). For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-telecine-and-inverse-telecine.html.

See Also:

XavcHdProfileTelecine

toBuilder

public XavcHdProfileSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<XavcHdProfileSettings.Builder,XavcHdProfileSettings>

builder

public static XavcHdProfileSettings.Builder builder()

serializableBuilderClass

public static Class<? extends XavcHdProfileSettings.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo