Skip to main content

Module video

Module video 

Source
Expand description

Video generation (feature video): generate_video supports the synchronous flow (do_generate) and the asynchronous flow (do_start/do_status, with polling or a webhook).

Design: docs/01-architecture/11-other-modalities.md §6.

Structs§

FrameImage
An input image anchored to a frame.
GenerateVideo
Builder returned by generate_video; .await runs the calls.
GenerateVideoResult
Result of generate_video.
GeneratedVideo
A generated video.
PollConfig
Polling configuration of the asynchronous flow.
VideoFile
An input file for video generation: inline bytes or a URL.
WebhookHandle
A prepared webhook: the URL to hand to the provider and a future that resolves when the callback arrives.
WebhookPayload
Payload delivered to a webhook.

Enums§

FrameType
Which frame an input image anchors.
VideoAspectRatio
Aspect ratio for video: a fixed ratio or provider-chosen (adaptive).

Functions§

generate_video
Generates videos from a text prompt.

Type Aliases§

WebhookFactory
Creates webhooks; implemented by the application (the SDK runs no server).