DiffusionProgress class


Streamed progress event. Sources pre-IDL: Swift DiffusionTypes.swift:511 (DiffusionProgress) Kotlin DiffusionTypes.kt:337 (DiffusionProgress) RN DiffusionTypes.ts:163 (DiffusionProgress) Web DiffusionTypes.ts:69 (callback signature, not a struct) C ABI rac_diffusion_types.h:279 (rac_diffusion_progress_t)

Available extensions

Constructors

DiffusionProgress({double? progressPercent, int? currentStep, int? totalSteps, String? stage, List<int>? intermediateImageData, int? intermediateImageWidth, int? intermediateImageHeight, Int64? timestampMs, Int64? etaMs, String? intermediateImageMediaType})
factory
DiffusionProgress.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
DiffusionProgress.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

currentStep int
1-based current step number.
getter/setter pair
etaMs ↔ Int64
getter/setter pair
hashCode int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setter
intermediateImageData List<int>
Optional intermediate image bytes (PNG when surfaced by Swift/Kotlin/RN; raw RGBA when surfaced by the C ABI). Present only when the caller requested intermediate-image reporting and the engine has produced one for this step.
getter/setter pair
intermediateImageHeight int
getter/setter pair
intermediateImageMediaType String
getter/setter pair
intermediateImageWidth int
Dimensions for intermediate_image_data when it is raw pixel data.
getter/setter pair
isFrozen bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
progressPercent double
Fraction of denoising completed in 0.0, 1.0.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
stage String
Free-form stage name ("Encoding", "Denoising", "Decoding", …).
getter/setter pair
timestampMs ↔ Int64
getter/setter pair
totalSteps int
Total number of steps the engine plans to execute.
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
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
clearCurrentStep() → void
clearEtaMs() → 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
clearIntermediateImageData() → void
clearIntermediateImageHeight() → void
clearIntermediateImageMediaType() → void
clearIntermediateImageWidth() → void
clearProgressPercent() → void
clearStage() → void
clearTimestampMs() → void
clearTotalSteps() → void
clone() DiffusionProgress
Creates a deep copy of the fields in this message.
copyWith(void updates(DiffusionProgress)) DiffusionProgress
Apply updates to a copy of this message.
createEmptyInstance() DiffusionProgress
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
hasCurrentStep() bool
hasEtaMs() bool
hasExtension(Extension extension) bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) bool
Whether this message has a field associated with tagNumber.
inherited
hasIntermediateImageData() bool
hasIntermediateImageHeight() bool
hasIntermediateImageMediaType() bool
hasIntermediateImageWidth() bool
hasProgressPercent() bool
hasRequiredFields() bool
Whether the message has required fields.
inherited
hasStage() bool
hasTimestampMs() bool
hasTotalSteps() 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 a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.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 other into 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

Apply updates to 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
writeToBuffer() Uint8List
Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
Same as writeToBuffer, but serializes to the given CodedBufferWriter.
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