Google Cloud Video Transcoder V1 Client - Class AnimationFade (0.5.3)

Reference documentation and code samples for the Google Cloud Video Transcoder V1 Client class AnimationFade.

Display overlay object with fade animation.

Generated from protobuf message google.cloud.video.transcoder.v1.Overlay.AnimationFade

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ fade_type int

Required. Type of fade animation: FADE_IN or FADE_OUT.

↳ xy Google\Cloud\Video\Transcoder\V1\Overlay\NormalizedCoordinate

Normalized coordinates based on output video resolution. Valid values: 0.01.0. xy is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.

↳ start_time_offset Google\Protobuf\Duration

The time to start the fade animation, in seconds. Default: 0

↳ end_time_offset Google\Protobuf\Duration

The time to end the fade animation, in seconds. Default: start_time_offset + 1s

getFadeType

Required. Type of fade animation: FADE_IN or FADE_OUT.

Returns
TypeDescription
int

setFadeType

Required. Type of fade animation: FADE_IN or FADE_OUT.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getXy

Normalized coordinates based on output video resolution. Valid values: 0.01.0. xy is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.

Returns
TypeDescription
Google\Cloud\Video\Transcoder\V1\Overlay\NormalizedCoordinate|null

hasXy

clearXy

setXy

Normalized coordinates based on output video resolution. Valid values: 0.01.0. xy is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.

Parameter
NameDescription
var Google\Cloud\Video\Transcoder\V1\Overlay\NormalizedCoordinate
Returns
TypeDescription
$this

getStartTimeOffset

The time to start the fade animation, in seconds. Default: 0

Returns
TypeDescription
Google\Protobuf\Duration|null

hasStartTimeOffset

clearStartTimeOffset

setStartTimeOffset

The time to start the fade animation, in seconds. Default: 0

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getEndTimeOffset

The time to end the fade animation, in seconds. Default: start_time_offset + 1s

Returns
TypeDescription
Google\Protobuf\Duration|null

hasEndTimeOffset

clearEndTimeOffset

setEndTimeOffset

The time to end the fade animation, in seconds. Default: start_time_offset + 1s

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this