ColorCorrector (AWS Java SDK :: Services :: AWS Elemental MediaConvert 2.18.21 API)

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`<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()`
`Integer`	`sdrReferenceWhiteLevel()` Specify the reference white level, in nits, for all of your SDR inputs.
`static Class<? extends ColorCorrector.Builder>`	`serializableBuilderClass()`
`ColorCorrector.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
  - 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. Select Force P3D65 (SDR) to set the output color space metadata to the following: * Color primaries: Display P3 * Transfer characteristics: SMPTE 428M * Matrix coefficients: BT.709
    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. Select Force P3D65 (SDR) to set the output color space metadata to the following: * Color primaries: Display P3 * Transfer characteristics: SMPTE 428M * Matrix coefficients: BT.709
    
    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. Select Force P3D65 (SDR) to set the output color space metadata to the following: * Color primaries: Display P3 * Transfer characteristics: SMPTE 428M * Matrix coefficients: BT.709
    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. Select Force P3D65 (SDR) to set the output color space metadata to the following: * Color primaries: Display P3 * Transfer characteristics: SMPTE 428M * Matrix coefficients: BT.709
    
    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.
  - sdrReferenceWhiteLevel
```
public final 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.
    
    Returns:
    
    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.
  - toBuilder
```
public ColorCorrector.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ColorCorrector.Builder,ColorCorrector>
  - 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)
```
    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 ColorCorrector

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

brightness

colorSpaceConversion

colorSpaceConversionAsString

contrast

hdr10Metadata

hue

sampleRangeConversion

sampleRangeConversionAsString

saturation

sdrReferenceWhiteLevel

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields