JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 9
  • Score
    100M100P100Q40500F
  • License ISC

Node controller Living As One

Package Exports

  • living-as-one-encoder
  • living-as-one-encoder/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (living-as-one-encoder) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Living As One Encoder

This library contains classes to wrap the undocumented living-as-one API for encoder functionality.

Installation

Install living-as-one-encoder with npm

  npm install living-as-one-encoder

Usage/Examples

import {LivingAsOneClient} from 'living-as-one-encoder';
import * as dotenv from 'dotenv';

dotenv.config();

const client = new LivingAsOneClient();
client
    .login(
        process.env.LIVING_AS_ONE_USERNAME || '',
        process.env.LIVING_AS_ONE_PASSWORD || ''
    )
    .then(async profile => {
        if (profile) {
            console.dir(profile);

            console.log('Users:');
            console.log(await client.users.getUsers());

            console.log('Encoders:');
            console.log(await client.encoders.getEncoders());

            console.log('Events:');
            console.log(await client.events.getEvents());
            const event = await client.events.getLiveEvent();
            if (event) {
                console.log('Current live event:');
                console.dir(event, {depth: 4});

                console.log('Cues:');
                console.log(await client.cues.getCues(event.uuid));

                // create a cue for the current time
                await client.cues.createLiveCue('Test cue', false);

                // delete the cues that are not shared
                await client.cues.deleteUnsharedCues();
            }
        }
    })
    .catch(err => {
        console.error(err);
    });

Features

  • Cues
    • get cues
    • create cue
    • create cue in real-time
    • update cue
    • delete cue
    • delete/clean-up cues that are not shared
  • Encoders
    • get encoders
  • Events
    • get events
    • get the event that is live
  • Users
    • get users
    • get user