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

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

Overlaid jpeg image.

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

Methods

__construct

Constructor.

Parameters
NameDescription
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\V1\Overlay\NormalizedCoordinate

Normalized image resolution, based on output video resolution. Valid values: 0.01.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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getResolution

Normalized image resolution, based on output video resolution. Valid values: 0.01.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
TypeDescription
Google\Cloud\Video\Transcoder\V1\Overlay\NormalizedCoordinate|null

hasResolution

clearResolution

setResolution

Normalized image resolution, based on output video resolution. Valid values: 0.01.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
NameDescription
var Google\Cloud\Video\Transcoder\V1\Overlay\NormalizedCoordinate
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var float
Returns
TypeDescription
$this