Interface Overlay.ImageOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Overlay.Image, Overlay.Image.Builder
    Enclosing class:
    Overlay

    public static interface Overlay.ImageOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      double getAlpha()
      Target image opacity.
      Overlay.NormalizedCoordinate getResolution()
      Normalized image resolution, based on output video resolution.
      Overlay.NormalizedCoordinateOrBuilder getResolutionOrBuilder()
      Normalized image resolution, based on output video resolution.
      String getUri()
      Required.
      com.google.protobuf.ByteString getUriBytes()
      Required.
      boolean hasResolution()
      Normalized image resolution, based on output video resolution.
      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • getUri

        String getUri()
         Required. URI of the image in Cloud Storage. For example,
         `gs://bucket/inputs/image.png`. Only PNG and JPEG images are supported.
         
        string uri = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The uri.
      • getUriBytes

        com.google.protobuf.ByteString getUriBytes()
         Required. URI of the image in Cloud Storage. For example,
         `gs://bucket/inputs/image.png`. Only PNG and JPEG images are supported.
         
        string uri = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for uri.
      • hasResolution

        boolean hasResolution()
         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`.
         
        .google.cloud.video.transcoder.v1.Overlay.NormalizedCoordinate resolution = 2;
        Returns:
        Whether the resolution field is set.
      • getResolution

        Overlay.NormalizedCoordinate 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`.
         
        .google.cloud.video.transcoder.v1.Overlay.NormalizedCoordinate resolution = 2;
        Returns:
        The resolution.
      • getResolutionOrBuilder

        Overlay.NormalizedCoordinateOrBuilder getResolutionOrBuilder()
         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`.
         
        .google.cloud.video.transcoder.v1.Overlay.NormalizedCoordinate resolution = 2;
      • getAlpha

        double 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`.
         
        double alpha = 3;
        Returns:
        The alpha.