VideoOverlay Class

Describes the properties of a video overlay.

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

Inheritance

azure.mgmt.media.models._models_py3.Overlay

VideoOverlay

Constructor

VideoOverlay(*, input_label: str, start: Optional[datetime.timedelta] = None, end: Optional[datetime.timedelta] = None, fade_in_duration: Optional[datetime.timedelta] = None, fade_out_duration: Optional[datetime.timedelta] = None, audio_gain_level: Optional[float] = None, position: Optional[_models.Rectangle] = None, opacity: Optional[float] = None, crop_rectangle: Optional[_models.Rectangle] = None, **kwargs)

Variables

odata_type

str

Required. The discriminator for derived types.Constant filled by server.

input_label

str

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

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.

position

Rectangle

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

opacity

float

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.

crop_rectangle

Rectangle

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