Package software.amazon.awscdk.services.medialive.alpha

Class FailoverCondition

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.medialive.alpha.FailoverCondition
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:41.049Z") @Stability(Experimental) public abstract class FailoverCondition extends software.amazon.jsii.JsiiObject
(experimental) A condition that, when met on the active input, triggers automatic input failover to the secondary input.

Create conditions with the static factory methods.

Example: 

 Stack stack;
 IInput primaryInput;
 IInput secondaryInput;
 AudioSelector audioSelector;
 EncodeConfiguration video;
 EncodeConfiguration audio;
 IBucket bucket;
 Channel.Builder.create(stack, "Channel")
         .inputs(List.of(InputAttachment.builder()
                 .input(primaryInput)
                 .automaticInputFailover(AutomaticInputFailover.builder()
                         .secondaryInput(secondaryInput)
                         .inputPreference(InputPreference.PRIMARY_INPUT_PREFERRED)
                         .errorClearTime(Duration.seconds(3))
                         .failoverConditions(List.of(FailoverCondition.inputLoss(InputLossFailoverProps.builder().threshold(Duration.millis(1500)).build()), FailoverCondition.audioSilence(AudioSilenceFailoverProps.builder().audioSelector(audioSelector).threshold(Duration.seconds(2)).build()), FailoverCondition.videoBlack(VideoBlackFailoverProps.builder().blackDetectThreshold(0.1).threshold(Duration.seconds(1)).build())))
                         .build())
                 .build(), InputAttachment.builder()
                 // The secondary input must also be attached to the channel as its own input.
                 .input(secondaryInput)
                 .build()))
         .outputGroups(List.of(OutputGroupConfiguration.hls(HlsOutputGroupProps.builder()
                 .name("hls")
                 .destinations(List.of(OutputDestination.toBucket(bucket, "live/stream")))
                 .outputs(List.of(HlsOutputDefinition.builder().encodes(List.of(video, audio)).outputName("hls_out").build()))
                 .build())))
         .build();

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    FailoverCondition()
     
    protected
    FailoverCondition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    FailoverCondition(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static FailoverCondition
    audioSilence(AudioSilenceFailoverProps props)
    (experimental) Fail over when the monitored audio selector is silent for the threshold period.
    static FailoverCondition
    inputLoss()
    (experimental) Fail over when no input is detected for the threshold period.
    static FailoverCondition
    inputLoss(InputLossFailoverProps props)
    (experimental) Fail over when no input is detected for the threshold period.
    static FailoverCondition
    videoBlack()
    (experimental) Fail over when the content is black for the threshold period.
    static FailoverCondition
    videoBlack(VideoBlackFailoverProps props)
    (experimental) Fail over when the content is black for the threshold period.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • FailoverCondition

      protected FailoverCondition(software.amazon.jsii.JsiiObjectRef objRef)

    • FailoverCondition

      protected FailoverCondition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • FailoverCondition

      @Stability(Experimental) protected FailoverCondition()

  • Method Details

    • audioSilence

      @Stability(Experimental) @NotNull public static FailoverCondition audioSilence(@NotNull AudioSilenceFailoverProps props)
      (experimental) Fail over when the monitored audio selector is silent for the threshold period.

      Parameters:
      props - This parameter is required.

    • inputLoss

      @Stability(Experimental) @NotNull public static FailoverCondition inputLoss(@Nullable InputLossFailoverProps props)
      (experimental) Fail over when no input is detected for the threshold period.

      Parameters:
      props -

    • inputLoss

      @Stability(Experimental) @NotNull public static FailoverCondition inputLoss()
      (experimental) Fail over when no input is detected for the threshold period.

    • videoBlack

      @Stability(Experimental) @NotNull public static FailoverCondition videoBlack(@Nullable VideoBlackFailoverProps props)
      (experimental) Fail over when the content is black for the threshold period.

      Parameters:
      props -

    • videoBlack

      @Stability(Experimental) @NotNull public static FailoverCondition videoBlack()
      (experimental) Fail over when the content is black for the threshold period.