VideoOverlay interface

Package:

@azure/arm-mediaservices

Describes the properties of a video overlay.

Extends

Overlay

Properties

cropRectangle	An optional rectangular window used to crop the overlay image or video.
odataType	Polymorphic discriminator, which specifies the different types this object can be
opacity	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	The location in the input video where the overlay is applied.

Inherited Properties

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

Property Details

cropRectangle

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

cropRectangle?: Rectangle

Property Value

Rectangle

odataType

Polymorphic discriminator, which specifies the different types this object can be

odataType: "#Microsoft.Media.VideoOverlay"

Property Value

"#Microsoft.Media.VideoOverlay"

opacity

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.

opacity?: number

Property Value

number

position

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

position?: Rectangle

Property Value

Rectangle

Inherited Property Details

audioGainLevel

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

audioGainLevel?: number

Property Value

number

Inherited From Overlay.audioGainLevel

end

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.

end?: string

Property Value

string

Inherited From Overlay.end

fadeInDuration

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

fadeInDuration?: string

Property Value

string

Inherited From Overlay.fadeInDuration

fadeOutDuration

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

fadeOutDuration?: string

Property Value

string

Inherited From Overlay.fadeOutDuration

inputLabel

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.

inputLabel: string

Property Value

string

Inherited From Overlay.inputLabel

start

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.

start?: string

Property Value

string

Inherited From Overlay.start