Package com.azure.resourcemanager.mediaservices.models

Class Overlay

java.lang.Object
com.azure.resourcemanager.mediaservices.models.Overlay
Direct Known Subclasses:
AudioOverlay, VideoOverlay
public class Overlay extends Object
Base type for all overlays - image, audio or video.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Overlay()
    Creates an instance of Overlay class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Double
    audioGainLevel()
    Get the audioGainLevel property: The gain level of audio in the overlay.
    Duration
    end()
    Get the end property: The end position, with reference to the input video, at which the overlay ends.
    Duration
    fadeInDuration()
    Get the fadeInDuration property: The duration over which the overlay fades in onto the input video.
    Duration
    fadeOutDuration()
    Get the fadeOutDuration property: The duration over which the overlay fades out of the input video.
    String
    inputLabel()
    Get the inputLabel property: The label of the job input which is to be used as an overlay.
    Duration
    start()
    Get the start property: The start position, with reference to the input video, at which the overlay starts.
    void
    validate()
    Validates the instance.
    Overlay
    withAudioGainLevel(Double audioGainLevel)
    Set the audioGainLevel property: The gain level of audio in the overlay.
    Overlay
    withEnd(Duration end)
    Set the end property: The end position, with reference to the input video, at which the overlay ends.
    Overlay
    withFadeInDuration(Duration fadeInDuration)
    Set the fadeInDuration property: The duration over which the overlay fades in onto the input video.
    Overlay
    withFadeOutDuration(Duration fadeOutDuration)
    Set the fadeOutDuration property: The duration over which the overlay fades out of the input video.
    Overlay
    withInputLabel(String inputLabel)
    Set the inputLabel property: The label of the job input which is to be used as an overlay.
    Overlay
    withStart(Duration start)
    Set the start property: The start position, with reference to the input video, at which the overlay starts.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Overlay

      public Overlay()
      Creates an instance of Overlay class.

  • Method Details

    • inputLabel

      public String inputLabel()
      Get 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.
      Returns:
      the inputLabel value.

    • withInputLabel

      public Overlay 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.
      Parameters:
      inputLabel - the inputLabel value to set.
      Returns:
      the Overlay object itself.

    • start

      public Duration start()
      Get 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.
      Returns:
      the start value.

    • withStart

      public Overlay 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.
      Parameters:
      start - the start value to set.
      Returns:
      the Overlay object itself.

    • end

      public Duration end()
      Get 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.
      Returns:
      the end value.

    • withEnd

      public Overlay 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.
      Parameters:
      end - the end value to set.
      Returns:
      the Overlay object itself.

    • fadeInDuration

      public Duration fadeInDuration()
      Get 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).
      Returns:
      the fadeInDuration value.

    • withFadeInDuration

      public Overlay 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).
      Parameters:
      fadeInDuration - the fadeInDuration value to set.
      Returns:
      the Overlay object itself.

    • fadeOutDuration

      public Duration fadeOutDuration()
      Get 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).
      Returns:
      the fadeOutDuration value.

    • withFadeOutDuration

      public Overlay 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).
      Parameters:
      fadeOutDuration - the fadeOutDuration value to set.
      Returns:
      the Overlay object itself.

    • audioGainLevel

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

    • withAudioGainLevel

      public Overlay 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.
      Parameters:
      audioGainLevel - the audioGainLevel value to set.
      Returns:
      the Overlay object itself.

    • validate

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