Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class StaticOverlay.
Configuration for the static overlay.
Generated from protobuf messagegoogle.cloud.video.livestream.v1.StaticOverlay
Namespace
Google \ Cloud \ Video \ LiveStream \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
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.
Optional. Normalized image resolution, based on output video resolution. Valid values are [0.0, 1.0]. To respect the original image aspect ratio, set eitherworhto 0. To use the original image resolution, set bothwandhto 0. The default is {0, 0}.
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 from1.0(solid, default) to0.0(transparent), exclusive. Set this to a value greater than0.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.
Returns
Type
Description
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$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 eitherworhto 0. To use the original image resolution, set bothwandhto 0. The default is {0, 0}.
Optional. Normalized image resolution, based on output video resolution.
Valid values are [0.0, 1.0]. To respect the original image aspect ratio,
set eitherworhto 0. To use the original image resolution, set bothwandhto 0. The default is {0, 0}.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Video Live Stream V1 Client - Class StaticOverlay (1.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.1 (latest)](/php/docs/reference/cloud-video-live-stream/latest/V1.StaticOverlay)\n- [1.2.0](/php/docs/reference/cloud-video-live-stream/1.2.0/V1.StaticOverlay)\n- [1.1.3](/php/docs/reference/cloud-video-live-stream/1.1.3/V1.StaticOverlay)\n- [1.0.0](/php/docs/reference/cloud-video-live-stream/1.0.0/V1.StaticOverlay)\n- [0.7.5](/php/docs/reference/cloud-video-live-stream/0.7.5/V1.StaticOverlay)\n- [0.6.2](/php/docs/reference/cloud-video-live-stream/0.6.2/V1.StaticOverlay)\n- [0.5.0](/php/docs/reference/cloud-video-live-stream/0.5.0/V1.StaticOverlay)\n- [0.4.2](/php/docs/reference/cloud-video-live-stream/0.4.2/V1.StaticOverlay)\n- [0.3.2](/php/docs/reference/cloud-video-live-stream/0.3.2/V1.StaticOverlay)\n- [0.2.6](/php/docs/reference/cloud-video-live-stream/0.2.6/V1.StaticOverlay) \nReference documentation and code samples for the Google Cloud Video Live Stream V1 Client class StaticOverlay.\n\nConfiguration for the static overlay.\n\nGenerated from protobuf message `google.cloud.video.livestream.v1.StaticOverlay`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Video \\\\ LiveStream \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getAsset\n\nRequired. Asset to use for the overlaid image.\n\nThe asset must be represented in the form of:\n`projects/{project}/locations/{location}/assets/{assetId}`.\nThe asset's resource type must be image.\n\n### setAsset\n\nRequired. Asset to use for the overlaid image.\n\nThe asset must be represented in the form of:\n`projects/{project}/locations/{location}/assets/{assetId}`.\nThe asset's resource type must be image.\n\n### getResolution\n\nOptional. Normalized image resolution, based on output video resolution.\n\nValid values are \\[0.0, 1.0\\]. To respect the original image aspect ratio,\nset either `w` or `h` to 0. To use the original image resolution, set both\n`w` and `h` to 0. The default is {0, 0}.\n\n### hasResolution\n\n### clearResolution\n\n### setResolution\n\nOptional. Normalized image resolution, based on output video resolution.\n\nValid values are \\[0.0, 1.0\\]. To respect the original image aspect ratio,\nset either `w` or `h` to 0. To use the original image resolution, set both\n`w` and `h` to 0. The default is {0, 0}.\n\n### getPosition\n\nOptional. Position of the image in terms of normalized coordinates of the\nupper-left corner of the image, based on output video resolution. For\nexample, use the x and y coordinates {0, 0} to position the top-left corner\nof the overlay animation in the top-left corner of the output video.\n\n### hasPosition\n\n### clearPosition\n\n### setPosition\n\nOptional. Position of the image in terms of normalized coordinates of the\nupper-left corner of the image, based on output video resolution. For\nexample, use the x and y coordinates {0, 0} to position the top-left corner\nof the overlay animation in the top-left corner of the output video.\n\n### getOpacity\n\nOptional. Target image opacity. Valid values are from `1.0` (solid,\ndefault) to `0.0` (transparent), exclusive. Set this to a value greater\nthan `0.0`.\n\n### setOpacity\n\nOptional. Target image opacity. Valid values are from `1.0` (solid,\ndefault) to `0.0` (transparent), exclusive. Set this to a value greater\nthan `0.0`."]]
