Livepeer JavaScript Library

The Livepeer JavaScript library provides convenient access to the Livepeer Studio API from applications written in both browser and server-side JavaScript

Documentation

For full documentation and examples, please visit docs.livepeer.org.

Installation

Install the package with:

npm install livepeer
# or
yarn add livepeer

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

import { Livepeer } from "livepeer";

const livepeer = new Livepeer({
  apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await livepeer.stream.create({
    name: "test_stream",
  });

  console.log(result);
}

run();

Available Resources and Operations

stream

• create - Create a stream
• getAll - Retrieve streams
• get - Retrieve a stream
• update - Update a stream
• delete - Delete a stream
• terminate - Terminates a live stream
• startPull - Start ingest for a pull stream
• createClip - Create a clip
• getClips - Retrieve clips of a livestream
• addMultistreamTarget - Add a multistream target
• removeMultistreamTarget - Remove a multistream target

multistream

• getAll - Retrieve Multistream Targets
• create - Create a multistream target
• get - Retrieve a multistream target
• update - Update Multistream Target
• delete - Delete a multistream target

webhook

• getAll - Retrieve a Webhook
• create - Create a webhook
• get - Retrieve a webhook
• update - Update a webhook
• delete - Delete a webhook
• getLogs - Retrieve webhook logs
• getLog - Retrieve a webhook log
• resendLog - Resend a webhook

asset

• getAll - Retrieve assets
• create - Upload an asset
• createViaUrl - Upload asset via URL
• get - Retrieves an asset
• update - Patch an asset
• delete - Delete an asset

session

• getClips - Retrieve clips of a session
• getAll - Retrieve sessions
• get - Retrieve a session
• getRecorded - Retrieve Recorded Sessions

metrics

• getViewership - Query viewership metrics
• getCreatorViewership - Query creator viewership metrics
• getPublicViewership - Query public total views metrics
• getUsage - Query usage metrics

accessControl

• create - Create a signing key
• getAll - Retrieves signing keys
• delete - Delete Signing Key
• get - Retrieves a signing key
• update - Update a signing key

task

• getAll - Retrieve Tasks
• get - Retrieve a Task

transcode

• create - Transcode a video

playback

• get - Retrieve Playback Info

Error Handling

All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.

| Error Object | Status Code | Content Type | | --------------- | ----------- | ---------------- | | errors.ErrorT | 404 | application/json | | errors.SDKError | 4xx-5xx | / |

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.

import { Livepeer } from "livepeer";
import * as errors from "livepeer/models/errors";

const livepeer = new Livepeer({
  apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const id = "<value>";

  let result;
  try {
    result = await livepeer.playback.get(id);
  } catch (err) {
    switch (true) {
      case err instanceof errors.SDKValidationError: {
        // Validation errors can be pretty-printed
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case err instanceof errors.ErrorT: {
        console.error(err); // handle exception
        return;
      }
      default: {
        throw err;
      }
    }
  }

  // Handle the result
  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Livepeer } from "livepeer";
import { HTTPClient } from "livepeer/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000);
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Livepeer({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | -------- | ---- | ----------- | | apiKey | http | HTTP Bearer |

To authenticate with the API the apiKey parameter must be set when initializing the SDK client instance.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy