open-index/open-npm huggingface dataset:
npm package: @ignitevideo/types
Description: Ignite Video Cloud typescript types
Author: tech@ignite.video
Latest version: 1.3.0

# @ignitevideo/types

Official TypeScript type definitions for the [Ignite Video Cloud](https://ignite.video) API.

## Installation

```bash
npm install @ignitevideo/types
```

```bash
yarn add @ignitevideo/types
```

```bash
pnpm add @ignitevideo/types
```

## Usage

Import the types you need directly:

```typescript
import type { Video, PlayerDesign, Category } from '@ignitevideo/types';

const video: Video = await fetchVideoFromApi();
console.log(video.title, video.status);
```

## Available Types

| Type                   | Description                                                     |
| ---------------------- | --------------------------------------------------------------- |
| `Video`                | Main video resource with metadata, sources, and player settings |
| `VideoItem`            | Video quality variant (resolution, URL, dimensions)             |
| `Texttrack`            | Subtitle or caption track                                       |
| `Chapter`              | Video chapter with title and timestamp                          |
| `Category`             | Video category                                                  |
| `Tag`                  | Video tag                                                       |
| `Transcription`        | Full transcription with text segments                           |
| `TranscriptionSegment` | Individual transcription segment with timing                    |
| `AutoTranscription`    | Auto-generated transcription status and content                 |
| `PlayerDesign`         | Player customization settings (colors, controls, behavior)      |

## Links

- [Ignite Website](https://ignite.video)
- [API Documentation](https://docs.ignite.video)