hao-ai-lab-FastVideo/docs/getting_started/v1_api.md

V1 API

FastVideo's V1 API provides a streamlined interface for video generation tasks with powerful customization options. This page documents the primary components of the API.

Video Generator

This class will be the primary Python API for generating videos and images.

`VideoGenerator.from_pretrained()` should be the primary way of creating a new video generator.

Configuring FastVideo

The following two classes PipelineConfig and SamplingParam are used to configure initialization and sampling parameters, respectively.

PipelineConfig

### SamplingParam ### Returning samples without previews

Set OutputConfig(return_samples=True, return_frames=False, save_video=False) to receive the decoded CPU tensor in GenerationResult.samples without building preview grids or writing media. Pixel samples retain the existing float [0, 1] contract. return_frames=True continues to return both samples and preview frames. The legacy sampling/keyword interface accepts the same return_samples option.