SpriteSheet class
Sprite sheet configuration.
- Inheritance
-
- Object
- GeneratedMessage
- SpriteSheet
Constructors
- SpriteSheet({String? format, String? filePrefix, int? spriteWidthPixels, int? spriteHeightPixels, int? columnCount, int? rowCount, Duration? startTimeOffset, Duration? endTimeOffset, int? totalCount, Duration? interval, int? quality})
-
factory
-
SpriteSheet.fromBuffer(List<
int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]) -
factory
- SpriteSheet.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- columnCount ↔ int
-
The maximum number of sprites per row in a sprite sheet. The default is 0,
which indicates no maximum limit.
getter/setter pair
- endTimeOffset ↔ Duration
-
End time in seconds, relative to the output file timeline. When
end_time_offsetis not specified, the sprites are generated until the end of the output file.getter/setter pair - eventPlugin → EventPlugin?
-
Subclasses can override this getter to be notified of changes
to protobuf fields.
no setterinherited
- filePrefix ↔ String
-
Required. File name prefix for the generated sprite sheets.
getter/setter pair
- format ↔ String
-
Format type. The default is
jpeg.getter/setter pair - hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- info_ → BuilderInfo
-
no setteroverride
- interval ↔ Duration
-
Starting from
0s, create sprites at regular intervals. Specify the interval value in seconds.getter/setter pair - isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - quality ↔ int
-
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.
getter/setter pair
- rowCount ↔ int
-
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.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- spriteHeightPixels ↔ int
-
Required. The height of sprite in pixels. Must be an even integer. To
preserve the source aspect ratio, set the
google.cloud.video.transcoder.v1.SpriteSheet.sprite_height_pixelsfield or thegoogle.cloud.video.transcoder.v1.SpriteSheet.sprite_width_pixelsfield, but not both (the API will automatically calculate the missing field).getter/setter pair - spriteWidthPixels ↔ int
-
Required. The width of sprite in pixels. Must be an even integer. To
preserve the source aspect ratio, set the
google.cloud.video.transcoder.v1.SpriteSheet.sprite_width_pixelsfield or thegoogle.cloud.video.transcoder.v1.SpriteSheet.sprite_height_pixelsfield, but not both (the API will automatically calculate the missing field).getter/setter pair - startTimeOffset ↔ Duration
-
Start time in seconds, relative to the output file timeline. Determines the
first sprite to pick. The default is
0s.getter/setter pair - totalCount ↔ int
-
Total number of sprites. Create the specified number of sprites
distributed evenly across the timeline of the output media. The default
is 100.
getter/setter pair
- unknownFields → UnknownFieldSet
-
no setterinherited
Methods
-
addExtension(
Extension extension, Object? value) → void -
Adds an extension field value to a repeated field.
inherited
-
check(
) → void -
inherited
-
clear(
) → void -
Clears all data that was set in this message.
inherited
-
clearColumnCount(
) → void -
clearEndTimeOffset(
) → void -
clearExtension(
Extension extension) → void -
Clears an extension field and also removes the extension.
inherited
-
clearExtractionStrategy(
) → void -
clearField(
int tagNumber) → void -
Clears the contents of a given field.
inherited
-
clearFilePrefix(
) → void -
clearFormat(
) → void -
clearInterval(
) → void -
clearQuality(
) → void -
clearRowCount(
) → void -
clearSpriteHeightPixels(
) → void -
clearSpriteWidthPixels(
) → void -
clearStartTimeOffset(
) → void -
clearTotalCount(
) → void -
clone(
) → SpriteSheet -
Creates a deep copy of the fields in this message.
(The generated code uses mergeFromMessage.)
override
-
copyWith(
void updates(SpriteSheet)) → SpriteSheet -
Apply
updatesto a copy of this message.override -
createEmptyInstance(
) → SpriteSheet -
Creates an empty instance of the same message type as this.
override
-
createMapField<
K, V> (int tagNumber, MapFieldInfo< K, V> fi) → Map<K, V> -
Creates a Map representing a map field.
inherited
-
createRepeatedField<
T> (int tagNumber, FieldInfo< T> fi) → List<T> -
Creates List implementing a mutable repeated field.
inherited
-
ensureEndTimeOffset(
) → Duration -
ensureInterval(
) → Duration -
ensureStartTimeOffset(
) → Duration -
extensionsAreInitialized(
) → bool -
inherited
-
freeze(
) → GeneratedMessage -
Make this message read-only.
inherited
-
getDefaultForField(
int tagNumber) → dynamic -
Returns the default value for the given field.
inherited
-
getExtension(
Extension extension) → dynamic -
Returns the value of
extension.inherited -
getField(
int tagNumber) → dynamic -
Returns the value of the field associated with
tagNumber, or the default value if it is not set.inherited -
getFieldOrNull(
int tagNumber) → dynamic -
Returns the value of a field, ignoring any defaults.
inherited
-
getTagNumber(
String fieldName) → int? -
inherited
-
hasColumnCount(
) → bool -
hasEndTimeOffset(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
trueif a value ofextensionis present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber.inherited -
hasFilePrefix(
) → bool -
hasFormat(
) → bool -
hasInterval(
) → bool -
hasQuality(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasRowCount(
) → bool -
hasSpriteHeightPixels(
) → bool -
hasSpriteWidthPixels(
) → bool -
hasStartTimeOffset(
) → bool -
hasTotalCount(
) → bool -
isInitialized(
) → bool -
Whether all required fields in the message and embedded messages are set.
inherited
-
mergeFromBuffer(
List< int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges serialized protocol buffer data into this message.
inherited
-
mergeFromCodedBufferReader(
CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
inherited
-
mergeFromJson(
String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from
data, a JSON object, encoded as described byGeneratedMessage.writeToJson.inherited -
mergeFromJsonMap(
Map< String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from a JSON object represented as a Dart map.
inherited
-
mergeFromMessage(
GeneratedMessage other) → void -
Merges the contents of the
otherinto this message.inherited -
mergeFromProto3Json(
Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void -
Merges field values from
json, a JSON object using proto3 encoding.inherited -
mergeUnknownFields(
UnknownFieldSet unknownFieldSet) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setExtension(
Extension extension, Object value) → void -
Sets the value of a non-repeated extension field to
value.inherited -
setField(
int tagNumber, Object value) → void -
Sets the value of a field by its
tagNumber.inherited -
toBuilder(
) → GeneratedMessage -
Creates a writable, shallow copy of this message.
inherited
-
toDebugString(
) → String -
Returns a String representation of this message.
inherited
-
toProto3Json(
{TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object? -
Returns an Object representing Proto3 JSON serialization of
this.inherited -
toString(
) → String -
Returns a String representation of this message.
inherited
-
whichExtractionStrategy(
) → SpriteSheet_ExtractionStrategy -
writeToBuffer(
) → Uint8List -
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
inherited
-
writeToJson(
) → String -
Returns a JSON string that encodes this message.
inherited
-
writeToJsonMap(
) → Map< String, dynamic> -
Returns the JSON encoding of this message as a Dart Map.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
) → SpriteSheet -
createRepeated(
) → PbList< SpriteSheet> -
getDefault(
) → SpriteSheet