Class VideoCodecSettings

java.lang.Object
software.amazon.awssdk.services.mediaconvert.model.VideoCodecSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<VideoCodecSettings.Builder,VideoCodecSettings>

@Generated("software.amazon.awssdk:codegen") public final class VideoCodecSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VideoCodecSettings.Builder,VideoCodecSettings>
Video codec settings contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec. For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * GIF, GifSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * UNCOMPRESSED, UncompressedSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings
See Also:
  • Method Details

    • av1Settings

      public final Av1Settings av1Settings()
      Required when you set Codec, under VideoDescription>CodecSettings to the value AV1.
      Returns:
      Required when you set Codec, under VideoDescription>CodecSettings to the value AV1.
    • avcIntraSettings

      public final AvcIntraSettings avcIntraSettings()
      Required when you choose AVC-Intra for your output video codec. For more information about the AVC-Intra settings, see the relevant specification. For detailed information about SD and HD in AVC-Intra, see https://ieeexplore.ieee.org/document/7290936. For information about 4K/2K in AVC-Intra, see https://pro-av.panasonic.net/en/avc-ultra/AVC-ULTRAoverview.pdf.
      Returns:
      Required when you choose AVC-Intra for your output video codec. For more information about the AVC-Intra settings, see the relevant specification. For detailed information about SD and HD in AVC-Intra, see https://ieeexplore.ieee.org/document/7290936. For information about 4K/2K in AVC-Intra, see https://pro-av.panasonic.net/en/avc-ultra/AVC-ULTRAoverview.pdf.
    • codec

      public final VideoCodec codec()
      Specifies the video codec. This must be equal to one of the enum values defined by the object VideoCodec. To passthrough the video stream of your input without any video encoding: Choose Passthrough. More information about passthrough codec support and job settings requirements, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/video-passthrough-feature-restrictions.html

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

      Returns:
      Specifies the video codec. This must be equal to one of the enum values defined by the object VideoCodec. To passthrough the video stream of your input without any video encoding: Choose Passthrough. More information about passthrough codec support and job settings requirements, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/video-passthrough-feature-restrictions.html
      See Also:
    • codecAsString

      public final String codecAsString()
      Specifies the video codec. This must be equal to one of the enum values defined by the object VideoCodec. To passthrough the video stream of your input without any video encoding: Choose Passthrough. More information about passthrough codec support and job settings requirements, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/video-passthrough-feature-restrictions.html

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

      Returns:
      Specifies the video codec. This must be equal to one of the enum values defined by the object VideoCodec. To passthrough the video stream of your input without any video encoding: Choose Passthrough. More information about passthrough codec support and job settings requirements, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/video-passthrough-feature-restrictions.html
      See Also:
    • frameCaptureSettings

      public final FrameCaptureSettings frameCaptureSettings()
      Required when you set Codec to the value FRAME_CAPTURE.
      Returns:
      Required when you set Codec to the value FRAME_CAPTURE.
    • gifSettings

      public final GifSettings gifSettings()
      Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value GIF
      Returns:
      Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value GIF
    • h264Settings

      public final H264Settings h264Settings()
      Required when you set Codec to the value H_264.
      Returns:
      Required when you set Codec to the value H_264.
    • h265Settings

      public final H265Settings h265Settings()
      Settings for H265 codec
      Returns:
      Settings for H265 codec
    • mpeg2Settings

      public final Mpeg2Settings mpeg2Settings()
      Required when you set Codec to the value MPEG2.
      Returns:
      Required when you set Codec to the value MPEG2.
    • proresSettings

      public final ProresSettings proresSettings()
      Required when you set Codec to the value PRORES.
      Returns:
      Required when you set Codec to the value PRORES.
    • uncompressedSettings

      public final UncompressedSettings uncompressedSettings()
      Required when you set Codec, under VideoDescription>CodecSettings to the value UNCOMPRESSED.
      Returns:
      Required when you set Codec, under VideoDescription>CodecSettings to the value UNCOMPRESSED.
    • vc3Settings

      public final Vc3Settings vc3Settings()
      Required when you set Codec to the value VC3
      Returns:
      Required when you set Codec to the value VC3
    • vp8Settings

      public final Vp8Settings vp8Settings()
      Required when you set Codec to the value VP8.
      Returns:
      Required when you set Codec to the value VP8.
    • vp9Settings

      public final Vp9Settings vp9Settings()
      Required when you set Codec to the value VP9.
      Returns:
      Required when you set Codec to the value VP9.
    • xavcSettings

      public final XavcSettings xavcSettings()
      Required when you set Codec to the value XAVC.
      Returns:
      Required when you set Codec to the value XAVC.
    • toBuilder

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

      public static VideoCodecSettings.Builder builder()
    • serializableBuilderClass

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