ApiRenderRequest class final

A render request body, built on the client and sent to POST /v1/renders.

One factory per input mode (key/spec/prompt/edit); each accepts the same export options plus visibility and ttl. toJson produces the exact wire shape the server's RenderRequest.fromJson parses.

Annotations
  • @immutable

Constructors

ApiRenderRequest.code(String code, {String? format, String? aspect, String? quality, String? poster, String? visibility, String? ttl})
Render a user-submitted Dart Video build() code snippet (the Playground). The server validates and import-allowlist-gates it before rendering, returning 422 with diagnostics if it is unsafe.
factory
ApiRenderRequest.edit({required Map<String, Object?> base, required String change, String? provider, String? format, String? aspect, String? quality, String? poster, String? visibility, String? ttl})
Refine base with a natural-language change, then render it.
factory
ApiRenderRequest.key(String key, {String? format, String? aspect, String? quality, String? poster, String? visibility, String? ttl})
Render a registered composition key.
factory
ApiRenderRequest.prompt(String prompt, {String? provider, String? format, String? aspect, String? quality, String? poster, String? visibility, String? ttl})
Author a spec from a natural-language prompt, then render it.
factory
ApiRenderRequest.spec(Map<String, Object?> spec, {String? format, String? aspect, String? quality, String? poster, String? visibility, String? ttl})
Render a serialized VideoSpec spec.
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, Object?>
The request as the JSON map the server expects.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited