@theolive/player
TypeScript icon, indicating that this package has built-in type declarations

3.16.0 • Public • Published

THEOlivePlayer

This package contains the video player to play back THEOlive streams on your web page. It's intended for THEOlive customers that want to host the player themselves.

Installation

Install using your favorite package manager for Node (such as npm or yarn):

npm install @theolive/player

Example

This example assumes you have created an account and your first channel and your channel is up and running.

This is a minimal page that creates a THEOLivePlayer:

<!DOCTYPE html>
<html lang="en">
    <head>
        <title>Example</title>
        <script type="text/javascript" src="THEOLive.js"></script>
    </head>
    <body>
        <div id="player"></div>
        <script type="text/javascript">
            // Check if the player needs a service worker and register it if needed.
            // THEOLive.sw.js needs to be served on the same path as this HTML page
            if (THEOLive.requiresServiceWorker()) {
              navigator.serviceWorker.register("THEOLive.sw.js")
            }
            // Create the player.
            const player = new THEOLive.Player(document.getElementById('player'));
            // play your stream
            player.loadChannel('<your-channel-id>')
        </script>
    </body>
</html>

Make sure to change <your-channel-id> with your actual channel-id.

For more information, please visit the THEOlive documentation website: https://developers.theo.live/docs

Readme

Keywords

Package Sidebar

Install

npm i @theolive/player

Weekly Downloads

21

Version

3.16.0

License

ISC

Unpacked Size

7.07 MB

Total Files

18

Last publish

Collaborators

  • theotechnologies-admin