Package com.azure.resourcemanager.mediaservices.models

Class VideoOverlay

java.lang.Object
com.azure.resourcemanager.mediaservices.models.Overlay
com.azure.resourcemanager.mediaservices.models.VideoOverlay
public final class VideoOverlay extends Overlay
Describes the properties of a video overlay.

  • Constructor Details

    • VideoOverlay

      public VideoOverlay()
      Creates an instance of VideoOverlay class.

  • Method Details

    • position

      public Rectangle position()
      Get the position property: The location in the input video where the overlay is applied.
      Returns:
      the position value.

    • withPosition

      public VideoOverlay withPosition(Rectangle position)
      Set the position property: The location in the input video where the overlay is applied.
      Parameters:
      position - the position value to set.
      Returns:
      the VideoOverlay object itself.

    • opacity

      public Double opacity()
      Get the opacity property: 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.
      Returns:
      the opacity value.

    • withOpacity

      public VideoOverlay withOpacity(Double opacity)
      Set the opacity property: 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.
      Parameters:
      opacity - the opacity value to set.
      Returns:
      the VideoOverlay object itself.

    • cropRectangle

      public Rectangle cropRectangle()
      Get the cropRectangle property: An optional rectangular window used to crop the overlay image or video.
      Returns:
      the cropRectangle value.

    • withCropRectangle

      public VideoOverlay withCropRectangle(Rectangle cropRectangle)
      Set the cropRectangle property: An optional rectangular window used to crop the overlay image or video.
      Parameters:
      cropRectangle - the cropRectangle value to set.
      Returns:
      the VideoOverlay object itself.

    • withInputLabel

      public VideoOverlay withInputLabel(String inputLabel)
      Set the inputLabel property: 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.
      Overrides:
      withInputLabel in class Overlay
      Parameters:
      inputLabel - the inputLabel value to set.
      Returns:
      the Overlay object itself.

    • withStart

      public VideoOverlay withStart(Duration start)
      Set the start property: 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.
      Overrides:
      withStart in class Overlay
      Parameters:
      start - the start value to set.
      Returns:
      the Overlay object itself.

    • withEnd

      public VideoOverlay withEnd(Duration end)
      Set the end property: 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.
      Overrides:
      withEnd in class Overlay
      Parameters:
      end - the end value to set.
      Returns:
      the Overlay object itself.

    • withFadeInDuration

      public VideoOverlay withFadeInDuration(Duration fadeInDuration)
      Set the fadeInDuration property: 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).
      Overrides:
      withFadeInDuration in class Overlay
      Parameters:
      fadeInDuration - the fadeInDuration value to set.
      Returns:
      the Overlay object itself.

    • withFadeOutDuration

      public VideoOverlay withFadeOutDuration(Duration fadeOutDuration)
      Set the fadeOutDuration property: 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).
      Overrides:
      withFadeOutDuration in class Overlay
      Parameters:
      fadeOutDuration - the fadeOutDuration value to set.
      Returns:
      the Overlay object itself.

    • withAudioGainLevel

      public VideoOverlay withAudioGainLevel(Double audioGainLevel)
      Set the audioGainLevel property: The gain level of audio in the overlay. The value should be in the range [0, 1.0]. The default is 1.0.
      Overrides:
      withAudioGainLevel in class Overlay
      Parameters:
      audioGainLevel - the audioGainLevel value to set.
      Returns:
      the Overlay object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class Overlay
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.