# iiif-media-player

> Video and audio media player which parses and renders a user supplied IIIF 3.0 spec manifest json file.

Latest version **1.0.6** (published 2018-05-31) · ISC license · 0 weekly downloads

## Install

```sh
npm install iiif-media-player
pnpm add iiif-media-player
yarn add iiif-media-player
bun add iiif-media-player
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2018-05-31 |
| First published | 2018-05-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 1.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Adam Arling |
| Maintainers | adamjarling |
| Keywords | IIIF, media, player |

## Links

- npm: https://www.npmjs.com/package/iiif-media-player
- Repository: https://github.com/avalonmediasystem/avalon-iiif-player
- Homepage: https://github.com/avalonmediasystem/avalon-iiif-player#readme
- Issues: https://github.com/avalonmediasystem/avalon-iiif-player/issues
- npm.io page: https://npm.io/package/iiif-media-player

## Recent versions

- 1.0.6 (latest) — 2018-05-31
- 1.0.5 — 2018-05-31
- 1.0.4 — 2018-05-30
- 1.0.3 — 2018-05-30
- 1.0.2 — 2018-05-30
- 1.0.1 — 2018-05-30
- 1.0.0 — 2018-05-25

## README

# iiif-media-player

Note: This is in active develop mode and not ready for production.

### Instructions
Import the `iiif-media-player` JavaScript class into your ES2015 JS application like so:

`import IIIFMediaPlayer from 'iiif-media-player'`

The class initialization function accepts an element `id` attribute, which must exist in your application at the time the class is instantiated. Otherwise the initialization will gracefully fail.

### Example usage:

`<div id="your-element-id" data-manifest-url="https://mallorn.dlib.indiana.edu/lunchroom_manners.manifest.json"></div>`

`const iiifMediaPlayer = new IIIFMediaPlayer('your-element-id')`

The IIIFMediaPlayer will mount to your supplied element `id`, and look for the `data-manifest-url` attribute which should contain a IIIF 3.0 spec manifest json object uri.  I will render a MediaelementJS player (http://www.mediaelementjs.com/) and any defined IIIF `structures []` navigation links found in the IIIF manifest.

`data-manifest-url` should be a uri for a public IIIF manifest 3.0 json file.

#### Sample IIIF 3.0 spec manifest
https://mallorn.dlib.indiana.edu/lunchroom_manners.manifest.json


### IIIF Manifest Testing
To live test IIIF 3.0 spec manifests, the following Github branch is set up for testing:
https://avalonmediasystem.github.io/avalon-iiif-player/

---
_Source: https://npm.io/package/iiif-media-player · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._