software.amazon.awssdk.services.mediaconvert.model

Class ColorCorrector

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.ColorCorrector

All Implemented Interfaces:

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

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

Settings for color correction.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ColorCorrector.Builder

Method Summary

Modifier and Type	Method and Description
Integer	brightness() Brightness level.
static ColorCorrector.Builder	builder()
ColorSpaceConversion	colorSpaceConversion() Specify the color space you want for this output.
String	colorSpaceConversionAsString() Specify the color space you want for this output.
Integer	contrast() Contrast level.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Hdr10Metadata	hdr10Metadata() Use these settings when you convert to the HDR 10 color space.
Integer	hue() Hue in degrees.
SampleRangeConversion	sampleRangeConversion() Specify the video color sample range for this output.
String	sampleRangeConversionAsString() Specify the video color sample range for this output.
Integer	saturation() Saturation level.
List<SdkField<?>>	sdkFields()
static Class<? extends ColorCorrector.Builder>	serializableBuilderClass()
ColorCorrector.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

brightness

public final Integer brightness()

Brightness level.

Returns:

Brightness level.

colorSpaceConversion

public final 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 Elemental tone mapping technology to approximate the outcome of manually regrading from HDR to SDR.

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

Returns:

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 Elemental tone mapping technology to approximate the outcome of manually regrading from HDR to SDR.

See Also:

ColorSpaceConversion

colorSpaceConversionAsString

public final String colorSpaceConversionAsString()

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 Elemental tone mapping technology to approximate the outcome of manually regrading from HDR to SDR.

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

Returns:

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 Elemental tone mapping technology to approximate the outcome of manually regrading from HDR to SDR.

See Also:

ColorSpaceConversion

contrast

public final Integer contrast()

Contrast level.

Returns:

Contrast level.

hdr10Metadata

public final 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.

Returns:

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.

hue

public final Integer hue()

Hue in degrees.

Returns:

Hue in degrees.

sampleRangeConversion

public final SampleRangeConversion sampleRangeConversion()

Specify the video color sample range for this output. To create a full range output, you must start with a full range YUV input and keep the default value, None (NONE). To create a limited range output from a full range input, choose Limited range (LIMITED_RANGE_SQUEEZE). With RGB inputs, your output is always limited range, regardless of your choice here. When you create a limited range output from a full range input, MediaConvert limits the active pixel values in a way that depends on the output's bit depth: 8-bit outputs contain only values from 16 through 235 and 10-bit outputs contain only values from 64 through 940. With this conversion, MediaConvert also changes the output metadata to note the limited range.

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

Returns:

Specify the video color sample range for this output. To create a full range output, you must start with a full range YUV input and keep the default value, None (NONE). To create a limited range output from a full range input, choose Limited range (LIMITED_RANGE_SQUEEZE). With RGB inputs, your output is always limited range, regardless of your choice here. When you create a limited range output from a full range input, MediaConvert limits the active pixel values in a way that depends on the output's bit depth: 8-bit outputs contain only values from 16 through 235 and 10-bit outputs contain only values from 64 through 940. With this conversion, MediaConvert also changes the output metadata to note the limited range.

See Also:

SampleRangeConversion

sampleRangeConversionAsString

public final String sampleRangeConversionAsString()

Specify the video color sample range for this output. To create a full range output, you must start with a full range YUV input and keep the default value, None (NONE). To create a limited range output from a full range input, choose Limited range (LIMITED_RANGE_SQUEEZE). With RGB inputs, your output is always limited range, regardless of your choice here. When you create a limited range output from a full range input, MediaConvert limits the active pixel values in a way that depends on the output's bit depth: 8-bit outputs contain only values from 16 through 235 and 10-bit outputs contain only values from 64 through 940. With this conversion, MediaConvert also changes the output metadata to note the limited range.

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

Returns:

Specify the video color sample range for this output. To create a full range output, you must start with a full range YUV input and keep the default value, None (NONE). To create a limited range output from a full range input, choose Limited range (LIMITED_RANGE_SQUEEZE). With RGB inputs, your output is always limited range, regardless of your choice here. When you create a limited range output from a full range input, MediaConvert limits the active pixel values in a way that depends on the output's bit depth: 8-bit outputs contain only values from 16 through 235 and 10-bit outputs contain only values from 64 through 940. With this conversion, MediaConvert also changes the output metadata to note the limited range.

See Also:

SampleRangeConversion

saturation

public final Integer saturation()

Saturation level.

Returns:

Saturation level.

toBuilder

public ColorCorrector.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ColorCorrector.Builder,ColorCorrector>

Returns:

a builder for type T

builder

public static ColorCorrector.Builder builder()

serializableBuilderClass

public static Class<? extends ColorCorrector.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.