Media Descriptor Module

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.

Installation

1npm install media-descriptor
2# or
3yarn add media-descriptor

MediaDescriptorFactory

The factory provides two methods to create a MediaDescriptor instance:

fromManifestUrl(url: string, options?: Options): Promise<MediaDescriptor>

Creates a MediaDescriptor from a manifest URL (m3u8).

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

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<MediaDescriptor>

Creates a MediaDescriptor from a video description object.

1const descriptor = await MediaDescriptorFactory.fromVideoDescription({
2  mediaId: "vi123456789",
3  type: "vod",
4  deliveryDomain: "vod.api.video",
5  privateToken: "optional-token",
6});

MediaDescriptor

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 (VOD only)

Domains Information

1const domains = descriptor.domains;
2// {
3//   delivery: "vod.api.video",
4//   collector: "collector.api.video"
5// }

Chapters Support

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

Summaries Support

1// List available summaries
2const summaries = descriptor.summaryEntries;
3// [{ lang: 'en', generated: false }, { lang: 'fr', generated: true }]
4
5// Get summary content
6const summary = await descriptor.getSummary({ lang: "en", generated: false });
7// {
8//   title: string;
9//   abstract: string;
10//   takeaways: string[];
11// }

Error Handling

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

Example Usage

1try {
2  const descriptor = await MediaDescriptorFactory.fromManifestUrl(manifestUrl);
3
4  // Access basic information
5  console.log(descriptor.title);
6  console.log(descriptor.manifestUrl);
7
8  // Get available chapters
9  const chapters = descriptor.chaptersEntries;
10
11  // Get summary if available
12  if (descriptor.summaryEntries.length > 0) {
13    const summary = await descriptor.getSummary(descriptor.summaryEntries[0]);
14    console.log(summary.abstract);
15  }
16} catch (error) {
17  if (error instanceof VideoNotFoundError) {
18    console.error("Video not found");
19  }
20}

Contributing

Contributions are welcome! Please read the contributing guidelines first.

License

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

Links

• Documentation
• GitHub Issues