Class VideoOverlayArgs


  • public final class VideoOverlayArgs
    extends com.pulumi.resources.ResourceArgs
    Describes the properties of a video overlay.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  VideoOverlayArgs.Builder  
      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal
    • Method Detail

      • audioGainLevel

        public java.util.Optional<com.pulumi.core.Output<java.lang.Double>> audioGainLevel()
        Returns:
        The gain level of audio in the overlay. The value should be in the range [0, 1.0]. The default is 1.0.
      • cropRectangle

        public java.util.Optional<com.pulumi.core.Output<RectangleArgs>> cropRectangle()
        Returns:
        An optional rectangular window used to crop the overlay image or video.
      • end

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> end()
        Returns:
        The end position, with reference to the input video, at which the overlay ends. The value should be in ISO 8601 format. For example, PT30S to end the overlay at 30 seconds into the input video. If not specified or the value is greater than the input video duration, the overlay will be applied until the end of the input video if the overlay media duration is greater than the input video duration, else the overlay will last as long as the overlay media duration.
      • fadeInDuration

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> fadeInDuration()
        Returns:
        The duration over which the overlay fades in onto the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade in (same as PT0S).
      • fadeOutDuration

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> fadeOutDuration()
        Returns:
        The duration over which the overlay fades out of the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade out (same as PT0S).
      • inputLabel

        public com.pulumi.core.Output<java.lang.String> inputLabel()
        Returns:
        The label of the job input which is to be used as an overlay. The Input must specify exactly one file. You can specify an image file in JPG, PNG, GIF or BMP format, or an audio file (such as a WAV, MP3, WMA or M4A file), or a video file. See https://aka.ms/mesformats for the complete list of supported audio and video file formats.
      • odataType

        public com.pulumi.core.Output<java.lang.String> odataType()
        Returns:
        The discriminator for derived types. Expected value is '#Microsoft.Media.VideoOverlay'.
      • opacity

        public java.util.Optional<com.pulumi.core.Output<java.lang.Double>> opacity()
        Returns:
        The opacity of the overlay. This is a value in the range [0 - 1.0]. Default is 1.0 which mean the overlay is opaque.
      • position

        public java.util.Optional<com.pulumi.core.Output<RectangleArgs>> position()
        Returns:
        The location in the input video where the overlay is applied.
      • start

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> start()
        Returns:
        The start position, with reference to the input video, at which the overlay starts. The value should be in ISO 8601 format. For example, PT05S to start the overlay at 5 seconds into the input video. If not specified the overlay starts from the beginning of the input video.