lvn-embed-api
TypeScript icon, indicating that this package has built-in type declarations

0.2.4 • Public • Published

lvn-embed-api

This is an open-source npm package for embedding LVN highlights within other js projects. This package is brought to you by Cortico.

To install this package, you should run npm install lvn-embed-api.

Usage

import {HighlightPlayer} from 'lvn-embed-api'
const player = new HighlightPlayer({containerId: "embed-div-id", highlightId: 1, highlightOptions: HighlightOptions, onReady: (player) => void})
player.play()

All the functions available to use in the player.js spec are available through this API. We also provide context on whether the player is actively playing.

Note: HighlightOptions are only enforced if type is equal to "minimum".

Examples

In the examples folder, there are examples of using the imbed within different environments.

Readme

Keywords

none

Package Sidebar

Install

npm i lvn-embed-api

Weekly Downloads

38

Version

0.2.4

License

ISC

Unpacked Size

33.5 kB

Total Files

17

Last publish

Collaborators

  • cortico-engineering