Class SpriteSheet.Builder (1.79.0)

publicstaticfinalclass SpriteSheet.BuilderextendsGeneratedMessageV3.Builder<SpriteSheet.Builder>implementsSpriteSheetOrBuilder

Sprite sheet configuration.

Protobuf type google.cloud.video.transcoder.v1.SpriteSheet

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SpriteSheet.Builder

Implements

SpriteSheetOrBuilder

Inherited Members

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicSpriteSheet.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicSpriteSheetbuild()

publicSpriteSheetbuildPartial()

publicSpriteSheet.Builderclear()

GeneratedMessageV3.Builder<BuilderType>.clear()

publicSpriteSheet.BuilderclearColumnCount()

The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.

int32 column_count = 5;

publicSpriteSheet.BuilderclearEndTimeOffset()

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;

publicSpriteSheet.BuilderclearExtractionStrategy()

publicSpriteSheet.BuilderclearField(Descriptors.FieldDescriptorfield)

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

publicSpriteSheet.BuilderclearFilePrefix()

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];

publicSpriteSheet.BuilderclearFormat()

Format type. The default is jpeg.

Supported formats:

• jpeg

string format = 1;

publicSpriteSheet.BuilderclearInterval()

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

.google.protobuf.Duration interval = 10;

publicSpriteSheet.BuilderclearOneof(Descriptors.OneofDescriptoroneof)

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

publicSpriteSheet.BuilderclearQuality()

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;

publicSpriteSheet.BuilderclearRowCount()

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;

publicSpriteSheet.BuilderclearSpriteHeightPixels()

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];

publicSpriteSheet.BuilderclearSpriteWidthPixels()

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];

publicSpriteSheet.BuilderclearStartTimeOffset()

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;

publicSpriteSheet.BuilderclearTotalCount()

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;

publicSpriteSheet.Builderclone()

GeneratedMessageV3.Builder<BuilderType>.clone()

publicintgetColumnCount()

The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.

int32 column_count = 5;

publicSpriteSheetgetDefaultInstanceForType()

publicDescriptors.DescriptorgetDescriptorForType()

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

publicDurationgetEndTimeOffset()

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;

publicDuration.BuildergetEndTimeOffsetBuilder()

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;

publicDurationOrBuildergetEndTimeOffsetOrBuilder()

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;

publicSpriteSheet.ExtractionStrategyCasegetExtractionStrategyCase()

publicStringgetFilePrefix()

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];

publicByteStringgetFilePrefixBytes()

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];

publicStringgetFormat()

Format type. The default is jpeg.

Supported formats:

• jpeg

string format = 1;

publicByteStringgetFormatBytes()

Format type. The default is jpeg.

Supported formats:

• jpeg

string format = 1;

publicDurationgetInterval()

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

.google.protobuf.Duration interval = 10;

publicDuration.BuildergetIntervalBuilder()

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

.google.protobuf.Duration interval = 10;

publicDurationOrBuildergetIntervalOrBuilder()

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

.google.protobuf.Duration interval = 10;

publicintgetQuality()

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;

publicintgetRowCount()

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;

publicintgetSpriteHeightPixels()

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];

publicintgetSpriteWidthPixels()

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];

publicDurationgetStartTimeOffset()

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;

publicDuration.BuildergetStartTimeOffsetBuilder()

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;

publicDurationOrBuildergetStartTimeOffsetOrBuilder()

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;

publicintgetTotalCount()

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;

publicbooleanhasEndTimeOffset()

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;

publicbooleanhasInterval()

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

.google.protobuf.Duration interval = 10;

publicbooleanhasStartTimeOffset()

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;

publicbooleanhasTotalCount()

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;

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

publicfinalbooleanisInitialized()

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

publicSpriteSheet.BuildermergeEndTimeOffset(Durationvalue)

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;

publicSpriteSheet.BuildermergeFrom(SpriteSheetother)

publicSpriteSheet.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicSpriteSheet.BuildermergeFrom(Messageother)

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

publicSpriteSheet.BuildermergeInterval(Durationvalue)

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

.google.protobuf.Duration interval = 10;

publicSpriteSheet.BuildermergeStartTimeOffset(Durationvalue)

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;

publicfinalSpriteSheet.BuildermergeUnknownFields(UnknownFieldSetunknownFields)

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

publicSpriteSheet.BuildersetColumnCount(intvalue)

The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.

int32 column_count = 5;

publicSpriteSheet.BuildersetEndTimeOffset(Durationvalue)

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;

publicSpriteSheet.BuildersetEndTimeOffset(Duration.BuilderbuilderForValue)

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;

publicSpriteSheet.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

publicSpriteSheet.BuildersetFilePrefix(Stringvalue)

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];

publicSpriteSheet.BuildersetFilePrefixBytes(ByteStringvalue)

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];

publicSpriteSheet.BuildersetFormat(Stringvalue)

Format type. The default is jpeg.

Supported formats:

• jpeg

string format = 1;

publicSpriteSheet.BuildersetFormatBytes(ByteStringvalue)

Format type. The default is jpeg.

Supported formats:

• jpeg

string format = 1;

publicSpriteSheet.BuildersetInterval(Durationvalue)

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

.google.protobuf.Duration interval = 10;

publicSpriteSheet.BuildersetInterval(Duration.BuilderbuilderForValue)

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

.google.protobuf.Duration interval = 10;

publicSpriteSheet.BuildersetQuality(intvalue)

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;

publicSpriteSheet.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

publicSpriteSheet.BuildersetRowCount(intvalue)

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;

publicSpriteSheet.BuildersetSpriteHeightPixels(intvalue)

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];

publicSpriteSheet.BuildersetSpriteWidthPixels(intvalue)

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];

publicSpriteSheet.BuildersetStartTimeOffset(Durationvalue)

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;

publicSpriteSheet.BuildersetStartTimeOffset(Duration.BuilderbuilderForValue)

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;

publicSpriteSheet.BuildersetTotalCount(intvalue)

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;

publicfinalSpriteSheet.BuildersetUnknownFields(UnknownFieldSetunknownFields)

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)