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

Class StaticOverlay.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<StaticOverlay.Builder>
com.google.cloud.video.livestream.v1.StaticOverlay.Builder
All Implemented Interfaces:
StaticOverlayOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
StaticOverlay
public static final class StaticOverlay.Builder extends com.google.protobuf.GeneratedMessage.Builder<StaticOverlay.Builder> implements StaticOverlayOrBuilder
 Configuration for the static overlay.
Protobuf type google.cloud.video.livestream.v1.StaticOverlay

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<StaticOverlay.Builder>

    • clear

      public StaticOverlay.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<StaticOverlay.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<StaticOverlay.Builder>

    • getDefaultInstanceForType

      public StaticOverlay getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public StaticOverlay build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public StaticOverlay buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public StaticOverlay.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StaticOverlay.Builder>

    • mergeFrom

      public StaticOverlay.Builder mergeFrom(StaticOverlay other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<StaticOverlay.Builder>

    • mergeFrom

      public StaticOverlay.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StaticOverlay.Builder>
      Throws:
      IOException

    • getAsset

      public 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) = { ... }
      Specified by:
      getAsset in interface StaticOverlayOrBuilder
      Returns:
      The asset.

    • getAssetBytes

      public 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) = { ... }
      Specified by:
      getAssetBytes in interface StaticOverlayOrBuilder
      Returns:
      The bytes for asset.

    • setAsset

      public StaticOverlay.Builder setAsset(String value)
       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) = { ... }
      Parameters:
      value - The asset to set.
      Returns:
      This builder for chaining.

    • clearAsset

      public StaticOverlay.Builder clearAsset()
       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:
      This builder for chaining.

    • setAssetBytes

      public StaticOverlay.Builder setAssetBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for asset to set.
      Returns:
      This builder for chaining.

    • hasResolution

      public 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];
      Specified by:
      hasResolution in interface StaticOverlayOrBuilder
      Returns:
      Whether the resolution field is set.

    • getResolution

      public 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];
      Specified by:
      getResolution in interface StaticOverlayOrBuilder
      Returns:
      The resolution.

    • setResolution

      public StaticOverlay.Builder setResolution(NormalizedResolution value)
       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];

    • setResolution

      public StaticOverlay.Builder setResolution(NormalizedResolution.Builder builderForValue)
       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];

    • mergeResolution

      public StaticOverlay.Builder mergeResolution(NormalizedResolution value)
       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];

    • clearResolution

      public StaticOverlay.Builder clearResolution()
       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];

    • getResolutionBuilder

      public NormalizedResolution.Builder getResolutionBuilder()
       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];

    • getResolutionOrBuilder

      public 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];
      Specified by:
      getResolutionOrBuilder in interface StaticOverlayOrBuilder

    • hasPosition

      public 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];
      Specified by:
      hasPosition in interface StaticOverlayOrBuilder
      Returns:
      Whether the position field is set.

    • getPosition

      public 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];
      Specified by:
      getPosition in interface StaticOverlayOrBuilder
      Returns:
      The position.

    • setPosition

      public StaticOverlay.Builder setPosition(NormalizedCoordinate value)
       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];

    • setPosition

      public StaticOverlay.Builder setPosition(NormalizedCoordinate.Builder builderForValue)
       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];

    • mergePosition

      public StaticOverlay.Builder mergePosition(NormalizedCoordinate value)
       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];

    • clearPosition

      public StaticOverlay.Builder clearPosition()
       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];

    • getPositionBuilder

      public NormalizedCoordinate.Builder getPositionBuilder()
       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];

    • getPositionOrBuilder

      public 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];
      Specified by:
      getPositionOrBuilder in interface StaticOverlayOrBuilder

    • getOpacity

      public 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];
      Specified by:
      getOpacity in interface StaticOverlayOrBuilder
      Returns:
      The opacity.

    • setOpacity

      public StaticOverlay.Builder setOpacity(double value)
       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];
      Parameters:
      value - The opacity to set.
      Returns:
      This builder for chaining.

    • clearOpacity

      public StaticOverlay.Builder clearOpacity()
       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:
      This builder for chaining.