api.video typescript media descriptor

!npm version
!build status
!license

api.video is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.

TODO

- check if thumbnail exists
- check if mp4 exists

Table of contents

- TODO
- Table of contents
- Project description
- Getting started
- Documentation
- MediaDescriptorFactory
- fromManifestUrl(url: string, options?: Options): Promise
- fromVideoDescription(videoDescription: VideoDescription): Promise
- MediaDescriptor
- Basic Properties
- Domains Information
- Chapters Support
- Summaries Support
- Error Handling
- Example Usage
- Contributing
- License

Project description

This module provides a robust way to handle video media descriptions for both VOD (Video on Demand) and Live streams. It consists of two main components: a factory to create media descriptors and a descriptor class to access media information.

Getting started

Installation:

``bash
npm install media-descriptor


or


yarn add media-descriptor
`

Documentation

$3

The factory provides two methods to create a MediaDescriptor instance:

#### fromManifestUrl(url: string, options?: Options): Promise

Creates a MediaDescriptor from a manifest URL (m3u8).

`typescript
const descriptor = await MediaDescriptorFactory.fromManifestUrl(
"https://vod.api.video/vod/vi123456789/hls/manifest.m3u8"
);
`

Supported URL patterns:

- VOD public: domain.com/vod/videoId/hls/manifest.m3u8
- VOD private: domain.com/vod/videoId/token/tokenValue/hls/manifest.m3u8
- Live public: domain.com/videoId.m3u8
- Live private: domain.com/private/token/videoId.m3u8

Optional parameters:

- options.collectorDomain: Override the default analytics collector domain

#### fromVideoDescription(videoDescription: VideoDescription): Promise

Creates a MediaDescriptor from a video description object.

`typescript
const descriptor = await MediaDescriptorFactory.fromVideoDescription({
mediaId: "vi123456789",
type: "vod",
deliveryDomain: "vod.api.video",
privateToken: "optional-token",
});
`

$3

The MediaDescriptor class provides access to all video-related information:

#### Basic Properties

- title: Video title
- mediaId: Unique video identifier
- mediaType: Either 'vod' or 'live'
- manifestUrl: HLS manifest URL
- mp4Url: Progressive download URL (VOD only)
- posterUrl: Thumbnail URL

#### Domains Information

`typescript
const domains = descriptor.domains;
// {
// delivery: "vod.api.video",
// collector: "collector.api.video"
// }
`

#### Chapters Support

`typescript
// List available chapter languages
const chapters = descriptor.chaptersEntries;
// Get chapter URL for a specific language
const chapterUrl = descriptor.getChapterUrl("en");
`

#### Summaries Support

`typescript
// List available summaries
const summaries = descriptor.summaryEntries;
// [{ lang: 'en', generated: false }, { lang: 'fr', generated: true }]

// Get summary content
const summary = await descriptor.getSummary({ lang: "en", generated: false });
// {
// title: string;
// abstract: string;
// takeaways: string[];
// }
`

$3

The factory methods may throw:

- InvalidUrlError: When the manifest URL format is invalid
- VideoNotFoundError: When the video doesn't exist
- MetadataFetchError: When metadata cannot be retrieved

$3

`typescript
try {
const descriptor = await MediaDescriptorFactory.fromManifestUrl(manifestUrl);

// Access basic information
console.log(descriptor.title);
console.log(descriptor.manifestUrl);

// Get available chapters
const chapters = descriptor.chaptersEntries;

// Get summary if available
if (descriptor.summaryEntries.length > 0) {
const summary = await descriptor.getSummary(descriptor.summaryEntries[0]);
console.log(summary.abstract);
}
} catch (error) {
if (error instanceof VideoNotFoundError) {
console.error("Video not found");
}
}
``

$3

Contributions are welcome! Please read the contributing guidelines first.

$3

This project is licensed under the MIT License - see the LICENSE file for details.