VideoOverlay Class

Definition

Namespace:

Microsoft.Azure.Management.Media.Models

Assembly:

Microsoft.Azure.Management.Media.dll

Package:

Microsoft.Azure.Management.Media v6.0.0

Describes the properties of a video overlay.

[Newtonsoft.Json.JsonObject("#Microsoft.Media.VideoOverlay")]
public class VideoOverlay : Microsoft.Azure.Management.Media.Models.Overlay

[<Newtonsoft.Json.JsonObject("#Microsoft.Media.VideoOverlay")>]
type VideoOverlay = class
    inherit Overlay

Public Class VideoOverlay
Inherits Overlay

Inheritance

Object

Overlay

VideoOverlay

Attributes

Newtonsoft.Json.JsonObjectAttribute

Constructors

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.

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. (Inherited from Overlay)
CropRectangle	Gets or sets an optional rectangular window used to crop the overlay image or video.
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. (Inherited from Overlay)
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). (Inherited from Overlay)
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). (Inherited from Overlay)
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. (Inherited from Overlay)
Opacity	Gets or sets 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.
Position	Gets or sets the location in the input video where the overlay is applied.
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. (Inherited from Overlay)

Methods

Validate()

Validate the object.