Google Cloud Video Transcoder V1beta1 Client - Class Image (0.5.3)

Version 0.5.3

• 1.0.0 (latest)
• 1.0.0-RC1
• 0.10.5
• 0.9.1
• 0.8.2
• 0.7.1
• 0.6.0
• 0.5.3

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Overlaid jpeg image.

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

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ uri	string Required. URI of the JPEG image in Cloud Storage. For example, gs://bucket/inputs/image.jpeg. JPEG is the only supported image type.
↳ resolution	Google\Cloud\Video\Transcoder\V1beta1\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 JPEG image in Cloud Storage. For example, gs://bucket/inputs/image.jpeg. JPEG is the only supported image type.

Returns
Type	Description
string

setUri

Required. URI of the JPEG image in Cloud Storage. For example, gs://bucket/inputs/image.jpeg. JPEG is the only supported image type.

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\V1beta1\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\V1beta1\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