Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class StaticOverlay.
Configuration for the static overlay.
Generated from protobuf message google.cloud.video.livestream.v1.StaticOverlay
Namespace
Google \ Cloud \ Video \ LiveStream \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ asset
string
Required. Asset to use for the overlaid image. The asset must be represented in the form of: projects/{project}/locations/{location}/assets/{assetId}
. The asset's resource type must be image.
↳ resolution
NormalizedResolution
Optional. Normalized image resolution, based on output video resolution. Valid values are [0.0, 1.0]. To respect the original image aspect ratio, set either w
or h
to 0. To use the original image resolution, set both w
and h
to 0. The default is {0, 0}.
↳ position
NormalizedCoordinate
Optional. Position of the image in terms of normalized coordinates of the upper-left corner of the image, based on output video resolution. 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.
↳ opacity
float
Optional. Target image opacity. Valid values are from 1.0
(solid, default) to 0.0
(transparent), exclusive. Set this to a value greater than 0.0
.
getAsset
Required. Asset to use for the overlaid image.
The asset must be represented in the form of: projects/{project}/locations/{location}/assets/{assetId}
.
The asset's resource type must be image.
string
setAsset
Required. Asset to use for the overlaid image.
The asset must be represented in the form of: projects/{project}/locations/{location}/assets/{assetId}
.
The asset's resource type must be image.
var
string
$this
getResolution
Optional. Normalized image resolution, based on output video resolution.
Valid values are [0.0, 1.0]. To respect the original image aspect ratio,
set either w
or h
to 0. To use the original image resolution, set both w
and h
to 0. The default is {0, 0}.
hasResolution
clearResolution
setResolution
Optional. Normalized image resolution, based on output video resolution.
Valid values are [0.0, 1.0]. To respect the original image aspect ratio,
set either w
or h
to 0. To use the original image resolution, set both w
and h
to 0. The default is {0, 0}.
$this
getPosition
Optional. Position of the image in terms of normalized coordinates of the upper-left corner of the image, based on output video resolution. 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.
hasPosition
clearPosition
setPosition
Optional. Position of the image in terms of normalized coordinates of the upper-left corner of the image, based on output video resolution. 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.
$this
getOpacity
Optional. Target image opacity. Valid values are from 1.0
(solid,
default) to 0.0
(transparent), exclusive. Set this to a value greater
than 0.0
.
float
setOpacity
Optional. Target image opacity. Valid values are from 1.0
(solid,
default) to 0.0
(transparent), exclusive. Set this to a value greater
than 0.0
.
var
float
$this
