Skip to content

Latest commit

 

History

History
182 lines (128 loc) · 4.59 KB

README.md

File metadata and controls

182 lines (128 loc) · 4.59 KB
Raw




Bambuser REST API client for Node.js

The Bambuser Node library provides means for communicating with the Bambuser REST API.

Usage

The library needs to be configured with an API key for your Bambuser account which can be found on the dashboard. Pass the key into the constructor:

const BambuserAPI = require('bambuser-api-node');

const bambuser = new BambuserAPI('your-key-goes-here');

Optionally, pass more options:

const bambuser = new BambuserAPI({
  apiKey: 'your-key-goes-here',
  daId: 'your-signing-key',
  daSecret: 'your-signing-secret'
});
Key Type Description
apiKey string Your Bambuser API key
daId string (optional) The id part of your signing key
daSecret string (optional) The secret part of your signing key

You can find your API key and signing key on dashboard.bambuser.com/developer.

Fetching broadcast or image metadata

Get the last few items:

API Reference

const broadcasts = await bambuser.broadcasts.get();

const images = await bambuser.images.get();

Get items with options:

You can find all available options in the REST API documentation.

const broadcasts = await bambuser.broadcasts.get({
  byAuthors: 'John Doe'
});

// (same for bambuser.images)

List items with pagination:

const pager = await bambuser.broadcasts.get({}, {withPagination: true});
let broadcasts = [], pageResults;
while (pageResults = await pager.next()) {
  broadcasts = broadcasts.concat(pageResults);
}

// (same for bambuser.images)

Get an image or broadcast by their id:

const broadcast = await bambuser.broadcasts.getById('<broadcastId>');

// (same for bambuser.images)

Deleting broadcasts or images

Get an image or broadcast by their id:

API Reference

await bambuser.broadcasts.deleteById('<broadcastId>');

// (same for bambuser.images)

Get a link to a broadcast player

To use this method you must configure the API client with your signing keys.

const broadcasts = await bambuser.broadcasts.get();
const playerUrl = bambuser.broadcasts.getPlayerURL(broadcasts[0].id);

Get a Download link to a broadcast

To use this method you must configure the API client with your signing keys.

const broadcastDownloadLink = await bambuser.broadcasts.getDownloadLink('<broadcastId>');

Create a clip from a broadcast

API Reference

let start = 5;
let end = 145;
const { newBroadcastId } = await bambuser.broadcasts.createClip('<broadcastId>', start, end);

// Wait for the new broadcast (clip) to become ready
let broadcast;
const waitForNewBroadcast = async () => {
  try {
    broadcast = await bambuser.broadcasts.getById(newBroadcastId);
  } catch (err) {
    if (err instanceof BambuserAPI.errors.ResourceNotFound) {
      // Still not ready, wait a short time before checking again
      await new Promise(r => setTimeout(r, 5000));
      return await waitForNewBroadcast();
    }
    throw err;
  }
};
await waitForNewBroadcast();
console.log(broadcast);

Tag a broadcast

API Reference

await bambuser.broadcasts.addTag('<broadcastId>', '<tag>', '[options]');
// {text: 'baz', id: 665928}

Tags can be created with an optional start and (also optional) end position, specified as no. seconds into the broadcasts. Do this by supplying positionStart/positionEnd in an option object as the third argument:

await bambuser.broadcasts.addTag('<broadcastId>', '<tag>', {
  positionStart: 60,
  positionEnd: 120
});

Removing tags from a broadcast

API Reference

Remove a single tag by its id:

await bambuser.broadcasts.removeTag('<broadcastId>', '<tagId>');

Remove all tags from a broadcast:

await bambuser.broadcasts.removeAllTags('<broadcastId>');

More information