AutoMovie API
    Preparing search index...

    Interface IAutoMovieProductionRenderJobPlan

    One tier's render plan, containing its output frame ranges and non-video tracks.

    planProductionRenderJob builds it from supplied timeline and runtime inputs. Proxy and final plans share editFingerprint and differ in tier, projected frame format, frame count and chunks. Current repository callers are planner tests; a maintained application does not acquire, validate or execute stored plans through this record.

    interface IAutoMovieProductionRenderJobPlan {
        chunkFrames: number;
        chunks: IAutoMovieProductionRenderChunk[];
        compileFingerprint: string;
        editFingerprint: string;
        frameFormat: {
            colorSpace: "srgb";
            crop?: IAutoMovieDeliveryCrop;
            fps: number;
            frameRate?: IAutoMovieProductionFrameRate;
            height: number;
            width: number;
        };
        productionId: string;
        runtimeIdentity: IAutoMovieProductionRenderRuntimeIdentity;
        sourceFrameFormat: {
            colorSpace: "srgb";
            crop?: IAutoMovieDeliveryCrop;
            fps: number;
            frameRate?: IAutoMovieProductionFrameRate;
            height: number;
            width: number;
        };
        tier: IAutoMovieProductionRenderTier;
        totalFrames: number;
        tracks: {
            audio: {
                asset: string;
                bus: "dialogue"
                | "music"
                | "effects"
                | "ambience";
                durationFrames: number;
                fadeInFrames: number;
                fadeOutFrames: number;
                gain: number;
                id: string;
                sourceDurationFrames: number;
                sourceOffsetFrame: number;
                startFrame: number;
            }[];
            audioAssets: IAutoMovieProductionAudioAssetIdentity[];
            captions: string;
            effects: IAutoMovieCompiledFilmEffect[];
        };
        version: 4;
    }
    Index
    chunkFrames: number

    Maximum number of output frames in one chunk; a positive safe integer.

    Chunks in deliverable declaration order, each deliverable's ranges in frame order.

    compileFingerprint: string

    The timeline's compiler input fingerprint, shared by every capture.

    editFingerprint: string

    Digest of the builder-owned film edit, equal for proxy and final.

    frameFormat: {
        colorSpace: "srgb";
        crop?: IAutoMovieDeliveryCrop;
        fps: number;
        frameRate?: IAutoMovieProductionFrameRate;
        height: number;
        width: number;
    }

    Raster and frame clock of the tier output, projected from the source.

    Type Declaration

    • colorSpace: "srgb"

      Output color space.

    • Optionalcrop?: IAutoMovieDeliveryCrop

      Optional normalized delivery-gate window projected onto the full output raster. Omission and the complete 0,0,1,1 window are geometric no-ops.

    • fps: number

      Finite frames per second, strictly above zero.

    • OptionalframeRate?: IAutoMovieProductionFrameRate

      Exact frame rate when fps is fractional. Integer legacy rates use an equivalent denominator of one when this field is omitted.

    • height: number

      Integer pixel height from 16 through 16,384. Width times height may not exceed 16,777,216 pixels, the exact-frame review capture ceiling.

    • width: number

      Integer pixel width from 16 through 16,384. Width times height may not exceed 16,777,216 pixels, the exact-frame review capture ceiling.

    productionId: string

    Production id, which namespaces every slot and output path.

    Capture and encoder identity every chunk renders under.

    sourceFrameFormat: {
        colorSpace: "srgb";
        crop?: IAutoMovieDeliveryCrop;
        fps: number;
        frameRate?: IAutoMovieProductionFrameRate;
        height: number;
        width: number;
    }

    The production's own full-quality raster and frame clock.

    Type Declaration

    • colorSpace: "srgb"

      Output color space.

    • Optionalcrop?: IAutoMovieDeliveryCrop

      Optional normalized delivery-gate window projected onto the full output raster. Omission and the complete 0,0,1,1 window are geometric no-ops.

    • fps: number

      Finite frames per second, strictly above zero.

    • OptionalframeRate?: IAutoMovieProductionFrameRate

      Exact frame rate when fps is fractional. Integer legacy rates use an equivalent denominator of one when this field is omitted.

    • height: number

      Integer pixel height from 16 through 16,384. Width times height may not exceed 16,777,216 pixels, the exact-frame review capture ceiling.

    • width: number

      Integer pixel width from 16 through 16,384. Width times height may not exceed 16,777,216 pixels, the exact-frame review capture ceiling.

    Proxy or final tier; final is scale one and step one.

    totalFrames: number

    Number of tier output frames, the timeline length divided by the step.

    tracks: {
        audio: {
            asset: string;
            bus: "dialogue" | "music" | "effects" | "ambience";
            durationFrames: number;
            fadeInFrames: number;
            fadeOutFrames: number;
            gain: number;
            id: string;
            sourceDurationFrames: number;
            sourceOffsetFrame: number;
            startFrame: number;
        }[];
        audioAssets: IAutoMovieProductionAudioAssetIdentity[];
        captions: string;
        effects: IAutoMovieCompiledFilmEffect[];
    }

    Planned non-video tracks; this value does not publish or execute them.

    Type Declaration

    • audio: {
          asset: string;
          bus: "dialogue" | "music" | "effects" | "ambience";
          durationFrames: number;
          fadeInFrames: number;
          fadeOutFrames: number;
          gain: number;
          id: string;
          sourceDurationFrames: number;
          sourceOffsetFrame: number;
          startFrame: number;
      }[]

      The timeline's audio placements, copied unchanged.

    • audioAssets: IAutoMovieProductionAudioAssetIdentity[]

      Validated identity of every supplied audio asset, sorted by path.

    • captions: string

      Canonical WebVTT text of the timeline's caption placements.

    • effects: IAutoMovieCompiledFilmEffect[]

      The current film-global effect runtimes, copied unchanged.

    version: 4

    Plan schema version.