You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MediaConvert::Types::ColorCorrector

Inherits:

Struct

• Object
• Struct
• Aws::MediaConvert::Types::ColorCorrector

Defined in:

gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb

Overview

Note:

When making an API call, you may pass ColorCorrector data as a hash:

{
  brightness: 1,
  color_space_conversion: "NONE", # accepts NONE, FORCE_601, FORCE_709, FORCE_HDR10, FORCE_HLG_2020
  contrast: 1,
  hdr_10_metadata: {
    blue_primary_x: 1,
    blue_primary_y: 1,
    green_primary_x: 1,
    green_primary_y: 1,
    max_content_light_level: 1,
    max_frame_average_light_level: 1,
    max_luminance: 1,
    min_luminance: 1,
    red_primary_x: 1,
    red_primary_y: 1,
    white_point_x: 1,
    white_point_y: 1,
  },
  hue: 1,
  saturation: 1,
}

Settings for color correction.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #brightness ⇒ Integer

  Brightness level.

• #color_space_conversion ⇒ String

  Specify the color space you want for this output.

• #contrast ⇒ Integer

  Contrast level.

• #hdr_10_metadata ⇒ Types::Hdr10Metadata

  Use these settings when you convert to the HDR 10 color space.

• #hue ⇒ Integer

  Hue in degrees.

• #saturation ⇒ Integer

  Saturation level.

Instance Attribute Details

#brightness ⇒ Integer

Brightness level.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2132

class ColorCorrector < Struct.new(
  :brightness,
  :color_space_conversion,
  :contrast,
  :hdr_10_metadata,
  :hue,
  :saturation)
  include Aws::Structure
end

#color_space_conversion ⇒ String

Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, and from SDR to HDR. The service doesn't support conversion 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.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2132

class ColorCorrector < Struct.new(
  :brightness,
  :color_space_conversion,
  :contrast,
  :hdr_10_metadata,
  :hue,
  :saturation)
  include Aws::Structure
end

#contrast ⇒ Integer

Contrast level.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2132

class ColorCorrector < Struct.new(
  :brightness,
  :color_space_conversion,
  :contrast,
  :hdr_10_metadata,
  :hue,
  :saturation)
  include Aws::Structure
end

#hdr_10_metadata ⇒ Types::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:

• (Types::Hdr10Metadata)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2132

class ColorCorrector < Struct.new(
  :brightness,
  :color_space_conversion,
  :contrast,
  :hdr_10_metadata,
  :hue,
  :saturation)
  include Aws::Structure
end

#hue ⇒ Integer

Hue in degrees.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2132

class ColorCorrector < Struct.new(
  :brightness,
  :color_space_conversion,
  :contrast,
  :hdr_10_metadata,
  :hue,
  :saturation)
  include Aws::Structure
end

#saturation ⇒ Integer

Saturation level.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2132

class ColorCorrector < Struct.new(
  :brightness,
  :color_space_conversion,
  :contrast,
  :hdr_10_metadata,
  :hue,
  :saturation)
  include Aws::Structure
end