Mpeg2Settings (AWS Java SDK :: Services :: AWS Elemental MediaLive 2.18.21 API)

java.lang.Object
- software.amazon.awssdk.services.medialive.model.Mpeg2Settings

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Mpeg2Settings.Builder,Mpeg2Settings>

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

Mpeg2 Settings

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Mpeg2Settings.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Mpeg2Settings.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Mpeg2AdaptiveQuantization`	`adaptiveQuantization()` Choose Off to disable adaptive quantization.
`String`	`adaptiveQuantizationAsString()` Choose Off to disable adaptive quantization.
`AfdSignaling`	`afdSignaling()` Indicates the AFD values that MediaLive will write into the video encode.
`String`	`afdSignalingAsString()` Indicates the AFD values that MediaLive will write into the video encode.
`static Mpeg2Settings.Builder`	`builder()`
`Mpeg2ColorMetadata`	`colorMetadata()` Specifies whether to include the color space metadata.
`String`	`colorMetadataAsString()` Specifies whether to include the color space metadata.
`Mpeg2ColorSpace`	`colorSpace()` Choose the type of color space conversion to apply to the output.
`String`	`colorSpaceAsString()` Choose the type of color space conversion to apply to the output.
`Mpeg2DisplayRatio`	`displayAspectRatio()` Sets the pixel aspect ratio for the encode.
`String`	`displayAspectRatioAsString()` Sets the pixel aspect ratio for the encode.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Mpeg2FilterSettings`	`filterSettings()` Optionally specify a noise reduction filter, which can improve quality of compressed content.
`FixedAfd`	`fixedAfd()` Complete this field only when afdSignaling is set to FIXED.
`String`	`fixedAfdAsString()` Complete this field only when afdSignaling is set to FIXED.
`Integer`	`framerateDenominator()` description": "The framerate denominator.
`Integer`	`framerateNumerator()` The framerate numerator.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`Integer`	`gopClosedCadence()` MPEG2: default is open GOP.
`Integer`	`gopNumBFrames()` Relates to the GOP structure.
`Double`	`gopSize()` Relates to the GOP structure.
`Mpeg2GopSizeUnits`	`gopSizeUnits()` Relates to the GOP structure.
`String`	`gopSizeUnitsAsString()` Relates to the GOP structure.
`int`	`hashCode()`
`Mpeg2ScanType`	`scanType()` Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).
`String`	`scanTypeAsString()` Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Mpeg2Settings.Builder>`	`serializableBuilderClass()`
`Mpeg2SubGopLength`	`subgopLength()` Relates to the GOP structure.
`String`	`subgopLengthAsString()` Relates to the GOP structure.
`Mpeg2TimecodeInsertionBehavior`	`timecodeInsertion()` Determines how MediaLive inserts timecodes in the output video.
`String`	`timecodeInsertionAsString()` Determines how MediaLive inserts timecodes in the output video.
`Mpeg2Settings.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
  - adaptiveQuantization
```
public final Mpeg2AdaptiveQuantization adaptiveQuantization()
```
    Choose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality.
    If the service returns an enum value that is not available in the current SDK version, adaptiveQuantization will return Mpeg2AdaptiveQuantization.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from adaptiveQuantizationAsString().
    
    Returns:
    
    Choose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality.
    
    See Also:
    
    Mpeg2AdaptiveQuantization
  - adaptiveQuantizationAsString
```
public final String adaptiveQuantizationAsString()
```
    Choose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality.
    If the service returns an enum value that is not available in the current SDK version, adaptiveQuantization will return Mpeg2AdaptiveQuantization.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from adaptiveQuantizationAsString().
    
    Returns:
    
    Choose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality.
    
    See Also:
    
    Mpeg2AdaptiveQuantization
  - afdSignaling
```
public final AfdSignaling afdSignaling()
```
    Indicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO. AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid). FIXED: MediaLive will use the value you specify in fixedAFD.
    If the service returns an enum value that is not available in the current SDK version, afdSignaling will return AfdSignaling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from afdSignalingAsString().
    
    Returns:
    
    Indicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO. AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid). FIXED: MediaLive will use the value you specify in fixedAFD.
    
    See Also:
    
    AfdSignaling
  - afdSignalingAsString
```
public final String afdSignalingAsString()
```
    Indicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO. AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid). FIXED: MediaLive will use the value you specify in fixedAFD.
    If the service returns an enum value that is not available in the current SDK version, afdSignaling will return AfdSignaling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from afdSignalingAsString().
    
    Returns:
    
    Indicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO. AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid). FIXED: MediaLive will use the value you specify in fixedAFD.
    
    See Also:
    
    AfdSignaling
  - colorMetadata
```
public final Mpeg2ColorMetadata colorMetadata()
```
    Specifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata.
    If the service returns an enum value that is not available in the current SDK version, colorMetadata will return Mpeg2ColorMetadata.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from colorMetadataAsString().
    
    Returns:
    
    Specifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata.
    
    See Also:
    
    Mpeg2ColorMetadata
  - colorMetadataAsString
```
public final String colorMetadataAsString()
```
    Specifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata.
    If the service returns an enum value that is not available in the current SDK version, colorMetadata will return Mpeg2ColorMetadata.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from colorMetadataAsString().
    
    Returns:
    
    Specifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata.
    
    See Also:
    
    Mpeg2ColorMetadata
  - colorSpace
```
public final Mpeg2ColorSpace colorSpace()
```
    Choose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on \"MediaLive Features - Video - color space\" in the MediaLive User Guide. PASSTHROUGH: Keep the color space of the input content - do not convert it. AUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709.
    If the service returns an enum value that is not available in the current SDK version, colorSpace will return Mpeg2ColorSpace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from colorSpaceAsString().
    
    Returns:
    
    Choose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on \"MediaLive Features - Video - color space\" in the MediaLive User Guide. PASSTHROUGH: Keep the color space of the input content - do not convert it. AUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709.
    
    See Also:
    
    Mpeg2ColorSpace
  - colorSpaceAsString
```
public final String colorSpaceAsString()
```
    Choose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on \"MediaLive Features - Video - color space\" in the MediaLive User Guide. PASSTHROUGH: Keep the color space of the input content - do not convert it. AUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709.
    If the service returns an enum value that is not available in the current SDK version, colorSpace will return Mpeg2ColorSpace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from colorSpaceAsString().
    
    Returns:
    
    Choose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on \"MediaLive Features - Video - color space\" in the MediaLive User Guide. PASSTHROUGH: Keep the color space of the input content - do not convert it. AUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709.
    
    See Also:
    
    Mpeg2ColorSpace
  - displayAspectRatio
```
public final Mpeg2DisplayRatio displayAspectRatio()
```
    Sets the pixel aspect ratio for the encode.
    If the service returns an enum value that is not available in the current SDK version, displayAspectRatio will return Mpeg2DisplayRatio.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from displayAspectRatioAsString().
    
    Returns:
    
    Sets the pixel aspect ratio for the encode.
    
    See Also:
    
    Mpeg2DisplayRatio
  - displayAspectRatioAsString
```
public final String displayAspectRatioAsString()
```
    Sets the pixel aspect ratio for the encode.
    If the service returns an enum value that is not available in the current SDK version, displayAspectRatio will return Mpeg2DisplayRatio.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from displayAspectRatioAsString().
    
    Returns:
    
    Sets the pixel aspect ratio for the encode.
    
    See Also:
    
    Mpeg2DisplayRatio
  - filterSettings
```
public final Mpeg2FilterSettings filterSettings()
```
    Optionally specify a noise reduction filter, which can improve quality of compressed content. If you do not choose a filter, no filter will be applied. TEMPORAL: This filter is useful for both source content that is noisy (when it has excessive digital artifacts) and source content that is clean. When the content is noisy, the filter cleans up the source content before the encoding phase, with these two effects: First, it improves the output video quality because the content has been cleaned up. Secondly, it decreases the bandwidth because MediaLive does not waste bits on encoding noise. When the content is reasonably clean, the filter tends to decrease the bitrate.
    
    Returns:
    
    Optionally specify a noise reduction filter, which can improve quality of compressed content. If you do not choose a filter, no filter will be applied. TEMPORAL: This filter is useful for both source content that is noisy (when it has excessive digital artifacts) and source content that is clean. When the content is noisy, the filter cleans up the source content before the encoding phase, with these two effects: First, it improves the output video quality because the content has been cleaned up. Secondly, it decreases the bandwidth because MediaLive does not waste bits on encoding noise. When the content is reasonably clean, the filter tends to decrease the bitrate.
  - fixedAfd
```
public final FixedAfd fixedAfd()
```
    Complete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode.
    If the service returns an enum value that is not available in the current SDK version, fixedAfd will return FixedAfd.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fixedAfdAsString().
    
    Returns:
    
    Complete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode.
    
    See Also:
    
    FixedAfd
  - fixedAfdAsString
```
public final String fixedAfdAsString()
```
    Complete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode.
    If the service returns an enum value that is not available in the current SDK version, fixedAfd will return FixedAfd.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fixedAfdAsString().
    
    Returns:
    
    Complete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode.
    
    See Also:
    
    FixedAfd
  - framerateDenominator
```
public final Integer framerateDenominator()
```
    description": "The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.
    
    Returns:
    
    description": "The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.
  - framerateNumerator
```
public final Integer framerateNumerator()
```
    The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.
    
    Returns:
    
    The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.
  - gopClosedCadence
```
public final Integer gopClosedCadence()
```
    MPEG2: default is open GOP.
    
    Returns:
    
    MPEG2: default is open GOP.
  - gopNumBFrames
```
public final Integer gopNumBFrames()
```
    Relates to the GOP structure. The number of B-frames between reference frames. If you do not know what a B-frame is, use the default.
    
    Returns:
    
    Relates to the GOP structure. The number of B-frames between reference frames. If you do not know what a B-frame is, use the default.
  - gopSize
```
public final Double gopSize()
```
    Relates to the GOP structure. The GOP size (keyframe interval) in the units specified in gopSizeUnits. If you do not know what GOP is, use the default. If gopSizeUnits is frames, then the gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, the gopSize must be greater than 0, but does not need to be an integer.
    
    Returns:
    
    Relates to the GOP structure. The GOP size (keyframe interval) in the units specified in gopSizeUnits. If you do not know what GOP is, use the default. If gopSizeUnits is frames, then the gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, the gopSize must be greater than 0, but does not need to be an integer.
  - gopSizeUnits
```
public final Mpeg2GopSizeUnits gopSizeUnits()
```
    Relates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count.
    If the service returns an enum value that is not available in the current SDK version, gopSizeUnits will return Mpeg2GopSizeUnits.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gopSizeUnitsAsString().
    
    Returns:
    
    Relates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count.
    
    See Also:
    
    Mpeg2GopSizeUnits
  - gopSizeUnitsAsString
```
public final String gopSizeUnitsAsString()
```
    Relates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count.
    If the service returns an enum value that is not available in the current SDK version, gopSizeUnits will return Mpeg2GopSizeUnits.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gopSizeUnitsAsString().
    
    Returns:
    
    Relates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count.
    
    See Also:
    
    Mpeg2GopSizeUnits
  - scanType
```
public final Mpeg2ScanType scanType()
```
    Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).
    If the service returns an enum value that is not available in the current SDK version, scanType will return Mpeg2ScanType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scanTypeAsString().
    
    Returns:
    
    Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).
    
    See Also:
    
    Mpeg2ScanType
  - scanTypeAsString
```
public final String scanTypeAsString()
```
    Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).
    If the service returns an enum value that is not available in the current SDK version, scanType will return Mpeg2ScanType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scanTypeAsString().
    
    Returns:
    
    Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).
    
    See Also:
    
    Mpeg2ScanType
  - subgopLength
```
public final Mpeg2SubGopLength subgopLength()
```
    Relates to the GOP structure. If you do not know what GOP is, use the default. FIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames. DYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality.
    If the service returns an enum value that is not available in the current SDK version, subgopLength will return Mpeg2SubGopLength.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subgopLengthAsString().
    
    Returns:
    
    Relates to the GOP structure. If you do not know what GOP is, use the default. FIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames. DYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality.
    
    See Also:
    
    Mpeg2SubGopLength
  - subgopLengthAsString
```
public final String subgopLengthAsString()
```
    Relates to the GOP structure. If you do not know what GOP is, use the default. FIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames. DYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality.
    If the service returns an enum value that is not available in the current SDK version, subgopLength will return Mpeg2SubGopLength.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subgopLengthAsString().
    
    Returns:
    
    Relates to the GOP structure. If you do not know what GOP is, use the default. FIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames. DYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality.
    
    See Also:
    
    Mpeg2SubGopLength
  - timecodeInsertion
```
public final Mpeg2TimecodeInsertionBehavior timecodeInsertion()
```
    Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \"MediaLive Features - Timecode configuration\" in the MediaLive User Guide. DISABLED: do not include timecodes. GOP_TIMECODE: Include timecode metadata in the GOP header.
    If the service returns an enum value that is not available in the current SDK version, timecodeInsertion will return Mpeg2TimecodeInsertionBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timecodeInsertionAsString().
    
    Returns:
    
    Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \"MediaLive Features - Timecode configuration\" in the MediaLive User Guide. DISABLED: do not include timecodes. GOP_TIMECODE: Include timecode metadata in the GOP header.
    
    See Also:
    
    Mpeg2TimecodeInsertionBehavior
  - timecodeInsertionAsString
```
public final String timecodeInsertionAsString()
```
    Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \"MediaLive Features - Timecode configuration\" in the MediaLive User Guide. DISABLED: do not include timecodes. GOP_TIMECODE: Include timecode metadata in the GOP header.
    If the service returns an enum value that is not available in the current SDK version, timecodeInsertion will return Mpeg2TimecodeInsertionBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timecodeInsertionAsString().
    
    Returns:
    
    Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \"MediaLive Features - Timecode configuration\" in the MediaLive User Guide. DISABLED: do not include timecodes. GOP_TIMECODE: Include timecode metadata in the GOP header.
    
    See Also:
    
    Mpeg2TimecodeInsertionBehavior
  - toBuilder
```
public Mpeg2Settings.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Mpeg2Settings.Builder,Mpeg2Settings>
  - builder
```
public static Mpeg2Settings.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Mpeg2Settings.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

Class Mpeg2Settings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

adaptiveQuantization

adaptiveQuantizationAsString

afdSignaling

afdSignalingAsString

colorMetadata

colorMetadataAsString

colorSpace

colorSpaceAsString

displayAspectRatio

displayAspectRatioAsString

filterSettings

fixedAfd

fixedAfdAsString

framerateDenominator

framerateNumerator

gopClosedCadence

gopNumBFrames

gopSize

gopSizeUnits

gopSizeUnitsAsString

scanType

scanTypeAsString

subgopLength

subgopLengthAsString

timecodeInsertion

timecodeInsertionAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields