Skip to content
v2.274.0

Experimental

@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

AutomaticInputFailover Struct ​

Automatic input failover configuration for an input attachment.

When the active (primary) input meets any of the failover conditions, MediaLive switches to the secondary input without restarting the channel. This is input-source redundancy, distinct from the pipeline redundancy provided by ChannelClass.STANDARD.

Example ​

ts
declare const stack: Stack;
declare const primaryInput: medialive.IInput;
declare const secondaryInput: medialive.IInput;
declare const audioSelector: medialive.AudioSelector;
declare const video: medialive.EncodeConfiguration;
declare const audio: medialive.EncodeConfiguration;
declare const bucket: s3.IBucket;

new medialive.Channel(stack, 'Channel', {
  inputs: [{
    input: primaryInput,
    automaticInputFailover: {
      secondaryInput,
      inputPreference: medialive.InputPreference.PRIMARY_INPUT_PREFERRED,
      errorClearTime: Duration.seconds(3),
      failoverConditions: [
        medialive.FailoverCondition.inputLoss({ threshold: Duration.millis(1500) }),
        medialive.FailoverCondition.audioSilence({ audioSelector, threshold: Duration.seconds(2) }),
        medialive.FailoverCondition.videoBlack({ blackDetectThreshold: 0.1, threshold: Duration.seconds(1) }),
      ],
    },
  }, {
    // The secondary input must also be attached to the channel as its own input.
    input: secondaryInput,
  }],
  outputGroups: [
    medialive.OutputGroupConfiguration.hls({
      name: 'hls',
      destinations: [medialive.OutputDestination.toBucket(bucket, 'live/stream')],
      outputs: [{ encodes: [video, audio], outputName: 'hls_out' }],
    }),
  ],
});

Properties ​

errorClearTimeDurationerror_clear_timeDurationerrorClearTimeDurationErrorClearTimeDurationErrorClearTimeDuration= MediaLive service default#
How long a recovered input must remain free of failover conditions before it is considered healthy.

Particularly relevant with InputPreference.PRIMARY_INPUT_PREFERRED.

failoverConditionsFailoverCondition[]failover_conditionstyping.List[FailoverCondition]failoverConditionsList<FailoverCondition>FailoverConditionsFailoverCondition[]FailoverConditions*[]FailoverCondition= a single input-loss condition wi…#
The conditions that trigger failover to the secondary input.
default

Default: a single input-loss condition with the MediaLive service default threshold

inputPreferenceInputPreferenceinput_preferenceInputPreferenceinputPreferenceInputPreferenceInputPreferenceInputPreferenceInputPreferenceInputPreference= EQUAL_INPUT_PREFERENCE, applied …#
Which input to prefer once a failed input has recovered.
default

Default: EQUAL_INPUT_PREFERENCE, applied by MediaLive

secondaryInputIInputsecondary_inputIInputsecondaryInputIInputSecondaryInputIInputSecondaryInputIInputrequired#
The secondary input to fail over to. Must be the same input class as the primary input.

[disable-awslint:prefer-ref-interface]