@ignitevideo/types

Official TypeScript type definitions for the Ignite Video Cloud API.

Installation

npm install @ignitevideo/types

yarn add @ignitevideo/types

pnpm add @ignitevideo/types

Usage

Import the types you need directly:

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
• API Documentation