Class ProjectSchemaBuilder

Builder class for creating ProjectSchema with custom settings

Index

Constructors

Methods

createDefault createForExport createForPreview createForSectionExport build withCustomSettings withExportSettings withMetadata withPreviewSettings withTimeRange

Constructors

constructor

new ProjectSchemaBuilder(
timeline: Timeline,
projectName?: string,
): ProjectSchemaBuilder
Parameters
- timeline: Timeline
- OptionalprojectName: string
Returns ProjectSchemaBuilder
- Defined in src/features/export/utils/project-schema-builder.ts:70

Methods

`Static`createDefault

createDefault(timeline: Timeline, projectName?: string): ProjectSchema
Create ProjectSchema with sensible defaults from Timeline
Parameters
- timeline: Timeline
- OptionalprojectName: string
Returns ProjectSchema
- Defined in src/features/export/utils/project-schema-builder.ts:242

`Static`createForExport

createForExport(
    timeline: Timeline,
    exportSettings: ExportSettings,
    projectName?: string,
): ProjectSchema
Create ProjectSchema optimized for export
Parameters
- timeline: Timeline
- exportSettings: ExportSettings
- OptionalprojectName: string
Returns ProjectSchema
- Defined in src/features/export/utils/project-schema-builder.ts:249

`Static`createForPreview

createForPreview(
    timeline: Timeline,
    previewSettings?: {
        fps?: number;
        quality?: number;
        resolution?: [number, number];
    },
): ProjectSchema
Create ProjectSchema optimized for preview
Parameters
- timeline: Timeline
- OptionalpreviewSettings: { fps?: number; quality?: number; resolution?: [number, number] }
Returns ProjectSchema
- Defined in src/features/export/utils/project-schema-builder.ts:256

`Static`createForSectionExport

createForSectionExport(
    timeline: Timeline,
    exportSettings: ExportSettings,
    startTime: number,
    endTime: number,
    sectionName?: string,
): ProjectSchema
Create ProjectSchema for section export with time range
Parameters
- timeline: Timeline
- exportSettings: ExportSettings
- startTime: number
- endTime: number
- OptionalsectionName: string
Returns ProjectSchema
- Defined in src/features/export/utils/project-schema-builder.ts:279

build

build(): ProjectSchema
Get the built ProjectSchema

Returns ProjectSchema
- Defined in src/features/export/utils/project-schema-builder.ts:235

withCustomSettings

withCustomSettings(customSettings: Record<string, any>): this
Apply custom settings
Parameters
- customSettings: Record<string, any>
Returns this
- Defined in src/features/export/utils/project-schema-builder.ts:163

withExportSettings

withExportSettings(exportSettings: Partial<ExportSettings>): this
Apply export settings to the project schema
Parameters
- exportSettings: Partial<ExportSettings>
Returns this
- Defined in src/features/export/utils/project-schema-builder.ts:80

withMetadata

withMetadata(metadata: ProjectSchema): this
Apply custom metadata
Parameters
- metadata: ProjectSchema
Returns this
- Defined in src/features/export/utils/project-schema-builder.ts:151

withPreviewSettings

withPreviewSettings(
    previewSettings: {
        fps?: number;
        quality?: number;
        resolution?: [number, number];
    },
): this
Apply preview settings to the project schema
Parameters
- previewSettings: { fps?: number; quality?: number; resolution?: [number, number] }
Returns this
- Defined in src/features/export/utils/project-schema-builder.ts:132

withTimeRange

withTimeRange(startTime: number, endTime: number): this
Apply time range for section export
Parameters
- startTime: number
- endTime: number
Returns this
- Defined in src/features/export/utils/project-schema-builder.ts:175

Class ProjectSchemaBuilder

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ProjectSchemaBuilder

Methods

StaticcreateDefault

Parameters

Returns ProjectSchema

StaticcreateForExport

Parameters

Returns ProjectSchema

StaticcreateForPreview

Parameters

Returns ProjectSchema

StaticcreateForSectionExport

Parameters

Returns ProjectSchema

build

Returns ProjectSchema

withCustomSettings

Parameters

Returns this

withExportSettings

Parameters

Returns this

withMetadata

Parameters

Returns this

withPreviewSettings

Parameters

Returns this

withTimeRange

Parameters

Returns this

Settings

On This Page

`Static`createDefault

`Static`createForExport

`Static`createForPreview

`Static`createForSectionExport