pulumi-azure-native-kotlin/com.pulumi.azurenative.media.kotlin.inputs/VideoOverlayArgs

VideoOverlayArgs

data class VideoOverlayArgs(val audioGainLevel: Output<Double>? = null, val cropRectangle: Output<RectangleArgs>? = null, val end: Output<String>? = null, val fadeInDuration: Output<String>? = null, val fadeOutDuration: Output<String>? = null, val inputLabel: Output<String>, val odataType: Output<String>, val opacity: Output<Double>? = null, val position: Output<RectangleArgs>? = null, val start: Output<String>? = null) : ConvertibleToJava<VideoOverlayArgs>

Describes the properties of a video overlay.

Constructors

VideoOverlayArgs

constructor(audioGainLevel: Output<Double>? = null, cropRectangle: Output<RectangleArgs>? = null, end: Output<String>? = null, fadeInDuration: Output<String>? = null, fadeOutDuration: Output<String>? = null, inputLabel: Output<String>, odataType: Output<String>, opacity: Output<Double>? = null, position: Output<RectangleArgs>? = null, start: Output<String>? = null)

Properties

audioGainLevel

val audioGainLevel: Output<Double>? = null

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

cropRectangle

val cropRectangle: Output<RectangleArgs>? = null

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

end

val end: Output<String>? = null

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

val fadeInDuration: Output<String>? = null

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

val fadeOutDuration: Output<String>? = null

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

val inputLabel: Output<String>

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.

odataType

val odataType: Output<String>

The discriminator for derived types. Expected value is '#Microsoft.Media.VideoOverlay'.

opacity

val opacity: Output<Double>? = null

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

val position: Output<RectangleArgs>? = null

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

start

val start: Output<String>? = null

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.

Functions

toJava

open override fun toJava(): VideoOverlayArgs