VideoOverlay Constructors

Definition

Overloads

VideoOverlay()

Initializes a new instance of the VideoOverlay class.

VideoOverlay(String, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<Double>, Rectangle, Nullable<Double>, Rectangle)

Initializes a new instance of the VideoOverlay class.

VideoOverlay()

Initializes a new instance of the VideoOverlay class.

public VideoOverlay ();
Public Sub New ()

Applies to

VideoOverlay(String, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<Double>, Rectangle, Nullable<Double>, Rectangle)

Initializes a new instance of the VideoOverlay class.

public VideoOverlay (string inputLabel, TimeSpan? start = default, TimeSpan? end = default, TimeSpan? fadeInDuration = default, TimeSpan? fadeOutDuration = default, double? audioGainLevel = default, Microsoft.Azure.Management.Media.Models.Rectangle position = default, double? opacity = default, Microsoft.Azure.Management.Media.Models.Rectangle cropRectangle = default);
new Microsoft.Azure.Management.Media.Models.VideoOverlay : string * Nullable<TimeSpan> * Nullable<TimeSpan> * Nullable<TimeSpan> * Nullable<TimeSpan> * Nullable<double> * Microsoft.Azure.Management.Media.Models.Rectangle * Nullable<double> * Microsoft.Azure.Management.Media.Models.Rectangle -> Microsoft.Azure.Management.Media.Models.VideoOverlay
Public Sub New (inputLabel As String, Optional start As Nullable(Of TimeSpan) = Nothing, Optional end As Nullable(Of TimeSpan) = Nothing, Optional fadeInDuration As Nullable(Of TimeSpan) = Nothing, Optional fadeOutDuration As Nullable(Of TimeSpan) = Nothing, Optional audioGainLevel As Nullable(Of Double) = Nothing, Optional position As Rectangle = Nothing, Optional opacity As Nullable(Of Double) = Nothing, Optional cropRectangle As Rectangle = Nothing)

Parameters

inputLabel
String

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.

start
Nullable<TimeSpan>

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.

end
Nullable<TimeSpan>

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
Nullable<TimeSpan>

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
Nullable<TimeSpan>

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).

audioGainLevel
Nullable<Double>

The gain level of audio in the overlay. The value should be in the range [0, 1.0]. The default is 1.0.

position
Rectangle

The location in the input video where the overlay is applied.

opacity
Nullable<Double>

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.

cropRectangle
Rectangle

An optional rectangular window used to crop the overlay image or video.

Applies to