Package com.azure.resourcemanager.mediaservices.models

Class AudioOverlay

java.lang.Object
com.azure.resourcemanager.mediaservices.models.Overlay
com.azure.resourcemanager.mediaservices.models.AudioOverlay
public final class AudioOverlay extends Overlay
Describes the properties of an audio overlay.

  • Constructor Details

    • AudioOverlay

      public AudioOverlay()
      Creates an instance of AudioOverlay class.

  • Method Details

    • withInputLabel

      public AudioOverlay 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 AudioOverlay 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 AudioOverlay 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 AudioOverlay 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 AudioOverlay 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 AudioOverlay 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.