Assets

Asset definitions and references

Assets

The assets field defines reusable resources that can be referenced throughout the schema.

Field Definition

interface Assets {
  fonts?: FontAsset[];
  images?: ImageAsset[];
  videos?: VideoAsset[];
  audios?: AudioAsset[];
  subtitles?: SubtitleAsset[];
}

Example

{
  "assets": {
    "fonts": [
      {
        "id": "heading-font",
        "src": "https://fonts.googleapis.com/css2?family=Inter",
        "family": "Inter"
      }
    ],
    "images": [
      {
        "id": "logo",
        "src": "https://example.com/logo.png"
      }
    ],
    "videos": [
      {
        "id": "intro",
        "src": "https://example.com/intro.mp4"
      }
    ]
  }
}

Asset References

Use $ref to reference assets in clips:

{
  "type": "text",
  "style": {
    "fontFamily": { "$ref": "heading-font" }
  }
}
{
  "type": "image",
  "src": { "$ref": "logo" }
}

Asset Types

TypeDescriptionRequired Fields
FontAssetCustom fontsid, src, family
ImageAssetImage filesid, src
VideoAssetVideo filesid, src
AudioAssetAudio filesid, src
SubtitleAssetSubtitle dataid, words