Package com.google.cloud.video.livestream.v1

Interface StaticOverlayOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
StaticOverlay, StaticOverlay.Builder
@Generated public interface StaticOverlayOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getAsset

      String 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 asset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The asset.

    • getAssetBytes

      com.google.protobuf.ByteString getAssetBytes()
       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 asset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for asset.

    • hasResolution

      boolean hasResolution()
       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}.
      .google.cloud.video.livestream.v1.NormalizedResolution resolution = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the resolution field is set.

    • getResolution

      NormalizedResolution 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}.
      .google.cloud.video.livestream.v1.NormalizedResolution resolution = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The resolution.

    • getResolutionOrBuilder

      NormalizedResolutionOrBuilder getResolutionOrBuilder()
       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}.
      .google.cloud.video.livestream.v1.NormalizedResolution resolution = 2 [(.google.api.field_behavior) = OPTIONAL];

    • hasPosition

      boolean hasPosition()
       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.
      .google.cloud.video.livestream.v1.NormalizedCoordinate position = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the position field is set.

    • getPosition

      NormalizedCoordinate 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.
      .google.cloud.video.livestream.v1.NormalizedCoordinate position = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The position.

    • getPositionOrBuilder

      NormalizedCoordinateOrBuilder getPositionOrBuilder()
       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.
      .google.cloud.video.livestream.v1.NormalizedCoordinate position = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getOpacity

      double 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`.
      double opacity = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The opacity.