Overlay Class

Reference

Definition

Namespace:: Microsoft.Azure.Management.Media.Models

Assembly:: Microsoft.Azure.Management.Media.dll

Package:: Microsoft.Azure.Management.Media v6.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Base type for all overlays - image, audio or video.

public class Overlay

type Overlay = class

Public Class Overlay

Inheritance: Object
Overlay

Derived: Microsoft.Azure.Management.Media.Models.AudioOverlay

Microsoft.Azure.Management.Media.Models.VideoOverlay

Constructors

Overlay()	Initializes a new instance of the Overlay class.
Overlay(String, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<Double>)	Initializes a new instance of the Overlay class.

Properties

AudioGainLevel	Gets or sets the gain level of audio in the overlay. The value should be in the range [0, 1.0]. The default is 1.0.
End	Gets or sets 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	Gets or sets 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	Gets or sets 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	Gets or sets 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	Gets or sets 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.

Methods

Validate()

Validate the object.

Applies to