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

Class StaticOverlay

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.video.livestream.v1.StaticOverlay
All Implemented Interfaces:
StaticOverlayOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class StaticOverlay extends com.google.protobuf.GeneratedMessage implements StaticOverlayOrBuilder
 Configuration for the static overlay.
Protobuf type google.cloud.video.livestream.v1.StaticOverlay
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    StaticOverlay.Builder
    Configuration for the static overlay.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ASSET_FIELD_NUMBER
     
    static final int
    OPACITY_FIELD_NUMBER
     
    static final int
    POSITION_FIELD_NUMBER
     
    static final int
    RESOLUTION_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getAsset()
    Required.
    com.google.protobuf.ByteString
    getAssetBytes()
    Required.
    static StaticOverlay
    getDefaultInstance()
     
    StaticOverlay
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    double
    getOpacity()
    Optional.
    com.google.protobuf.Parser<StaticOverlay>
    getParserForType()
     
    NormalizedCoordinate
    getPosition()
    Optional.
    NormalizedCoordinateOrBuilder
    getPositionOrBuilder()
    Optional.
    NormalizedResolution
    getResolution()
    Optional.
    NormalizedResolutionOrBuilder
    getResolutionOrBuilder()
    Optional.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasPosition()
    Optional.
    boolean
    hasResolution()
    Optional.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static StaticOverlay.Builder
    newBuilder()
     
    static StaticOverlay.Builder
    newBuilder(StaticOverlay prototype)
     
    StaticOverlay.Builder
    newBuilderForType()
     
    protected StaticOverlay.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static StaticOverlay
    parseDelimitedFrom(InputStream input)
     
    static StaticOverlay
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StaticOverlay
    parseFrom(byte[] data)
     
    static StaticOverlay
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StaticOverlay
    parseFrom(com.google.protobuf.ByteString data)
     
    static StaticOverlay
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StaticOverlay
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static StaticOverlay
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StaticOverlay
    parseFrom(InputStream input)
     
    static StaticOverlay
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StaticOverlay
    parseFrom(ByteBuffer data)
     
    static StaticOverlay
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<StaticOverlay>
    parser()
     
    StaticOverlay.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • 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

    • 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.

    • 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.

    • 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.

    • 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.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 StaticOverlay parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StaticOverlay parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StaticOverlay parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StaticOverlay parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StaticOverlay parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static StaticOverlay parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StaticOverlay parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StaticOverlay parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StaticOverlay parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StaticOverlay parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StaticOverlay parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static StaticOverlay.Builder newBuilder()

    • newBuilder

      public static StaticOverlay.Builder newBuilder(StaticOverlay prototype)

    • toBuilder

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

    • newBuilderForType

      protected StaticOverlay.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static StaticOverlay getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<StaticOverlay> parser()

    • getParserForType

      public com.google.protobuf.Parser<StaticOverlay> 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.GeneratedMessage

    • getDefaultInstanceForType

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