Skip to content

GenerateVideoRequest

Namespace: Vercel.AI.Operations

public class GenerateVideoRequest : OperationRequest

Options shared by generate and start.

Inheritance: object → OperationRequest

View source

public string? AspectRatio { get; set; }

Aspect ratio.

Value: string

View source

public Func<int, CancellationToken, Task>? Delay { get; set; }

Custom delay. Defaults to CancellationToken).

Value: Func<int, CancellationToken, Task>

View source

public Func<string, CancellationToken, Task<DownloadedMedia>>? Download { get; set; }

Downloads URL videos and reference bytes are already local.

Value: Func<string, CancellationToken, Task<DownloadedMedia>>

View source

public double? Duration { get; set; }

Duration in seconds.

Value: double?

View source

public int? Fps { get; set; }

Frames per second.

Value: int?

View source

public IReadOnlyList<VideoFrameImage>? FrameImages { get; set; }

Frame images.

Value: IReadOnlyList<VideoFrameImage>

View source

public bool? GenerateAudio { get; set; }

Whether to generate audio.

Value: bool?

View source

public Func<string>? GenerateId { get; set; }

Supplies idempotency suffixes. Default is a guid.

Value: Func<string>

View source

public IReadOnlyList<VideoReference>? InputReferences { get; set; }

Input references.

Value: IReadOnlyList<VideoReference>

View source

public int? MaxVideosPerCall { get; set; }

Overrides the model limit.

Value: int?

View source

public IVideoCaller? Model { get; set; }

Video model.

Value: IVideoCaller

View source

public double N { get; set; }

Number of videos. Default 1.

Value: double

View source

public bool Poll { get; set; }

True when polling was requested.

Value: bool

View source

public int? PollIntervalMs { get; set; }

Poll interval. Default 5000.

Value: int?

View source

public int? PollTimeoutMs { get; set; }

Poll or webhook timeout. Default 600000.

Value: int?

View source

public VideoPrompt? Prompt { get; set; }

Prompt.

Value: VideoPrompt

View source

public string? Resolution { get; set; }

Resolution.

Value: string

View source

public double? Seed { get; set; }

Seed.

Value: double?

View source

public Func<Task<VideoWebhook>>? Webhook { get; set; }

Webhook factory.

Value: Func<Task<VideoWebhook>>

View source

public string? WebhookUrl { get; set; }

Webhook URL forwarded by StartVideo.

Value: string

View source

Apache-2.0 · Copyright 2023 Vercel, Inc. · unofficial community port, not an official Vercel product