# @mastashake08/dash-manifest-creator > A pure javascript package for creating MPEG-DASH manifests in the browser. Latest version **3.0.0-alpha** (published 2023-11-22) · MIT license · 0 weekly downloads ## Install ```sh npm install @mastashake08/dash-manifest-creator pnpm add @mastashake08/dash-manifest-creator yarn add @mastashake08/dash-manifest-creator bun add @mastashake08/dash-manifest-creator ``` ## Health **Score 20/100 (F)** — status: abandoned. Positive: esm support; no vulnerabilities. Warnings: low downloads; no types. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 3.0.0-alpha | | Published | 2023-11-22 | | First published | 2023-10-26 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | ESM + CommonJS | | Dependencies | 1 | | Unpacked size | 1 MB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 2 | | Author | Mastashake | | Maintainers | mastashake08 | | Keywords | mpeg-dash, dash, manifest, mpd | ## Links - npm: https://www.npmjs.com/package/@mastashake08/dash-manifest-creator - Repository: https://github.com/mastashake08/dash-manifest-creator - Homepage: https://github.com/mastashake08/dash-manifest-creator#readme - Issues: https://github.com/mastashake08/dash-manifest-creator/issues - npm.io page: https://npm.io/package/@mastashake08/dash-manifest-creator ## Dependencies (1) - [esmify](https://npm.io/package/esmify.md) ^2.1.1 ## Alternatives - [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads - [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads - [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads - [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads - [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads ## Recent versions - 3.0.0-alpha (latest) — 2023-11-22 - 2.1.0-alpha — 2023-10-26 ## README # DASH Manifest Creator ![SDE Logo](./logo.svg) Create DASH manifests in the browser for live streaming! Shake DASH Encoder (SDE) is a browser-only DASH encoder for Javascript. It is based on the [Youtube HTTP DASH specification](https://developers.google.com/youtube/v3/live/guides/encoding-with-dash) but can be modified to fit any format. Created by [Jyrone Parker](https://jyroneparker.com) and is completely open source. If you would like to contribute consider sponsoring me! # Table Of Contents - [Installation](#install) - [Usage](#usage) - [Bug Reporting](#bug-reporting) - [Contributing](#contributing) - [API Reference](#api) ## Installation This package is available on NPM `npm i dash-manifest-creator` ## Usage ```javascript import { MPD } from "dash-manifest-creator"; const mpd = new MPD(); const dash = mpd.createMpd(videoChunk1); // generate a new manifest dash.next(); // generate another manifest down the line dash.next(videoChunk2); // generate XML string const str = mpd.getXMLString(); // generate XML file const file = mpd.getXMLFile(); ``` For more docs on the MPD class see the [docs](./docs/index.html) directory. ## Bug Reporting TODO ## Contributing TODO ## API ### MPD **Kind**: global class - [MPD](#MPD) - [new MPD(config)](#new_MPD_new) - [.createMpd(videoData)](#MPD+createMpd) - [.createPeriod(id)](#MPD+createPeriod) - [.createAdaptationSet(mimetype)](#MPD+createAdaptationSet) ⇒ - [.createContentComponent(contentType, id)](#MPD+createContentComponent) - [.createSegmentTemplate(videoData, timescale, duration, startNumber, media)](#MPD+createSegmentTemplate) - [.getXMLString()](#MPD+getXMLString) ⇒ string - [.getXMLFile()](#MPD+getXMLFile) ⇒ File #### new MPD(config) | Param | Type | Description | | ------ | ------------------- | ------------------------------------- | | config | object | configuration object for the manifest | #### mpD.createMpd(videoData) **Kind**: instance method of [MPD](#MPD) | Param | Type | Description | | --------- | ------------------- | ---------------------------------------------------------- | | videoData | Buffer | initial video data for the stream, must be less than 100kb | #### mpD.createPeriod(id) **Kind**: instance method of [MPD](#MPD) | Param | Type | Description | | ----- | -------------------- | -------------------- | | id | integer | the id of the period | #### mpD.createAdaptationSet(mimetype) ⇒ **Kind**: instance method of [MPD](#MPD) **Returns**: a yielded mimeType attribute | Param | Type | Default | Description | | -------- | ------------------- | ----------------------------------- | --------------------------- | | mimetype | string | "video/webm" | The MIME type of the stream | #### mpD.createContentComponent(contentType, id) **Kind**: instance method of [MPD](#MPD) | Param | Type | Default | Description | | ----------- | -------------------- | ------------------------------ | ------------------------------------------- | | contentType | string | "video" | The content type of the media being streams | | id | integer | 1 | The id of the content component | #### mpD.createSegmentTemplate(videoData, timescale, duration, startNumber, media) **Kind**: instance method of [MPD](#MPD) | Param | Type | Default | Description | | ----------- | -------------------- | ----------------- | ------------------------------------------- | | videoData | Buffer | | videoData to be streamed for initialization | | timescale | integer | 1000 | The timescale of the media in microseconds | | duration | integer | 2000 | The duration of the media in microseconds | | startNumber | integer | 1 | The start number of the media content | | media | string | | The media URL for update PUTs | #### mpD.getXMLString() ⇒ string **Kind**: instance method of [MPD](#MPD) **Returns**: string - str - XML string representation of the manifest #### mpD.getXMLFile() ⇒ File **Kind**: instance method of [MPD](#MPD) **Returns**: File - file - A new File named init.mpd which contains the manifest XML --- _Source: https://npm.io/package/@mastashake08/dash-manifest-creator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._