software.amazon.awssdk.services.medialive.model

Interface Mpeg2Settings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Mpeg2Settings.Builder,Mpeg2Settings>, SdkBuilder<Mpeg2Settings.Builder,Mpeg2Settings>, SdkPojo

Enclosing class:

Mpeg2Settings

public static interface Mpeg2Settings.Builder
extends SdkPojo, CopyableBuilder<Mpeg2Settings.Builder,Mpeg2Settings>

Method Summary

Modifier and Type	Method and Description
Mpeg2Settings.Builder	adaptiveQuantization(Mpeg2AdaptiveQuantization adaptiveQuantization) Choose Off to disable adaptive quantization.
Mpeg2Settings.Builder	adaptiveQuantization(String adaptiveQuantization) Choose Off to disable adaptive quantization.
Mpeg2Settings.Builder	afdSignaling(AfdSignaling afdSignaling) Indicates the AFD values that MediaLive will write into the video encode.
Mpeg2Settings.Builder	afdSignaling(String afdSignaling) Indicates the AFD values that MediaLive will write into the video encode.
Mpeg2Settings.Builder	colorMetadata(Mpeg2ColorMetadata colorMetadata) Specifies whether to include the color space metadata.
Mpeg2Settings.Builder	colorMetadata(String colorMetadata) Specifies whether to include the color space metadata.
Mpeg2Settings.Builder	colorSpace(Mpeg2ColorSpace colorSpace) Choose the type of color space conversion to apply to the output.
Mpeg2Settings.Builder	colorSpace(String colorSpace) Choose the type of color space conversion to apply to the output.
Mpeg2Settings.Builder	displayAspectRatio(Mpeg2DisplayRatio displayAspectRatio) Sets the pixel aspect ratio for the encode.
Mpeg2Settings.Builder	displayAspectRatio(String displayAspectRatio) Sets the pixel aspect ratio for the encode.
default Mpeg2Settings.Builder	filterSettings(Consumer<Mpeg2FilterSettings.Builder> filterSettings) Optionally specify a noise reduction filter, which can improve quality of compressed content.
Mpeg2Settings.Builder	filterSettings(Mpeg2FilterSettings filterSettings) Optionally specify a noise reduction filter, which can improve quality of compressed content.
Mpeg2Settings.Builder	fixedAfd(FixedAfd fixedAfd) Complete this field only when afdSignaling is set to FIXED.
Mpeg2Settings.Builder	fixedAfd(String fixedAfd) Complete this field only when afdSignaling is set to FIXED.
Mpeg2Settings.Builder	framerateDenominator(Integer framerateDenominator) description": "The framerate denominator.
Mpeg2Settings.Builder	framerateNumerator(Integer framerateNumerator) The framerate numerator.
Mpeg2Settings.Builder	gopClosedCadence(Integer gopClosedCadence) MPEG2: default is open GOP.
Mpeg2Settings.Builder	gopNumBFrames(Integer gopNumBFrames) Relates to the GOP structure.
Mpeg2Settings.Builder	gopSize(Double gopSize) Relates to the GOP structure.
Mpeg2Settings.Builder	gopSizeUnits(Mpeg2GopSizeUnits gopSizeUnits) Relates to the GOP structure.
Mpeg2Settings.Builder	gopSizeUnits(String gopSizeUnits) Relates to the GOP structure.
Mpeg2Settings.Builder	scanType(Mpeg2ScanType scanType) Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).
Mpeg2Settings.Builder	scanType(String scanType) Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).
Mpeg2Settings.Builder	subgopLength(Mpeg2SubGopLength subgopLength) Relates to the GOP structure.
Mpeg2Settings.Builder	subgopLength(String subgopLength) Relates to the GOP structure.
Mpeg2Settings.Builder	timecodeInsertion(Mpeg2TimecodeInsertionBehavior timecodeInsertion) Determines how MediaLive inserts timecodes in the output video.
Mpeg2Settings.Builder	timecodeInsertion(String timecodeInsertion) Determines how MediaLive inserts timecodes in the output video.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

adaptiveQuantization

Mpeg2Settings.Builder adaptiveQuantization(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mpeg2AdaptiveQuantization, Mpeg2AdaptiveQuantization

adaptiveQuantization

Mpeg2Settings.Builder adaptiveQuantization(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mpeg2AdaptiveQuantization, Mpeg2AdaptiveQuantization

afdSignaling

Mpeg2Settings.Builder afdSignaling(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AfdSignaling, AfdSignaling

afdSignaling

Mpeg2Settings.Builder afdSignaling(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AfdSignaling, AfdSignaling

colorMetadata

Mpeg2Settings.Builder colorMetadata(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mpeg2ColorMetadata, Mpeg2ColorMetadata

colorMetadata

Mpeg2Settings.Builder colorMetadata(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mpeg2ColorMetadata, Mpeg2ColorMetadata

colorSpace

Mpeg2Settings.Builder colorSpace(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mpeg2ColorSpace, Mpeg2ColorSpace

colorSpace

Mpeg2Settings.Builder colorSpace(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mpeg2ColorSpace, Mpeg2ColorSpace

displayAspectRatio

Mpeg2Settings.Builder displayAspectRatio(String displayAspectRatio)

Sets the pixel aspect ratio for the encode.

Parameters:

displayAspectRatio - Sets the pixel aspect ratio for the encode.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mpeg2DisplayRatio, Mpeg2DisplayRatio

displayAspectRatio

Mpeg2Settings.Builder displayAspectRatio(Mpeg2DisplayRatio displayAspectRatio)

Sets the pixel aspect ratio for the encode.

Parameters:

displayAspectRatio - Sets the pixel aspect ratio for the encode.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mpeg2DisplayRatio, Mpeg2DisplayRatio

filterSettings

Mpeg2Settings.Builder filterSettings(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

filterSettings

default Mpeg2Settings.Builder filterSettings(Consumer<Mpeg2FilterSettings.Builder> 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. This is a convenience method that creates an instance of the Mpeg2FilterSettings.Builder avoiding the need to create one manually via Mpeg2FilterSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filterSettings(Mpeg2FilterSettings).

Parameters:

filterSettings - a consumer that will call methods on Mpeg2FilterSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

filterSettings(Mpeg2FilterSettings)

fixedAfd

Mpeg2Settings.Builder fixedAfd(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FixedAfd, FixedAfd

fixedAfd

Mpeg2Settings.Builder fixedAfd(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FixedAfd, FixedAfd

framerateDenominator

Mpeg2Settings.Builder framerateDenominator(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

framerateNumerator

Mpeg2Settings.Builder framerateNumerator(Integer framerateNumerator)

The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.

Parameters:

framerateNumerator - The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.

Returns:

Returns a reference to this object so that method calls can be chained together.

gopClosedCadence

Mpeg2Settings.Builder gopClosedCadence(Integer gopClosedCadence)

MPEG2: default is open GOP.

Parameters:

gopClosedCadence - MPEG2: default is open GOP.

Returns:

Returns a reference to this object so that method calls can be chained together.

gopNumBFrames

Mpeg2Settings.Builder gopNumBFrames(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

gopSize

Mpeg2Settings.Builder gopSize(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

gopSizeUnits

Mpeg2Settings.Builder gopSizeUnits(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mpeg2GopSizeUnits, Mpeg2GopSizeUnits

gopSizeUnits

Mpeg2Settings.Builder gopSizeUnits(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mpeg2GopSizeUnits, Mpeg2GopSizeUnits

scanType

Mpeg2Settings.Builder scanType(String scanType)

Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).

Parameters:

scanType - Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mpeg2ScanType, Mpeg2ScanType

scanType

Mpeg2Settings.Builder scanType(Mpeg2ScanType scanType)

Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).

Parameters:

scanType - Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mpeg2ScanType, Mpeg2ScanType

subgopLength

Mpeg2Settings.Builder subgopLength(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mpeg2SubGopLength, Mpeg2SubGopLength

subgopLength

Mpeg2Settings.Builder subgopLength(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mpeg2SubGopLength, Mpeg2SubGopLength

timecodeInsertion

Mpeg2Settings.Builder timecodeInsertion(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mpeg2TimecodeInsertionBehavior, Mpeg2TimecodeInsertionBehavior

timecodeInsertion

Mpeg2Settings.Builder timecodeInsertion(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mpeg2TimecodeInsertionBehavior, Mpeg2TimecodeInsertionBehavior