public static final class SpriteSheet.Builder extends GeneratedMessageV3.Builder<SpriteSheet.Builder> implements SpriteSheetOrBuilderSprite sheet configuration.
Protobuf type google.cloud.video.transcoder.v1.SpriteSheet
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SpriteSheet.BuilderImplements
SpriteSheetOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SpriteSheet.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| SpriteSheet.Builder |
build()
public SpriteSheet build()| Type | Description |
| SpriteSheet |
buildPartial()
public SpriteSheet buildPartial()| Type | Description |
| SpriteSheet |
clear()
public SpriteSheet.Builder clear()| Type | Description |
| SpriteSheet.Builder |
clearColumnCount()
public SpriteSheet.Builder clearColumnCount()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 |
| SpriteSheet.Builder | This builder for chaining. |
clearEndTimeOffset()
public SpriteSheet.Builder clearEndTimeOffset() 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 |
| SpriteSheet.Builder |
clearExtractionStrategy()
public SpriteSheet.Builder clearExtractionStrategy()| Type | Description |
| SpriteSheet.Builder |
clearField(Descriptors.FieldDescriptor field)
public SpriteSheet.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| SpriteSheet.Builder |
clearFilePrefix()
public SpriteSheet.Builder clearFilePrefix() 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 |
| SpriteSheet.Builder | This builder for chaining. |
clearFormat()
public SpriteSheet.Builder clearFormat() Format type. The default is jpeg.
Supported formats:
jpeg
string format = 1;
| Type | Description |
| SpriteSheet.Builder | This builder for chaining. |
clearInterval()
public SpriteSheet.Builder clearInterval() Starting from 0s, create sprites at regular intervals. Specify the
interval value in seconds.
.google.protobuf.Duration interval = 10;
| Type | Description |
| SpriteSheet.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public SpriteSheet.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| SpriteSheet.Builder |
clearQuality()
public SpriteSheet.Builder clearQuality()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 |
| SpriteSheet.Builder | This builder for chaining. |
clearRowCount()
public SpriteSheet.Builder clearRowCount()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 |
| SpriteSheet.Builder | This builder for chaining. |
clearSpriteHeightPixels()
public SpriteSheet.Builder clearSpriteHeightPixels()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).
int32 sprite_height_pixels = 4 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| SpriteSheet.Builder | This builder for chaining. |
clearSpriteWidthPixels()
public SpriteSheet.Builder clearSpriteWidthPixels()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).
int32 sprite_width_pixels = 3 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| SpriteSheet.Builder | This builder for chaining. |
clearStartTimeOffset()
public SpriteSheet.Builder clearStartTimeOffset() 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 |
| SpriteSheet.Builder |
clearTotalCount()
public SpriteSheet.Builder clearTotalCount()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 |
| SpriteSheet.Builder | This builder for chaining. |
clone()
public SpriteSheet.Builder clone()| Type | Description |
| SpriteSheet.Builder |
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()| Type | Description |
| SpriteSheet |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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. |
getEndTimeOffsetBuilder()
public Duration.Builder getEndTimeOffsetBuilder() 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 |
| Builder |
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;
| Type | Description |
| DurationOrBuilder |
getExtractionStrategyCase()
public SpriteSheet.ExtractionStrategyCase getExtractionStrategyCase()| Type | Description |
| SpriteSheet.ExtractionStrategyCase |
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. |
getFormat()
public String getFormat() Format type. The default is jpeg.
Supported formats:
jpeg
string format = 1;
| Type | Description |
| String | The format. |
getFormatBytes()
public ByteString getFormatBytes() Format type. The default is jpeg.
Supported formats:
jpeg
string format = 1;
| Type | Description |
| ByteString | The bytes for format. |
getInterval()
public Duration getInterval() Starting from 0s, create sprites at regular intervals. Specify the
interval value in seconds.
.google.protobuf.Duration interval = 10;
| Type | Description |
| Duration | The interval. |
getIntervalBuilder()
public Duration.Builder getIntervalBuilder() Starting from 0s, create sprites at regular intervals. Specify the
interval value in seconds.
.google.protobuf.Duration interval = 10;
| Type | Description |
| Builder |
getIntervalOrBuilder()
public DurationOrBuilder getIntervalOrBuilder() Starting from 0s, create sprites at regular intervals. Specify the
interval value in seconds.
.google.protobuf.Duration interval = 10;
| Type | Description |
| DurationOrBuilder |
getQuality()
public int 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()
public int 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. |
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).
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).
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. |
getStartTimeOffsetBuilder()
public Duration.Builder getStartTimeOffsetBuilder() 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 |
| Builder |
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;
| Type | Description |
| DurationOrBuilder |
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeEndTimeOffset(Duration value)
public SpriteSheet.Builder mergeEndTimeOffset(Duration value) 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;
| Name | Description |
| value | Duration |
| Type | Description |
| SpriteSheet.Builder |
mergeFrom(SpriteSheet other)
public SpriteSheet.Builder mergeFrom(SpriteSheet other)| Name | Description |
| other | SpriteSheet |
| Type | Description |
| SpriteSheet.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SpriteSheet.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| SpriteSheet.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public SpriteSheet.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| SpriteSheet.Builder |
mergeInterval(Duration value)
public SpriteSheet.Builder mergeInterval(Duration value) Starting from 0s, create sprites at regular intervals. Specify the
interval value in seconds.
.google.protobuf.Duration interval = 10;
| Name | Description |
| value | Duration |
| Type | Description |
| SpriteSheet.Builder |
mergeStartTimeOffset(Duration value)
public SpriteSheet.Builder mergeStartTimeOffset(Duration value) 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;
| Name | Description |
| value | Duration |
| Type | Description |
| SpriteSheet.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SpriteSheet.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| SpriteSheet.Builder |
setColumnCount(int value)
public SpriteSheet.Builder setColumnCount(int value)The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.
int32 column_count = 5;
| Name | Description |
| value | intThe columnCount to set. |
| Type | Description |
| SpriteSheet.Builder | This builder for chaining. |
setEndTimeOffset(Duration value)
public SpriteSheet.Builder setEndTimeOffset(Duration value) 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;
| Name | Description |
| value | Duration |
| Type | Description |
| SpriteSheet.Builder |
setEndTimeOffset(Duration.Builder builderForValue)
public SpriteSheet.Builder setEndTimeOffset(Duration.Builder builderForValue) 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;
| Name | Description |
| builderForValue | Builder |
| Type | Description |
| SpriteSheet.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public SpriteSheet.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| SpriteSheet.Builder |
setFilePrefix(String value)
public SpriteSheet.Builder setFilePrefix(String value) 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];
| Name | Description |
| value | StringThe filePrefix to set. |
| Type | Description |
| SpriteSheet.Builder | This builder for chaining. |
setFilePrefixBytes(ByteString value)
public SpriteSheet.Builder setFilePrefixBytes(ByteString value) 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];
| Name | Description |
| value | ByteStringThe bytes for filePrefix to set. |
| Type | Description |
| SpriteSheet.Builder | This builder for chaining. |
setFormat(String value)
public SpriteSheet.Builder setFormat(String value) Format type. The default is jpeg.
Supported formats:
jpeg
string format = 1;
| Name | Description |
| value | StringThe format to set. |
| Type | Description |
| SpriteSheet.Builder | This builder for chaining. |
setFormatBytes(ByteString value)
public SpriteSheet.Builder setFormatBytes(ByteString value) Format type. The default is jpeg.
Supported formats:
jpeg
string format = 1;
| Name | Description |
| value | ByteStringThe bytes for format to set. |
| Type | Description |
| SpriteSheet.Builder | This builder for chaining. |
setInterval(Duration value)
public SpriteSheet.Builder setInterval(Duration value) Starting from 0s, create sprites at regular intervals. Specify the
interval value in seconds.
.google.protobuf.Duration interval = 10;
| Name | Description |
| value | Duration |
| Type | Description |
| SpriteSheet.Builder |
setInterval(Duration.Builder builderForValue)
public SpriteSheet.Builder setInterval(Duration.Builder builderForValue) Starting from 0s, create sprites at regular intervals. Specify the
interval value in seconds.
.google.protobuf.Duration interval = 10;
| Name | Description |
| builderForValue | Builder |
| Type | Description |
| SpriteSheet.Builder |
setQuality(int value)
public SpriteSheet.Builder setQuality(int value)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;
| Name | Description |
| value | intThe quality to set. |
| Type | Description |
| SpriteSheet.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SpriteSheet.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| SpriteSheet.Builder |
setRowCount(int value)
public SpriteSheet.Builder setRowCount(int value)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;
| Name | Description |
| value | intThe rowCount to set. |
| Type | Description |
| SpriteSheet.Builder | This builder for chaining. |
setSpriteHeightPixels(int value)
public SpriteSheet.Builder setSpriteHeightPixels(int value)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).
int32 sprite_height_pixels = 4 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| value | intThe spriteHeightPixels to set. |
| Type | Description |
| SpriteSheet.Builder | This builder for chaining. |
setSpriteWidthPixels(int value)
public SpriteSheet.Builder setSpriteWidthPixels(int value)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).
int32 sprite_width_pixels = 3 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| value | intThe spriteWidthPixels to set. |
| Type | Description |
| SpriteSheet.Builder | This builder for chaining. |
setStartTimeOffset(Duration value)
public SpriteSheet.Builder setStartTimeOffset(Duration value) 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;
| Name | Description |
| value | Duration |
| Type | Description |
| SpriteSheet.Builder |
setStartTimeOffset(Duration.Builder builderForValue)
public SpriteSheet.Builder setStartTimeOffset(Duration.Builder builderForValue) 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;
| Name | Description |
| builderForValue | Builder |
| Type | Description |
| SpriteSheet.Builder |
setTotalCount(int value)
public SpriteSheet.Builder setTotalCount(int value)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;
| Name | Description |
| value | intThe totalCount to set. |
| Type | Description |
| SpriteSheet.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final SpriteSheet.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| SpriteSheet.Builder |