Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/videojs/mpd-parser
https://github.com/videojs/mpd-parser
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/videojs/mpd-parser
- Owner: videojs
- License: other
- Created: 2017-01-13T21:52:55.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2023-12-08T18:19:55.000Z (11 months ago)
- Last Synced: 2024-06-19T12:49:10.717Z (5 months ago)
- Language: JavaScript
- Homepage: https://videojs.github.io/mpd-parser/
- Size: 1.45 MB
- Stars: 77
- Watchers: 21
- Forks: 54
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-video - videojs/mpd-parser - Contribute to videojs/mpd-parser development by creating an account on GitHub. (DASH / Talks Presentations Podcasts)
README
# mpd-parser
[](https://travis-ci.org/videojs/mpd-parser)
[](https://greenkeeper.io/)
[](http://slack.videojs.com)
[](https://nodei.co/npm/mpd-parser/)
mpd parser
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Parsed Output](#parsed-output)
- [Including the Parser](#including-the-parser)
- [`` Tag](#script-tag)
- [Browserify](#browserify)
- [RequireJS/AMD](#requirejsamd)
- [License](#license)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## Installation
```sh
npm install --save mpd-parser
```
## Usage
```js
// get your manifest in whatever way works best
// for example, by reading the file from the filesystem in node
// or using fetch in a browser like so:
const manifestUri = 'https://example.com/dash.xml';
const res = await fetch(manifestUri);
const manifest = await res.text();
// A callback function to handle events like errors or warnings
const eventHandler = ({ type, message }) => console.log(`${type}: ${message}`);
var parsedManifest = mpdParser.parse(manifest, { manifestUri, eventHandler });
```
If dealing with a live stream, then on subsequent calls to parse, the previously parsed
manifest object should be provided as an option to `parse` using the `previousManifest`
option:
```js
const newParsedManifest = mpdParser.parse(
manifest,
// parsedManifest comes from the prior example
{ manifestUri, previousManifest: parsedManifest }
);
```
### Parsed Output
The parser ouputs a plain javascript object with the following structure:
```js
Manifest {
allowCache: boolean,
contentSteering: {
defaultServiceLocation: string,
proxyServerURL: string,
queryBeforeStart: boolean,
serverURL: string
},
endList: boolean,
mediaSequence: number,
discontinuitySequence: number,
playlistType: string,
playlists: [
{
attributes: {},
Manifest
}
],
mediaGroups: {
AUDIO: {
'GROUP-ID': {
default: boolean,
autoselect: boolean,
language: string,
uri: string,
instreamId: string,
characteristics: string,
forced: boolean
}
},
VIDEO: {},
'CLOSED-CAPTIONS': {},
SUBTITLES: {}
},
dateTimeString: string,
dateTimeObject: Date,
targetDuration: number,
totalDuration: number,
discontinuityStarts: [number],
segments: [
{
byterange: {
length: number,
offset: number
},
duration: number,
attributes: {},
discontinuity: number,
uri: string,
timeline: number,
key: {
method: string,
uri: string,
iv: string
},
map: {
uri: string,
byterange: {
length: number,
offset: number
}
},
'cue-out': string,
'cue-out-cont': string,
'cue-in': string
}
]
}
```
## Including the Parser
To include mpd-parser on your website or web application, use any of the following methods.
### `<script>` Tag
This is the simplest case. Get the script in whatever way you prefer and include it on your page.
```html
<script src="//path/to/mpd-parser.min.js">
var mpdParser = window['mpd-parser'];
var parsedManifest = mpdParser.parse(manifest, { manifestUri });
```
### Browserify
When using with Browserify, install mpd-parser via npm and `require` the parser as you would any other module.
```js
var mpdParser = require('mpd-parser');
var parsedManifest = mpdParser.parse(manifest, { manifestUri });
```
With ES6:
```js
import { parse } from 'mpd-parser';
const parsedManifest = parse(manifest, { manifestUri });
```
### RequireJS/AMD
When using with RequireJS (or another AMD library), get the script in whatever way you prefer and `require` the parser as you normally would:
```js
require(['mpd-parser'], function(mpdParser) {
var parsedManifest = mpdParser.parse(manifest, { manifestUri });
});
```
## License
Apache-2.0. Copyright (c) Brightcove, Inc