VLMImage class
VLM image input.
source is a oneof so that exactly one of {file_path, encoded, raw_rgb,
base64} can be supplied per request. width / height are required for
non-encoded formats (raw_rgb, raw_rgba) where the consumer cannot infer
dimensions from a container header. format disambiguates encoded bytes
payloads (JPEG / PNG / WEBP) and explicitly tags raw / file-path / base64
sources.
- Available extensions
Constructors
-
VLMImage({String? filePath, List<
int> ? encoded, List<int> ? rawRgb, String? base64, int? width, int? height, VLMImageFormat? format, String? mediaType, String? name, Int64? sizeBytes, Iterable<MapEntry< ? metadata})String, String> > -
factory
-
VLMImage.fromBuffer(List<
int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]) -
factory
- VLMImage.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- base64 ↔ String
-
getter/setter pair
-
encoded
↔ List<
int> -
getter/setter pair
- filePath ↔ String
-
getter/setter pair
- format ↔ VLMImageFormat
-
getter/setter pair
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- height ↔ int
-
getter/setter pair
- info_ → BuilderInfo
-
no setter
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - mediaType ↔ String
-
Optional source metadata. Adapters may populate this after camera/file
picker capture without exposing native APIs to core.
getter/setter pair
-
metadata
→ PbMap<
String, String> -
no setter
- name ↔ String
-
getter/setter pair
-
rawRgb
↔ List<
int> -
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sizeBytes ↔ Int64
-
getter/setter pair
- unknownFields → UnknownFieldSet
-
no setterinherited
- width ↔ int
-
Required for VLM_IMAGE_FORMAT_RAW_RGB and VLM_IMAGE_FORMAT_RAW_RGBA
(consumers cannot infer dimensions for raw pixel buffers). Optional
for encoded / file_path / base64 sources where the decoder reads
dimensions from the container.
getter/setter pair
Methods
-
addExtension(
Extension extension, Object? value) → void -
Adds an extension field value to a repeated field.
inherited
-
check(
) → void -
Throws a StateError if the message has required fields without a value.
inherited
-
clear(
) → void -
Clears all data that was set in this message.
inherited
-
clearBase64(
) → void -
clearEncoded(
) → void -
clearExtension(
Extension extension) → void -
Clears an extension field and also removes the extension.
inherited
-
clearField(
int tagNumber) → void -
Clears the contents of a given field.
inherited
-
clearFilePath(
) → void -
clearFormat(
) → void -
clearHeight(
) → void -
clearMediaType(
) → void -
clearName(
) → void -
clearRawRgb(
) → void -
clearSizeBytes(
) → void -
clearSource(
) → void -
clearWidth(
) → void -
clone(
) → VLMImage - Creates a deep copy of the fields in this message.
-
copyWith(
void updates(VLMImage)) → VLMImage -
Apply
updatesto a copy of this message. -
createEmptyInstance(
) → VLMImage - Creates an empty instance of the same message type as this.
-
deepCopy(
) → T -
Available on T, provided by the GeneratedMessageGenericExtensions extension
Returns a writable deep copy of this message. -
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
-
hasBase64(
) → bool -
hasEncoded(
) → 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 -
hasFilePath(
) → bool -
hasFormat(
) → bool -
hasHeight(
) → bool -
hasMediaType(
) → bool -
hasName(
) → bool -
hasRawRgb(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasSizeBytes(
) → bool -
hasWidth(
) → 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 -
Same as
mergeFromBuffer, but takes aCodedBufferReaderinput.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
-
rebuild(
void updates(T)) → T -
Available on T, provided by the GeneratedMessageGenericExtensions extension
Applyupdatesto a copy of this message. -
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
-
whichSource(
) → VLMImage_Source -
writeToBuffer(
) → Uint8List -
Serialize the message as the protobuf binary format.
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
Same as
writeToBuffer, but serializes to the givenCodedBufferWriter.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(
) → VLMImage -
getDefault(
) → VLMImage