# TimelineAPI
API for controlling the animation timeline.

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

## TimelineAPI interface

API for controlling the animation timeline.

**Signature:**

```typescript
interface TimelineAPI
```

## Properties

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

      <th>
        Modifiers
      </th>

      <th>
        Type
      </th>

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

  <tbody>
    <tr>
      <td>
        [currentFrame](/en/creator-api/types/timeline-api/current-frame)
      </td>

      <td>
        `readonly`
      </td>

      <td>
        number
      </td>

      <td>
        The current frame number
      </td>
    </tr>

    <tr>
      <td>
        [isPlaying](/en/creator-api/types/timeline-api/is-playing)
      </td>

      <td>
        `readonly`
      </td>

      <td>
        boolean
      </td>

      <td>
        Whether the animation is currently playing
      </td>
    </tr>
  </tbody>
</table>

## Methods

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

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

  <tbody>
    <tr>
      <td>
        [goToFrame(frame)](/en/creator-api/types/timeline-api/go-to-frame)
      </td>

      <td>
        Jumps to a specific frame in the timeline
      </td>
    </tr>

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

      <td>
        Pauses the animation playback
      </td>
    </tr>

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

      <td>
        Starts playing the animation
      </td>
    </tr>
  </tbody>
</table>