Package software.amazon.awssdk.services.mediaconvert.model

Class FrameCaptureSettings

java.lang.Object
software.amazon.awssdk.services.mediaconvert.model.FrameCaptureSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FrameCaptureSettings.Builder,FrameCaptureSettings>
@Generated("software.amazon.awssdk:codegen") public final class FrameCaptureSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FrameCaptureSettings.Builder,FrameCaptureSettings>
Required when you set Codec to the value FRAME_CAPTURE.
See Also:

  • Method Details

    • framerateDenominator

      public final Integer framerateDenominator()
      Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.
      Returns:
      Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.

    • framerateNumerator

      public final Integer framerateNumerator()
      Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.
      Returns:
      Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.

    • maxCaptures

      public final Integer maxCaptures()
      Maximum number of captures (encoded jpg output files).
      Returns:
      Maximum number of captures (encoded jpg output files).

    • quality

      public final Integer quality()
      JPEG Quality - a higher value equals higher quality.
      Returns:
      JPEG Quality - a higher value equals higher quality.

    • toBuilder

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

    • builder

      public static FrameCaptureSettings.Builder builder()

    • serializableBuilderClass

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