# `ClipInfo`

> Contract 2.0.0 · package sha256 `a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e` · generated from `configurator-runtime.d.ts` by `services/onsite-scripter/scripts/build-contract-docs.mjs`; edit the source, not this file.

Interface · `import type { ClipInfo } from '@holostep-configurators/runtime-client/contract';` · stable · since 2.0.0 · section 14. Animations

One authored clip of a loaded model. No read or event carries a clip's current time or the
direction it last played, and [`playing`](ClipInfo.playing.md) is false both at frame 0 and held at its end. A door or
drawer button keeps that state itself: set it from 'animation:finished' (the end of its play's
direction: the end, or frame 0 for a `reverse` play), never from `play`'s Promise, which also
resolves 'committed' when a `stop` cuts the play short. Then set it back to closed (frame 0, the
next `toggle` forward) on every call that returns the clip there: `stop`, `reset`, a `play` of a
clip its [`exclusiveWith`](ClipInfo.exclusiveWith.md) names, and a scene write that gives its node a new asset version or
removes it. These fire 'animation:stopped' only for a clip that was playing or paused, never for
one held at its end, so track your own calls of them. A page reload starts every clip at frame 0.

## Members

| Member | Kind | Summary |
| --- | --- | --- |
| <a id="durationms"></a>[`durationMs`](ClipInfo.durationMs.md) | property | Length at speed 1, ms. |
| <a id="playing"></a>[`playing`](ClipInfo.playing.md) | property | True while it plays (observed). |
| <a id="exclusivewith"></a>[`exclusiveWith`](ClipInfo.exclusiveWith.md) | property | The same model's clips that animate a node or joint this one does, in glTF order: a `play` of one of them returns this clip to frame 0 first (see [`Animations`](Animations.md)), firing no event when it is held at its end. |

Inherited from [`ClipRef`](ClipRef.md): [`node`](ClipRef.node.md), [`item`](ClipRef.item.md), [`clip`](ClipRef.clip.md).

## Declaration

```ts
export interface ClipInfo extends ClipRef {
  readonly durationMs: number;
  readonly playing: boolean;
  readonly exclusiveWith: readonly string[];
}
```

## Generic-API test (spec 3.1)

| Rule | Result |
| --- | --- |
| 1. Neutral name | pass: `ClipInfo` names no product |
| 2. A precedent | not recorded: no ledger row (coverage.json) names this member or its owner |
| 3. Two apps, or labs | pass: 21 apps (fleet cross-check: app-04c2774145, app-0c773a4ee3, app-37356bf09f, app-4762caacdc, app-4fd23bc869, app-822bb9d6aa, app-8675b3225c, app-b362a81c85 and 13 more) |
| 4. The cheaper fix first | not recorded per member (Appendix B decides it per need) |
