# CreatorAPI
Main API interface.

{/* Do not edit this file. It is automatically generated by API Documenter. */}

## CreatorAPI interface

Main API interface.

**Signature:**

```typescript
interface CreatorAPI
```

## Remarks

This is the primary interface for interacting with LottieFiles Creator. Access it via the global `creator` object.

## Properties

<table>
  <thead>
    <tr>
      <th>
        Property
      </th>

      <th>
        Modifiers
      </th>

      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        [activeScene](/en/creator-api/globals/creator-api/active-scene)
      </td>

      <td>
        `readonly`
      </td>

      <td>
        [Scene](/en/creator-api/nodes/scene)
      </td>

      <td>
        The currently active scene
      </td>
    </tr>

    <tr>
      <td>
        [apiVersion](/en/creator-api/globals/creator-api/api-version)
      </td>

      <td>
        `readonly`
      </td>

      <td>
        [APIVersion](/en/creator-api/types/api-version)
      </td>

      <td>
        The API version being used
      </td>
    </tr>

    <tr>
      <td>
        [assets](/en/creator-api/globals/creator-api/assets)
      </td>

      <td>
        `readonly`
      </td>

      <td>
        ReadonlyArray\<[Asset](/en/creator-api/types/asset)>
      </td>

      <td>
        Array of all scene, image, audio, and uploaded font assets in the project.
      </td>
    </tr>

    <tr>
      <td>
        [clientStorage](/en/creator-api/globals/creator-api/client-storage)
      </td>

      <td>
        `readonly`
      </td>

      <td>
        [ClientStorage](/en/creator-api/types/client-storage)
      </td>

      <td>
        Browser storage for persistent data.
      </td>
    </tr>

    <tr>
      <td>
        [closePlugin](/en/creator-api/globals/creator-api/close-plugin)
      </td>

      <td />

      <td>
        () => void
      </td>

      <td>
        Closes the plugin and stops it from running
      </td>
    </tr>

    <tr>
      <td>
        [openLink](/en/creator-api/globals/creator-api/open-link)
      </td>

      <td />

      <td>
        (url: string) => void
      </td>

      <td>
        Opens an external link in the user's default browser
      </td>
    </tr>

    <tr>
      <td>
        [scenes](/en/creator-api/globals/creator-api/scenes)
      </td>

      <td>
        `readonly`
      </td>

      <td>
        ReadonlyArray\<[Scene](/en/creator-api/nodes/scene)>
      </td>

      <td>
        Array of all scenes in the animation
      </td>
    </tr>

    <tr>
      <td>
        [selection](/en/creator-api/globals/creator-api/selection)
      </td>

      <td>
        `readonly`
      </td>

      <td>
        [SelectionAPI](/en/creator-api/types/selection-api)
      </td>

      <td>
        API for accessing the currently selected nodes and keyframes
      </td>
    </tr>

    <tr>
      <td>
        [switchToScene](/en/creator-api/globals/creator-api/switch-to-scene)
      </td>

      <td />

      <td>
        (scene: [Scene](/en/creator-api/nodes/scene)) => void
      </td>

      <td>
        Switches to a different scene
      </td>
    </tr>

    <tr>
      <td>
        [timeline](/en/creator-api/globals/creator-api/timeline)
      </td>

      <td>
        `readonly`
      </td>

      <td>
        [TimelineAPI](/en/creator-api/types/timeline-api)
      </td>

      <td>
        API for timeline playback control
      </td>
    </tr>

    <tr>
      <td>
        [ui](/en/creator-api/globals/creator-api/ui)
      </td>

      <td>
        `readonly`
      </td>

      <td>
        [UIAPI](/en/creator-api/types/uiapi)
      </td>

      <td>
        API for managing the UI window
      </td>
    </tr>

    <tr>
      <td>
        [utils](/en/creator-api/globals/creator-api/utils)
      </td>

      <td>
        `readonly`
      </td>

      <td>
        [UtilsAPI](/en/creator-api/utils-api)
      </td>

      <td>
        Utility helpers for working with the plugin API.
      </td>
    </tr>
  </tbody>
</table>

## Methods

<table>
  <thead>
    <tr>
      <th>
        Method
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        [createScene(opts)](/en/creator-api/globals/creator-api/create-scene)
      </td>

      <td>
        Creates a new scene.
      </td>
    </tr>

    <tr>
      <td>
        [getAvailableFonts()](/en/creator-api/globals/creator-api/get-available-fonts)
      </td>

      <td>
        Returns the font catalog available to this project, including Creator's curated preset fonts, Google Fonts, and uploaded font assets.
      </td>
    </tr>

    <tr>
      <td>
        [off(type, callback)](/en/creator-api/globals/creator-api/off)
      </td>

      <td>
        Removes an event listener
      </td>
    </tr>

    <tr>
      <td>
        [on(type, callback)](/en/creator-api/globals/creator-api/on)
      </td>

      <td>
        Registers an event listener for events
      </td>
    </tr>
  </tbody>
</table>