Class InputDeviceConfigurableSettings

java.lang.Object
software.amazon.awssdk.services.medialive.model.InputDeviceConfigurableSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InputDeviceConfigurableSettings.Builder,InputDeviceConfigurableSettings>
@Generated("software.amazon.awssdk:codegen") public final class InputDeviceConfigurableSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InputDeviceConfigurableSettings.Builder,InputDeviceConfigurableSettings>
Configurable settings for the input device.
See Also:

  • Method Details

    • configuredInput

      public final InputDeviceConfiguredInput configuredInput()
      The input source that you want to use. If the device has a source connected to only one of its input ports, or if you don't care which source the device sends, specify Auto. If the device has sources connected to both its input ports, and you want to use a specific source, specify the source.

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

      Returns:
      The input source that you want to use. If the device has a source connected to only one of its input ports, or if you don't care which source the device sends, specify Auto. If the device has sources connected to both its input ports, and you want to use a specific source, specify the source.
      See Also:

    • configuredInputAsString

      public final String configuredInputAsString()
      The input source that you want to use. If the device has a source connected to only one of its input ports, or if you don't care which source the device sends, specify Auto. If the device has sources connected to both its input ports, and you want to use a specific source, specify the source.

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

      Returns:
      The input source that you want to use. If the device has a source connected to only one of its input ports, or if you don't care which source the device sends, specify Auto. If the device has sources connected to both its input ports, and you want to use a specific source, specify the source.
      See Also:

    • maxBitrate

      public final Integer maxBitrate()
      The maximum bitrate in bits per second. Set a value here to throttle the bitrate of the source video.
      Returns:
      The maximum bitrate in bits per second. Set a value here to throttle the bitrate of the source video.

    • latencyMs

      public final Integer latencyMs()
      The Link device's buffer size (latency) in milliseconds (ms).
      Returns:
      The Link device's buffer size (latency) in milliseconds (ms).

    • codec

      public final InputDeviceCodec codec()
      Choose the codec for the video that the device produces. Only UHD devices can specify this parameter.

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

      Returns:
      Choose the codec for the video that the device produces. Only UHD devices can specify this parameter.
      See Also:

    • codecAsString

      public final String codecAsString()
      Choose the codec for the video that the device produces. Only UHD devices can specify this parameter.

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

      Returns:
      Choose the codec for the video that the device produces. Only UHD devices can specify this parameter.
      See Also:

    • mediaconnectSettings

      public final InputDeviceMediaConnectConfigurableSettings mediaconnectSettings()
      To attach this device to a MediaConnect flow, specify these parameters. To detach an existing flow, enter {} for the value of mediaconnectSettings. Only UHD devices can specify this parameter.
      Returns:
      To attach this device to a MediaConnect flow, specify these parameters. To detach an existing flow, enter {} for the value of mediaconnectSettings. Only UHD devices can specify this parameter.

    • hasAudioChannelPairs

      public final boolean hasAudioChannelPairs()
      For responses, this returns true if the service returned a value for the AudioChannelPairs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • audioChannelPairs

      public final List<InputDeviceConfigurableAudioChannelPairConfig> audioChannelPairs()
      An array of eight audio configurations, one for each audio pair in the source. Set up each audio configuration either to exclude the pair, or to format it and include it in the output from the device. This parameter applies only to UHD devices, and only when the device is configured as the source for a MediaConnect flow. For an HD device, you configure the audio by setting up audio selectors in the channel configuration.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAudioChannelPairs() method.

      Returns:
      An array of eight audio configurations, one for each audio pair in the source. Set up each audio configuration either to exclude the pair, or to format it and include it in the output from the device. This parameter applies only to UHD devices, and only when the device is configured as the source for a MediaConnect flow. For an HD device, you configure the audio by setting up audio selectors in the channel configuration.

    • toBuilder

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

    • builder

      public static InputDeviceConfigurableSettings.Builder builder()

    • serializableBuilderClass

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