Share via

Overlay Class

  • Reference

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AudioOverlay, VideoOverlay

All required parameters must be populated in order to send to Azure.

Inheritance
azure.mgmt.media._serialization.Model
Overlay

Constructor

Overlay(*, input_label: str, start: timedelta | None = None, end: timedelta | None = None, fade_in_duration: timedelta | None = None, fade_out_duration: timedelta | None = None, audio_gain_level: float | None = None, **kwargs)

Keyword-Only Parameters

Name Description
input_label
str

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. Required.
start
timedelta

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
timedelta

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.
fade_in_duration
timedelta

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

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

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

Variables

Name Description
odata_type
str

The discriminator for derived types. Required.
input_label
str

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. Required.
start
timedelta

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
timedelta

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.
fade_in_duration
timedelta

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

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

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