Class CodecMetadata

java.lang.Object
software.amazon.awssdk.services.mediaconvert.model.CodecMetadata
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CodecMetadata.Builder,CodecMetadata>
@Generated("software.amazon.awssdk:codegen") public final class CodecMetadata extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CodecMetadata.Builder,CodecMetadata>
Codec-specific parameters parsed from the video essence headers. This information provides detailed technical specifications about how the video was encoded, including profile settings, resolution details, and color space information that can help you understand the source video characteristics and make informed encoding decisions.
See Also:

  • Method Details

    • bitDepth

      public final Integer bitDepth()
      The number of bits used per color component in the video essence such as 8, 10, or 12 bits. Standard range (SDR) video typically uses 8-bit, while 10-bit is common for high dynamic range (HDR).
      Returns:
      The number of bits used per color component in the video essence such as 8, 10, or 12 bits. Standard range (SDR) video typically uses 8-bit, while 10-bit is common for high dynamic range (HDR).

    • chromaSubsampling

      public final String chromaSubsampling()
      The chroma subsampling format used in the video encoding, such as "4:2:0" or "4:4:4". This describes how color information is sampled relative to brightness information. Different subsampling ratios affect video quality and file size, with "4:4:4" providing the highest color fidelity and "4:2:0" being most common for standard video.
      Returns:
      The chroma subsampling format used in the video encoding, such as "4:2:0" or "4:4:4". This describes how color information is sampled relative to brightness information. Different subsampling ratios affect video quality and file size, with "4:4:4" providing the highest color fidelity and "4:2:0" being most common for standard video.

    • codedFrameRate

      public final FrameRate codedFrameRate()
      The frame rate of the video or audio track, expressed as a fraction with numerator and denominator values.
      Returns:
      The frame rate of the video or audio track, expressed as a fraction with numerator and denominator values.

    • colorPrimaries

      public final ColorPrimaries colorPrimaries()
      The color space primaries of the video track, defining the red, green, and blue color coordinates used for the video. This information helps ensure accurate color reproduction during playback and transcoding.

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

      Returns:
      The color space primaries of the video track, defining the red, green, and blue color coordinates used for the video. This information helps ensure accurate color reproduction during playback and transcoding.
      See Also:

    • colorPrimariesAsString

      public final String colorPrimariesAsString()
      The color space primaries of the video track, defining the red, green, and blue color coordinates used for the video. This information helps ensure accurate color reproduction during playback and transcoding.

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

      Returns:
      The color space primaries of the video track, defining the red, green, and blue color coordinates used for the video. This information helps ensure accurate color reproduction during playback and transcoding.
      See Also:

    • height

      public final Integer height()
      The height in pixels as coded by the codec. This represents the actual encoded video height as specified in the video stream headers.
      Returns:
      The height in pixels as coded by the codec. This represents the actual encoded video height as specified in the video stream headers.

    • level

      public final String level()
      The codec level or tier that specifies the maximum processing requirements and capabilities. Levels define constraints such as maximum bit rate, frame rate, and resolution.
      Returns:
      The codec level or tier that specifies the maximum processing requirements and capabilities. Levels define constraints such as maximum bit rate, frame rate, and resolution.

    • matrixCoefficients

      public final MatrixCoefficients matrixCoefficients()
      The color space matrix coefficients of the video track, defining how RGB color values are converted to and from YUV color space. This affects color accuracy during encoding and decoding processes.

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

      Returns:
      The color space matrix coefficients of the video track, defining how RGB color values are converted to and from YUV color space. This affects color accuracy during encoding and decoding processes.
      See Also:

    • matrixCoefficientsAsString

      public final String matrixCoefficientsAsString()
      The color space matrix coefficients of the video track, defining how RGB color values are converted to and from YUV color space. This affects color accuracy during encoding and decoding processes.

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

      Returns:
      The color space matrix coefficients of the video track, defining how RGB color values are converted to and from YUV color space. This affects color accuracy during encoding and decoding processes.
      See Also:

    • profile

      public final String profile()
      The codec profile used to encode the video. Profiles define specific feature sets and capabilities within a codec standard. For example, H.264 profiles include Baseline, Main, and High, each supporting different encoding features and complexity levels.
      Returns:
      The codec profile used to encode the video. Profiles define specific feature sets and capabilities within a codec standard. For example, H.264 profiles include Baseline, Main, and High, each supporting different encoding features and complexity levels.

    • scanType

      public final String scanType()
      The scanning method specified in the video essence, indicating whether the video uses progressive or interlaced scanning.
      Returns:
      The scanning method specified in the video essence, indicating whether the video uses progressive or interlaced scanning.

    • transferCharacteristics

      public final TransferCharacteristics transferCharacteristics()
      The color space transfer characteristics of the video track, defining the relationship between linear light values and the encoded signal values. This affects brightness and contrast reproduction.

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

      Returns:
      The color space transfer characteristics of the video track, defining the relationship between linear light values and the encoded signal values. This affects brightness and contrast reproduction.
      See Also:

    • transferCharacteristicsAsString

      public final String transferCharacteristicsAsString()
      The color space transfer characteristics of the video track, defining the relationship between linear light values and the encoded signal values. This affects brightness and contrast reproduction.

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

      Returns:
      The color space transfer characteristics of the video track, defining the relationship between linear light values and the encoded signal values. This affects brightness and contrast reproduction.
      See Also:

    • width

      public final Integer width()
      The width in pixels as coded by the codec. This represents the actual encoded video width as specified in the video stream headers.
      Returns:
      The width in pixels as coded by the codec. This represents the actual encoded video width as specified in the video stream headers.

    • toBuilder

      public CodecMetadata.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<CodecMetadata.Builder,CodecMetadata>
      Returns:
      a builder for type T

    • builder

      public static CodecMetadata.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.