public final class SpriteSheet extends GeneratedMessageV3 implements SpriteSheetOrBuilder
Sprite sheet configuration.
Protobuf type google.cloud.video.transcoder.v1.SpriteSheet
Static Fields
COLUMN_COUNT_FIELD_NUMBER
public static final int COLUMN_COUNT_FIELD_NUMBER
Field Value
END_TIME_OFFSET_FIELD_NUMBER
public static final int END_TIME_OFFSET_FIELD_NUMBER
Field Value
FILE_PREFIX_FIELD_NUMBER
public static final int FILE_PREFIX_FIELD_NUMBER
Field Value
public static final int FORMAT_FIELD_NUMBER
Field Value
INTERVAL_FIELD_NUMBER
public static final int INTERVAL_FIELD_NUMBER
Field Value
QUALITY_FIELD_NUMBER
public static final int QUALITY_FIELD_NUMBER
Field Value
ROW_COUNT_FIELD_NUMBER
public static final int ROW_COUNT_FIELD_NUMBER
Field Value
SPRITE_HEIGHT_PIXELS_FIELD_NUMBER
public static final int SPRITE_HEIGHT_PIXELS_FIELD_NUMBER
Field Value
SPRITE_WIDTH_PIXELS_FIELD_NUMBER
public static final int SPRITE_WIDTH_PIXELS_FIELD_NUMBER
Field Value
START_TIME_OFFSET_FIELD_NUMBER
public static final int START_TIME_OFFSET_FIELD_NUMBER
Field Value
TOTAL_COUNT_FIELD_NUMBER
public static final int TOTAL_COUNT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static SpriteSheet getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static SpriteSheet.Builder newBuilder()
Returns
newBuilder(SpriteSheet prototype)
public static SpriteSheet.Builder newBuilder(SpriteSheet prototype)
Parameter
Returns
public static SpriteSheet parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static SpriteSheet parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SpriteSheet parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SpriteSheet parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SpriteSheet parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SpriteSheet parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SpriteSheet parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static SpriteSheet parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SpriteSheet parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static SpriteSheet parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SpriteSheet parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SpriteSheet parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<SpriteSheet> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getColumnCount()
public int getColumnCount()
The maximum number of sprites per row in a sprite sheet. The default is 0,
which indicates no maximum limit.
int32 column_count = 5;
| Type | Description |
int | The columnCount.
|
getDefaultInstanceForType()
public SpriteSheet getDefaultInstanceForType()
Returns
getEndTimeOffset()
public Duration getEndTimeOffset()
End time in seconds, relative to the output file timeline. When
end_time_offset is not specified, the sprites are generated until the end
of the output file.
.google.protobuf.Duration end_time_offset = 8;
| Type | Description |
Duration | The endTimeOffset.
|
getEndTimeOffsetOrBuilder()
public DurationOrBuilder getEndTimeOffsetOrBuilder()
End time in seconds, relative to the output file timeline. When
end_time_offset is not specified, the sprites are generated until the end
of the output file.
.google.protobuf.Duration end_time_offset = 8;
public SpriteSheet.ExtractionStrategyCase getExtractionStrategyCase()
Returns
getFilePrefix()
public String getFilePrefix()
Required. File name prefix for the generated sprite sheets.
Each sprite sheet has an incremental 10-digit zero-padded suffix starting
from 0 before the extension, such as sprite_sheet0000000123.jpeg.
string file_prefix = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
String | The filePrefix.
|
getFilePrefixBytes()
public ByteString getFilePrefixBytes()
Required. File name prefix for the generated sprite sheets.
Each sprite sheet has an incremental 10-digit zero-padded suffix starting
from 0 before the extension, such as sprite_sheet0000000123.jpeg.
string file_prefix = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
ByteString | The bytes for filePrefix.
|
public String getFormat()
Format type. The default is jpeg.
Supported formats:
string format = 1;
| Type | Description |
String | The format.
|
public ByteString getFormatBytes()
Format type. The default is jpeg.
Supported formats:
string format = 1;
getInterval()
public Duration getInterval()
Starting from 0s, create sprites at regular intervals. Specify the
interval value in seconds.
.google.protobuf.Duration interval = 10;
getIntervalOrBuilder()
public DurationOrBuilder getIntervalOrBuilder()
Starting from 0s, create sprites at regular intervals. Specify the
interval value in seconds.
.google.protobuf.Duration interval = 10;
getParserForType()
public Parser<SpriteSheet> getParserForType()
Returns
Overrides
getQuality()
The quality of the generated sprite sheet. Enter a value between 1
and 100, where 1 is the lowest quality and 100 is the highest quality.
The default is 100. A high quality value corresponds to a low image data
compression ratio.
int32 quality = 11;
| Type | Description |
int | The quality.
|
getRowCount()
The maximum number of rows per sprite sheet. When the sprite sheet is full,
a new sprite sheet is created. The default is 0, which indicates no maximum
limit.
int32 row_count = 6;
| Type | Description |
int | The rowCount.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSpriteHeightPixels()
public int getSpriteHeightPixels()
Required. The height of sprite in pixels. Must be an even integer. To
preserve the source aspect ratio, set the
SpriteSheet.sprite_height_pixels
field or the
SpriteSheet.sprite_width_pixels
field, but not both (the API will automatically calculate the missing
field).
For portrait videos that contain horizontal ASR and rotation metadata,
provide the height, in pixels, per the horizontal ASR. The API calculates
the width per the horizontal ASR. The API detects any rotation metadata
and swaps the requested height and width for the output.
int32 sprite_height_pixels = 4 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
int | The spriteHeightPixels.
|
getSpriteWidthPixels()
public int getSpriteWidthPixels()
Required. The width of sprite in pixels. Must be an even integer. To
preserve the source aspect ratio, set the
SpriteSheet.sprite_width_pixels
field or the
SpriteSheet.sprite_height_pixels
field, but not both (the API will automatically calculate the missing
field).
For portrait videos that contain horizontal ASR and rotation metadata,
provide the width, in pixels, per the horizontal ASR. The API calculates
the height per the horizontal ASR. The API detects any rotation metadata
and swaps the requested height and width for the output.
int32 sprite_width_pixels = 3 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
int | The spriteWidthPixels.
|
getStartTimeOffset()
public Duration getStartTimeOffset()
Start time in seconds, relative to the output file timeline. Determines the
first sprite to pick. The default is 0s.
.google.protobuf.Duration start_time_offset = 7;
| Type | Description |
Duration | The startTimeOffset.
|
getStartTimeOffsetOrBuilder()
public DurationOrBuilder getStartTimeOffsetOrBuilder()
Start time in seconds, relative to the output file timeline. Determines the
first sprite to pick. The default is 0s.
.google.protobuf.Duration start_time_offset = 7;
getTotalCount()
public int getTotalCount()
Total number of sprites. Create the specified number of sprites
distributed evenly across the timeline of the output media. The default
is 100.
int32 total_count = 9;
| Type | Description |
int | The totalCount.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasEndTimeOffset()
public boolean hasEndTimeOffset()
End time in seconds, relative to the output file timeline. When
end_time_offset is not specified, the sprites are generated until the end
of the output file.
.google.protobuf.Duration end_time_offset = 8;
| Type | Description |
boolean | Whether the endTimeOffset field is set.
|
hasInterval()
public boolean hasInterval()
Starting from 0s, create sprites at regular intervals. Specify the
interval value in seconds.
.google.protobuf.Duration interval = 10;
| Type | Description |
boolean | Whether the interval field is set.
|
hasStartTimeOffset()
public boolean hasStartTimeOffset()
Start time in seconds, relative to the output file timeline. Determines the
first sprite to pick. The default is 0s.
.google.protobuf.Duration start_time_offset = 7;
| Type | Description |
boolean | Whether the startTimeOffset field is set.
|
hasTotalCount()
public boolean hasTotalCount()
Total number of sprites. Create the specified number of sprites
distributed evenly across the timeline of the output media. The default
is 100.
int32 total_count = 9;
| Type | Description |
boolean | Whether the totalCount field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public SpriteSheet.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SpriteSheet.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public SpriteSheet.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
