Project encapsulates all the elements, clips, and settings that make up your final video output.

Properties

PropertyTypeDefaultDescription
idstringuuid()A unique identifier for the project.
titlestringUntitledThe name of your project.
ratiostring9:16The aspect ratio of your video (e.g., 16:9, 9:16, 4:3, 1:1)
sharebooleanfalseWhether the project is public shared or private
themeobject-Global styling settings for your project (see Theme for more details)
clipsarray[]An array of Clip objects that make up your video.

Usage

Here’s an example of how to create a new Project using the BlendDuck SDK:

import BlendDuck, { Project, Clip } from "@blendduck/node-sdk";

const client = new BlendDuck({
  apiKey: process.env.BLENDDUCK_API_KEY
});

const project = new Project();
project.title = "My Awesome Video";
project.ratio = "16:9";
project.share = false;

// Add clips to your project
const clip1 = new Clip(5); // 5-second clip
project.addClip(clip1);

// Create the project on BlendDuck
const projectId = await client.projects.create(project);
console.log(`New project created with ID: ${projectId}`);

Get the final JSON representing of the Project

const json = project.toJSON();

You can create Project by JSON directly

const project = Project.fromJSON(json)