Google Cloud Video Transcoder V1 Client - Class Image (0.10.5)

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

Overlaid image.

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

Namespace

Google \ Cloud \ Video \ Transcoder \ V1 \ Overlay

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ uri string

Required. URI of the image in Cloud Storage. For example, gs://bucket/inputs/image.png. Only PNG and JPEG images are supported.
↳ resolution Google\Cloud\Video\Transcoder\V1\Overlay\NormalizedCoordinate

Normalized image resolution, based on output video resolution. Valid values: 0.0–1.0. To respect the original image aspect ratio, set either x or y to 0.0. To use the original image resolution, set both x and y to 0.0.
↳ alpha float

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.

getUri

Required. URI of the image in Cloud Storage. For example, gs://bucket/inputs/image.png. Only PNG and JPEG images are supported.

Returns
Type Description
string

setUri

Required. URI of the image in Cloud Storage. For example, gs://bucket/inputs/image.png. Only PNG and JPEG images are supported.

Parameter
Name Description
var string
Returns
Type Description
$this

getResolution

Normalized image resolution, based on output video resolution. Valid values: 0.0–1.0. To respect the original image aspect ratio, set either x or y to 0.0. To use the original image resolution, set both x and y to 0.0.

Returns
Type Description
Google\Cloud\Video\Transcoder\V1\Overlay\NormalizedCoordinate|null

hasResolution

clearResolution

setResolution

Normalized image resolution, based on output video resolution. Valid values: 0.0–1.0. To respect the original image aspect ratio, set either x or y to 0.0. To use the original image resolution, set both x and y to 0.0.

Parameter
Name Description
var Google\Cloud\Video\Transcoder\V1\Overlay\NormalizedCoordinate
Returns
Type Description
$this

getAlpha

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.

Returns
Type Description
float

setAlpha

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.

Parameter
Name Description
var float
Returns
Type Description
$this