software.amazon.awssdk.services.mediaconvert.model

Interface ColorCorrector.Builder

All Superinterfaces:

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

Enclosing class:

ColorCorrector

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

Method Summary

Modifier and Type	Method and Description
ColorCorrector.Builder	brightness(Integer brightness) Brightness level.
ColorCorrector.Builder	clipLimits(ClipLimits clipLimits) Specify YUV limits and RGB tolerances when you set Sample range conversion to Limited range clip.
default ColorCorrector.Builder	clipLimits(Consumer<ClipLimits.Builder> clipLimits) Specify YUV limits and RGB tolerances when you set Sample range conversion to Limited range clip.
ColorCorrector.Builder	colorSpaceConversion(ColorSpaceConversion colorSpaceConversion) Specify the color space you want for this output.
ColorCorrector.Builder	colorSpaceConversion(String colorSpaceConversion) Specify the color space you want for this output.
ColorCorrector.Builder	contrast(Integer contrast) Contrast level.
default ColorCorrector.Builder	hdr10Metadata(Consumer<Hdr10Metadata.Builder> hdr10Metadata) Use these settings when you convert to the HDR 10 color space.
ColorCorrector.Builder	hdr10Metadata(Hdr10Metadata hdr10Metadata) Use these settings when you convert to the HDR 10 color space.
ColorCorrector.Builder	hdrToSdrToneMapper(HDRToSDRToneMapper hdrToSdrToneMapper) Specify how MediaConvert maps brightness and colors from your HDR input to your SDR output.
ColorCorrector.Builder	hdrToSdrToneMapper(String hdrToSdrToneMapper) Specify how MediaConvert maps brightness and colors from your HDR input to your SDR output.
ColorCorrector.Builder	hue(Integer hue) Hue in degrees.
ColorCorrector.Builder	sampleRangeConversion(SampleRangeConversion sampleRangeConversion) Specify how MediaConvert limits the color sample range for this output.
ColorCorrector.Builder	sampleRangeConversion(String sampleRangeConversion) Specify how MediaConvert limits the color sample range for this output.
ColorCorrector.Builder	saturation(Integer saturation) Saturation level.
ColorCorrector.Builder	sdrReferenceWhiteLevel(Integer sdrReferenceWhiteLevel) Specify the reference white level, in nits, for all of your SDR inputs.

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

brightness

ColorCorrector.Builder brightness(Integer brightness)

Brightness level.

Parameters:

brightness - Brightness level.

Returns:

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

clipLimits

ColorCorrector.Builder clipLimits(ClipLimits clipLimits)

Specify YUV limits and RGB tolerances when you set Sample range conversion to Limited range clip.

Parameters:

clipLimits - Specify YUV limits and RGB tolerances when you set Sample range conversion to Limited range clip.

Returns:

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

clipLimits

default ColorCorrector.Builder clipLimits(Consumer<ClipLimits.Builder> clipLimits)

Specify YUV limits and RGB tolerances when you set Sample range conversion to Limited range clip. This is a convenience method that creates an instance of the ClipLimits.Builder avoiding the need to create one manually via ClipLimits.builder().

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

Parameters:

clipLimits - a consumer that will call methods on ClipLimits.Builder

Returns:

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

See Also:

clipLimits(ClipLimits)

colorSpaceConversion

ColorCorrector.Builder colorSpaceConversion(String colorSpaceConversion)

Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, from SDR to HDR, and from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output. HDR to SDR conversion uses tone mapping to approximate the outcome of manually regrading from HDR to SDR. When you specify an output color space, MediaConvert uses the following color space metadata, which includes color primaries, transfer characteristics, and matrix coefficients: * HDR 10: BT.2020, PQ, BT.2020 non-constant * HLG 2020: BT.2020, HLG, BT.2020 non-constant * P3DCI (Theater): DCIP3, SMPTE 428M, BT.709 * P3D65 (SDR): Display P3, sRGB, BT.709 * P3D65 (HDR): Display P3, PQ, BT.709

Parameters:

colorSpaceConversion - Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, from SDR to HDR, and from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output. HDR to SDR conversion uses tone mapping to approximate the outcome of manually regrading from HDR to SDR. When you specify an output color space, MediaConvert uses the following color space metadata, which includes color primaries, transfer characteristics, and matrix coefficients: * HDR 10: BT.2020, PQ, BT.2020 non-constant * HLG 2020: BT.2020, HLG, BT.2020 non-constant * P3DCI (Theater): DCIP3, SMPTE 428M, BT.709 * P3D65 (SDR): Display P3, sRGB, BT.709 * P3D65 (HDR): Display P3, PQ, BT.709

Returns:

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

See Also:

ColorSpaceConversion, ColorSpaceConversion

colorSpaceConversion

ColorCorrector.Builder colorSpaceConversion(ColorSpaceConversion colorSpaceConversion)

Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, from SDR to HDR, and from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output. HDR to SDR conversion uses tone mapping to approximate the outcome of manually regrading from HDR to SDR. When you specify an output color space, MediaConvert uses the following color space metadata, which includes color primaries, transfer characteristics, and matrix coefficients: * HDR 10: BT.2020, PQ, BT.2020 non-constant * HLG 2020: BT.2020, HLG, BT.2020 non-constant * P3DCI (Theater): DCIP3, SMPTE 428M, BT.709 * P3D65 (SDR): Display P3, sRGB, BT.709 * P3D65 (HDR): Display P3, PQ, BT.709

Parameters:

colorSpaceConversion - Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, from SDR to HDR, and from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output. HDR to SDR conversion uses tone mapping to approximate the outcome of manually regrading from HDR to SDR. When you specify an output color space, MediaConvert uses the following color space metadata, which includes color primaries, transfer characteristics, and matrix coefficients: * HDR 10: BT.2020, PQ, BT.2020 non-constant * HLG 2020: BT.2020, HLG, BT.2020 non-constant * P3DCI (Theater): DCIP3, SMPTE 428M, BT.709 * P3D65 (SDR): Display P3, sRGB, BT.709 * P3D65 (HDR): Display P3, PQ, BT.709

Returns:

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

See Also:

ColorSpaceConversion, ColorSpaceConversion

contrast

ColorCorrector.Builder contrast(Integer contrast)

Contrast level.

Parameters:

contrast - Contrast level.

Returns:

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

hdr10Metadata

ColorCorrector.Builder hdr10Metadata(Hdr10Metadata hdr10Metadata)

Use these settings when you convert to the HDR 10 color space. Specify the SMPTE ST 2086 Mastering Display Color Volume static metadata that you want signaled in the output. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator. When you set Color space conversion (ColorSpaceConversion) to HDR 10 (FORCE_HDR10), these settings are required. You must set values for Max frame average light level (maxFrameAverageLightLevel) and Max content light level (maxContentLightLevel); these settings don't have a default value. The default values for the other HDR 10 metadata settings are defined by the P3D65 color space. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.

Parameters:

hdr10Metadata - Use these settings when you convert to the HDR 10 color space. Specify the SMPTE ST 2086 Mastering Display Color Volume static metadata that you want signaled in the output. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator. When you set Color space conversion (ColorSpaceConversion) to HDR 10 (FORCE_HDR10), these settings are required. You must set values for Max frame average light level (maxFrameAverageLightLevel) and Max content light level (maxContentLightLevel); these settings don't have a default value. The default values for the other HDR 10 metadata settings are defined by the P3D65 color space. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.

Returns:

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

hdr10Metadata

default ColorCorrector.Builder hdr10Metadata(Consumer<Hdr10Metadata.Builder> hdr10Metadata)

Use these settings when you convert to the HDR 10 color space. Specify the SMPTE ST 2086 Mastering Display Color Volume static metadata that you want signaled in the output. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator. When you set Color space conversion (ColorSpaceConversion) to HDR 10 (FORCE_HDR10), these settings are required. You must set values for Max frame average light level (maxFrameAverageLightLevel) and Max content light level (maxContentLightLevel); these settings don't have a default value. The default values for the other HDR 10 metadata settings are defined by the P3D65 color space. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr. This is a convenience method that creates an instance of the Hdr10Metadata.Builder avoiding the need to create one manually via Hdr10Metadata.builder().

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

Parameters:

hdr10Metadata - a consumer that will call methods on Hdr10Metadata.Builder

Returns:

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

See Also:

hdr10Metadata(Hdr10Metadata)

hdrToSdrToneMapper

ColorCorrector.Builder hdrToSdrToneMapper(String hdrToSdrToneMapper)

Specify how MediaConvert maps brightness and colors from your HDR input to your SDR output. The mode that you select represents a creative choice, with different tradeoffs in the details and tones of your output. To maintain details in bright or saturated areas of your output: Choose Preserve details. For some sources, your SDR output may look less bright and less saturated when compared to your HDR source. MediaConvert automatically applies this mode for HLG sources, regardless of your choice. For a bright and saturated output: Choose Vibrant. We recommend that you choose this mode when any of your source content is HDR10, and for the best results when it is mastered for 1000 nits. You may notice loss of details in bright or saturated areas of your output. HDR to SDR tone mapping has no effect when your input is SDR.

Parameters:

hdrToSdrToneMapper - Specify how MediaConvert maps brightness and colors from your HDR input to your SDR output. The mode that you select represents a creative choice, with different tradeoffs in the details and tones of your output. To maintain details in bright or saturated areas of your output: Choose Preserve details. For some sources, your SDR output may look less bright and less saturated when compared to your HDR source. MediaConvert automatically applies this mode for HLG sources, regardless of your choice. For a bright and saturated output: Choose Vibrant. We recommend that you choose this mode when any of your source content is HDR10, and for the best results when it is mastered for 1000 nits. You may notice loss of details in bright or saturated areas of your output. HDR to SDR tone mapping has no effect when your input is SDR.

Returns:

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

See Also:

HDRToSDRToneMapper, HDRToSDRToneMapper

hdrToSdrToneMapper

ColorCorrector.Builder hdrToSdrToneMapper(HDRToSDRToneMapper hdrToSdrToneMapper)

Specify how MediaConvert maps brightness and colors from your HDR input to your SDR output. The mode that you select represents a creative choice, with different tradeoffs in the details and tones of your output. To maintain details in bright or saturated areas of your output: Choose Preserve details. For some sources, your SDR output may look less bright and less saturated when compared to your HDR source. MediaConvert automatically applies this mode for HLG sources, regardless of your choice. For a bright and saturated output: Choose Vibrant. We recommend that you choose this mode when any of your source content is HDR10, and for the best results when it is mastered for 1000 nits. You may notice loss of details in bright or saturated areas of your output. HDR to SDR tone mapping has no effect when your input is SDR.

Parameters:

hdrToSdrToneMapper - Specify how MediaConvert maps brightness and colors from your HDR input to your SDR output. The mode that you select represents a creative choice, with different tradeoffs in the details and tones of your output. To maintain details in bright or saturated areas of your output: Choose Preserve details. For some sources, your SDR output may look less bright and less saturated when compared to your HDR source. MediaConvert automatically applies this mode for HLG sources, regardless of your choice. For a bright and saturated output: Choose Vibrant. We recommend that you choose this mode when any of your source content is HDR10, and for the best results when it is mastered for 1000 nits. You may notice loss of details in bright or saturated areas of your output. HDR to SDR tone mapping has no effect when your input is SDR.

Returns:

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

See Also:

HDRToSDRToneMapper, HDRToSDRToneMapper

hue

ColorCorrector.Builder hue(Integer hue)

Hue in degrees.

Parameters:

hue - Hue in degrees.

Returns:

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

sampleRangeConversion

ColorCorrector.Builder sampleRangeConversion(String sampleRangeConversion)

Specify how MediaConvert limits the color sample range for this output. To create a limited range output from a full range input: Choose Limited range squeeze. For full range inputs, MediaConvert performs a linear offset to color samples equally across all pixels and frames. Color samples in 10-bit outputs are limited to 64 through 940, and 8-bit outputs are limited to 16 through 235. Note: For limited range inputs, values for color samples are passed through to your output unchanged. MediaConvert does not limit the sample range. To correct pixels in your input that are out of range or out of gamut: Choose Limited range clip. Use for broadcast applications. MediaConvert conforms any pixels outside of the values that you specify under Minimum YUV and Maximum YUV to limited range bounds. MediaConvert also corrects any YUV values that, when converted to RGB, would be outside the bounds you specify under Minimum RGB tolerance and Maximum RGB tolerance. With either limited range conversion, MediaConvert writes the sample range metadata in the output.

Parameters:

sampleRangeConversion - Specify how MediaConvert limits the color sample range for this output. To create a limited range output from a full range input: Choose Limited range squeeze. For full range inputs, MediaConvert performs a linear offset to color samples equally across all pixels and frames. Color samples in 10-bit outputs are limited to 64 through 940, and 8-bit outputs are limited to 16 through 235. Note: For limited range inputs, values for color samples are passed through to your output unchanged. MediaConvert does not limit the sample range. To correct pixels in your input that are out of range or out of gamut: Choose Limited range clip. Use for broadcast applications. MediaConvert conforms any pixels outside of the values that you specify under Minimum YUV and Maximum YUV to limited range bounds. MediaConvert also corrects any YUV values that, when converted to RGB, would be outside the bounds you specify under Minimum RGB tolerance and Maximum RGB tolerance. With either limited range conversion, MediaConvert writes the sample range metadata in the output.

Returns:

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

See Also:

SampleRangeConversion, SampleRangeConversion

sampleRangeConversion

ColorCorrector.Builder sampleRangeConversion(SampleRangeConversion sampleRangeConversion)

Specify how MediaConvert limits the color sample range for this output. To create a limited range output from a full range input: Choose Limited range squeeze. For full range inputs, MediaConvert performs a linear offset to color samples equally across all pixels and frames. Color samples in 10-bit outputs are limited to 64 through 940, and 8-bit outputs are limited to 16 through 235. Note: For limited range inputs, values for color samples are passed through to your output unchanged. MediaConvert does not limit the sample range. To correct pixels in your input that are out of range or out of gamut: Choose Limited range clip. Use for broadcast applications. MediaConvert conforms any pixels outside of the values that you specify under Minimum YUV and Maximum YUV to limited range bounds. MediaConvert also corrects any YUV values that, when converted to RGB, would be outside the bounds you specify under Minimum RGB tolerance and Maximum RGB tolerance. With either limited range conversion, MediaConvert writes the sample range metadata in the output.

Parameters:

sampleRangeConversion - Specify how MediaConvert limits the color sample range for this output. To create a limited range output from a full range input: Choose Limited range squeeze. For full range inputs, MediaConvert performs a linear offset to color samples equally across all pixels and frames. Color samples in 10-bit outputs are limited to 64 through 940, and 8-bit outputs are limited to 16 through 235. Note: For limited range inputs, values for color samples are passed through to your output unchanged. MediaConvert does not limit the sample range. To correct pixels in your input that are out of range or out of gamut: Choose Limited range clip. Use for broadcast applications. MediaConvert conforms any pixels outside of the values that you specify under Minimum YUV and Maximum YUV to limited range bounds. MediaConvert also corrects any YUV values that, when converted to RGB, would be outside the bounds you specify under Minimum RGB tolerance and Maximum RGB tolerance. With either limited range conversion, MediaConvert writes the sample range metadata in the output.

Returns:

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

See Also:

SampleRangeConversion, SampleRangeConversion

saturation

ColorCorrector.Builder saturation(Integer saturation)

Saturation level.

Parameters:

saturation - Saturation level.

Returns:

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

sdrReferenceWhiteLevel

ColorCorrector.Builder sdrReferenceWhiteLevel(Integer sdrReferenceWhiteLevel)

Specify the reference white level, in nits, for all of your SDR inputs. Use to correct brightness levels within HDR10 outputs. The following color metadata must be present in your SDR input: color primaries, transfer characteristics, and matrix coefficients. If your SDR input has missing color metadata, or if you want to correct input color metadata, manually specify a color space in the input video selector. For 1,000 nit peak brightness displays, we recommend that you set SDR reference white level to 203 (according to ITU-R BT.2408). Leave blank to use the default value of 100, or specify an integer from 100 to 1000.

Parameters:

sdrReferenceWhiteLevel - Specify the reference white level, in nits, for all of your SDR inputs. Use to correct brightness levels within HDR10 outputs. The following color metadata must be present in your SDR input: color primaries, transfer characteristics, and matrix coefficients. If your SDR input has missing color metadata, or if you want to correct input color metadata, manually specify a color space in the input video selector. For 1,000 nit peak brightness displays, we recommend that you set SDR reference white level to 203 (according to ITU-R BT.2408). Leave blank to use the default value of 100, or specify an integer from 100 to 1000.

Returns:

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