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
Namespace
Google \ Cloud \ Video \ Transcoder \ V1 \ OverlayMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ fade_type |
int
Required. Type of fade animation: |
↳ xy |
NormalizedCoordinate
Normalized coordinates based on output video resolution. Valid values: |
↳ 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: |
getFadeType
Required. Type of fade animation: FADE_IN or FADE_OUT.
| Returns | |
|---|---|
| Type | Description |
int |
|
setFadeType
Required. Type of fade animation: FADE_IN or FADE_OUT.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getXy
Normalized coordinates based on output video resolution. Valid
values: 0.0–1.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 | |
|---|---|
| Type | Description |
NormalizedCoordinate|null |
|
hasXy
clearXy
setXy
Normalized coordinates based on output video resolution. Valid
values: 0.0–1.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 | |
|---|---|
| Name | Description |
var |
NormalizedCoordinate
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartTimeOffset
The time to start the fade animation, in seconds. Default: 0
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasStartTimeOffset
clearStartTimeOffset
setStartTimeOffset
The time to start the fade animation, in seconds. Default: 0
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTimeOffset
The time to end the fade animation, in seconds. Default:
start_time_offset + 1s
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasEndTimeOffset
clearEndTimeOffset
setEndTimeOffset
The time to end the fade animation, in seconds. Default:
start_time_offset + 1s
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|