Class Overlay.Image

  • All Implemented Interfaces:
    Overlay.ImageOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    Overlay

    public static final class Overlay.Image
    extends com.google.protobuf.GeneratedMessageV3
    implements Overlay.ImageOrBuilder
     Overlaid image.
     
    Protobuf type google.cloud.video.transcoder.v1.Overlay.Image
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Overlay.Image.Builder
      Overlaid image.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ALPHA_FIELD_NUMBER  
      static int RESOLUTION_FIELD_NUMBER  
      static int URI_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getUri

        public 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];
        Specified by:
        getUri in interface Overlay.ImageOrBuilder
        Returns:
        The uri.
      • getUriBytes

        public 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];
        Specified by:
        getUriBytes in interface Overlay.ImageOrBuilder
        Returns:
        The bytes for uri.
      • hasResolution

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

        public 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;
        Specified by:
        getResolution in interface Overlay.ImageOrBuilder
        Returns:
        The resolution.
      • getResolutionOrBuilder

        public 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;
        Specified by:
        getResolutionOrBuilder in interface Overlay.ImageOrBuilder
      • getAlpha

        public 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;
        Specified by:
        getAlpha in interface Overlay.ImageOrBuilder
        Returns:
        The alpha.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static Overlay.Image parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Overlay.Image parseFrom​(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Overlay.Image parseFrom​(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Overlay.Image parseFrom​(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Overlay.Image parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Overlay.Image parseFrom​(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Overlay.Image parseFrom​(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException
        Throws:
        IOException
      • newBuilderForType

        public Overlay.Image.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public Overlay.Image.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected Overlay.Image.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static Overlay.Image getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Overlay.Image> parser()
      • getParserForType

        public com.google.protobuf.Parser<Overlay.Image> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

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