Interface NarrationResult

Result returned by RunNarrationPipeline.

interface NarrationResult {
    CaptionsFileID?: string;
    CaptionsVtt?: string;
    Clips: NarrationClip[];
    Issues: NarrationIssue[];
    Spec: VideoGenerationSpec;
}

Index

Properties

CaptionsFileID? CaptionsVtt? Clips Issues Spec

Properties

`Optional`CaptionsFileID

CaptionsFileID?: string

Uploaded File.ID for captions.vtt when captions were generated and stored.

`Optional`CaptionsVtt

CaptionsVtt?: string

Generated WebVTT document when Audio.Captions !== 'None'.

Clips

Clips: NarrationClip[]

Synthesized audio clips in script order.

Issues

Issues: NarrationIssue[]

Structured errors and warnings collected during synthesis, storage, and timeline fitting.

Spec

Spec: VideoGenerationSpec

Deep copy of the input spec with fitted beats, narration timings, cues, and film duration.