Interface InputLossBehavior

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
InputLossBehavior.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:41.194Z") @Stability(Experimental) public interface InputLossBehavior extends software.amazon.jsii.JsiiSerializable
(experimental) Behavior on input loss: substitute black, optionally repeat the last frame, then show a solid color or a slate image.

Example:

 IBucket slateBucket;
 InputLossBehavior inputLoss = InputLossBehavior.builder()
         .blackFrame(Duration.seconds(1))
         .repeatFrame(Duration.seconds(5))
         .imageType(InputLossImageType.SLATE)
         .imageSlate(FileLocation.fromBucket(slateBucket, "slates/offline.png"))
         .build();
 
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    A builder for InputLossBehavior
    static final class 
    An implementation for InputLossBehavior
  • Method Summary

    Modifier and Type
    Method
    Description
     
    default Duration
    (experimental) How long to substitute black before showing the input-loss image (up to Duration.seconds(1000); Duration.seconds(1000) is interpreted as infinite).
    default String
    (experimental) The image color as 6 hex characters (RGB).
    default FileLocation
    (experimental) The slate image to display.
    (experimental) Whether to substitute a solid color or a slate image after the black period.
    default Duration
    (experimental) How long to repeat the previous picture before substituting black (up to Duration.seconds(1000); Duration.seconds(1000) is interpreted as infinite).

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson
  • Method Details

    • getBlackFrame

      @Stability(Experimental) @Nullable default Duration getBlackFrame()
      (experimental) How long to substitute black before showing the input-loss image (up to Duration.seconds(1000); Duration.seconds(1000) is interpreted as infinite).

      Default: - service default

    • getImageColor

      @Stability(Experimental) @Nullable default String getImageColor()
      (experimental) The image color as 6 hex characters (RGB).

      Used when InputLossImageType.COLOR.

      Default: - service default

    • getImageSlate

      @Stability(Experimental) @Nullable default FileLocation getImageSlate()
      (experimental) The slate image to display.

      Used when imageType is SLATE. Provide a FileLocation referencing an S3 bucket (FileLocation.fromBucket, which auto-grants read access) or a URL (FileLocation.url).

      Default: - service default

    • getImageType

      @Stability(Experimental) @Nullable default InputLossImageType getImageType()
      (experimental) Whether to substitute a solid color or a slate image after the black period.

      Default: - service default

    • getRepeatFrame

      @Stability(Experimental) @Nullable default Duration getRepeatFrame()
      (experimental) How long to repeat the previous picture before substituting black (up to Duration.seconds(1000); Duration.seconds(1000) is interpreted as infinite).

      Default: - service default

    • builder

      @Stability(Experimental) static InputLossBehavior.Builder builder()
      Returns:
      a InputLossBehavior.Builder of InputLossBehavior