Skip to content
Dananji Withana edited this page Feb 8, 2024 · 18 revisions

What is Ramp?

Ramp stands for React Avalon Media Player, previously called as IIIF React Media Player. And it is a component library written in ReactJS, which consumes a IIIF Presentation 3.0 manifest to render Audio/Video content. It is written using ReactJS, a free and open-source front-end JavaScript library for building user interfaces and UI components. One of the reasons to use ReactJS in developing this is its simplicity and flexibility, along with improvements in better performance and user experience due to the use of Virtual DOM. This is shipped as a NPM package, so that it can easily be used by other projects.

Components

The component library has 5 component, that it exports;

  1. IIIFPlayer: the media player created using the VideoJS HTML5 player framework
  2. MetadataDisplay: lists metadata in the IIIF Manifest
  3. StructuredNavigation: renders the content structure from a IIIF Presentation 3.0 Manifest
  4. Transcript: renders transcript data related to the A/V content
  5. SupplementalFiles: renders supplemental files with alternate representations of the resource (available in future release)
  6. MarkersDisplay: renders highlighting annotations in a Canvas
  7. AutoAdvanceToggle: renders behavior property of a given Manifest

Content

  1. Starting Guide
  2. Components
  3. Known Issues
  4. Implementation Details