Class GlobalConfiguration

java.lang.Object
software.amazon.awssdk.services.medialive.model.GlobalConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<GlobalConfiguration.Builder,GlobalConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class GlobalConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GlobalConfiguration.Builder,GlobalConfiguration>
Global Configuration
See Also:

  • Method Details

    • initialAudioGain

      public final Integer initialAudioGain()
      Value to set the initial audio gain for the Live Event.
      Returns:
      Value to set the initial audio gain for the Live Event.

    • inputEndAction

      public final GlobalConfigurationInputEndAction inputEndAction()
      Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).

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

      Returns:
      Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).
      See Also:

    • inputEndActionAsString

      public final String inputEndActionAsString()
      Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).

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

      Returns:
      Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).
      See Also:

    • inputLossBehavior

      public final InputLossBehavior inputLossBehavior()
      Settings for system actions when input is lost.
      Returns:
      Settings for system actions when input is lost.

    • outputLockingMode

      public final GlobalConfigurationOutputLockingMode outputLockingMode()
      Indicates how MediaLive pipelines are synchronized. PIPELINE_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. DISABLED - MediaLive will not attempt to synchronize the output of pipelines. We advise against disabling output locking because it has negative side effects in most workflows. For more information, see the section about output locking (pipeline locking) in the Medialive user guide.

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

      Returns:
      Indicates how MediaLive pipelines are synchronized. PIPELINE_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. DISABLED - MediaLive will not attempt to synchronize the output of pipelines. We advise against disabling output locking because it has negative side effects in most workflows. For more information, see the section about output locking (pipeline locking) in the Medialive user guide.
      See Also:

    • outputLockingModeAsString

      public final String outputLockingModeAsString()
      Indicates how MediaLive pipelines are synchronized. PIPELINE_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. DISABLED - MediaLive will not attempt to synchronize the output of pipelines. We advise against disabling output locking because it has negative side effects in most workflows. For more information, see the section about output locking (pipeline locking) in the Medialive user guide.

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

      Returns:
      Indicates how MediaLive pipelines are synchronized. PIPELINE_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. DISABLED - MediaLive will not attempt to synchronize the output of pipelines. We advise against disabling output locking because it has negative side effects in most workflows. For more information, see the section about output locking (pipeline locking) in the Medialive user guide.
      See Also:

    • outputTimingSource

      public final GlobalConfigurationOutputTimingSource outputTimingSource()
      Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.

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

      Returns:
      Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.
      See Also:

    • outputTimingSourceAsString

      public final String outputTimingSourceAsString()
      Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.

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

      Returns:
      Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.
      See Also:

    • supportLowFramerateInputs

      public final GlobalConfigurationLowFramerateInputs supportLowFramerateInputs()
      Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.

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

      Returns:
      Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.
      See Also:

    • supportLowFramerateInputsAsString

      public final String supportLowFramerateInputsAsString()
      Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.

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

      Returns:
      Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.
      See Also:

    • outputLockingSettings

      public final OutputLockingSettings outputLockingSettings()
      Advanced output locking settings
      Returns:
      Advanced output locking settings

    • toBuilder

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

    • builder

      public static GlobalConfiguration.Builder builder()

    • serializableBuilderClass

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