Class EncodingConfig

java.lang.Object
software.amazon.awssdk.services.mediaconnect.model.EncodingConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EncodingConfig.Builder,EncodingConfig>
@Generated("software.amazon.awssdk:codegen") public final class EncodingConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EncodingConfig.Builder,EncodingConfig>

The encoding configuration to apply to the NDI® source when transcoding it to a transport stream for downstream distribution. You can choose between several predefined encoding profiles based on common use cases.

See Also:

  • Method Details

    • encodingProfile

      public final EncodingProfile encodingProfile()

      The encoding profile to use when transcoding the NDI source content to a transport stream. You can change this value while the flow is running.

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

      Returns:
      The encoding profile to use when transcoding the NDI source content to a transport stream. You can change this value while the flow is running.
      See Also:

    • encodingProfileAsString

      public final String encodingProfileAsString()

      The encoding profile to use when transcoding the NDI source content to a transport stream. You can change this value while the flow is running.

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

      Returns:
      The encoding profile to use when transcoding the NDI source content to a transport stream. You can change this value while the flow is running.
      See Also:

    • videoMaxBitrate

      public final Integer videoMaxBitrate()

      The maximum video bitrate to use when transcoding the NDI source to a transport stream. This parameter enables you to override the default video bitrate within the encoding profile's supported range.

      The supported range is 10,000,000 - 50,000,000 bits per second (bps). If you don't specify a value, MediaConnect uses the default value of 20,000,000 bps.

      Returns:
      The maximum video bitrate to use when transcoding the NDI source to a transport stream. This parameter enables you to override the default video bitrate within the encoding profile's supported range.

      The supported range is 10,000,000 - 50,000,000 bits per second (bps). If you don't specify a value, MediaConnect uses the default value of 20,000,000 bps.

    • toBuilder

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

    • builder

      public static EncodingConfig.Builder builder()

    • serializableBuilderClass

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