The Livepeer JavaScript library provides convenient access to the Livepeer Studio API from applications written in both browser and server-side JavaScript
For full documentation and examples, please visit docs.livepeer.org.
Install the package with:
npm install livepeer
# or
yarn add livepeer
For supported JavaScript runtimes, please consult RUNTIMES.md.
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();
- 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
- getAll - Retrieve Multistream Targets
- create - Create a multistream target
- get - Retrieve a multistream target
- update - Update Multistream Target
- delete - Delete a multistream target
- 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
- getAll - Retrieve assets
- create - Upload an asset
- createViaUrl - Upload asset via URL
- get - Retrieves an asset
- update - Patch an asset
- delete - Delete an asset
- getClips - Retrieve clips of a session
- getAll - Retrieve sessions
- get - Retrieve a session
- getRecorded - Retrieve Recorded Sessions
- getViewership - Query viewership metrics
- getCreatorViewership - Query creator viewership metrics
- getPublicViewership - Query public total views metrics
- getUsage - Query usage metrics
- create - Create a signing key
- getAll - Retrieves signing keys
- delete - Delete Signing Key
- get - Retrieves a signing key
- update - Update a signing key
- create - Transcode a video
- get - Retrieve Playback Info
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() {
let result;
try {
result = await livepeer.playback.get("<value>");
} 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();
You can override the default server globally by passing a server index to the serverIdx
optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
# | Server | Variables |
---|---|---|
0 | https://livepeer.studio/api |
None |
import { Livepeer } from "livepeer";
import { Profile, Type } from "livepeer/models/components";
const livepeer = new Livepeer({
serverIdx: 0,
apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await livepeer.stream.create({
name: "test_stream",
pull: {
source: "https://myservice.com/live/stream.flv",
headers: {
Authorization: "Bearer 123",
},
location: {
lat: 39.739,
lon: -104.988,
},
},
playbackPolicy: {
type: Type.Webhook,
webhookId: "1bde4o2i6xycudoy",
webhookContext: {
streamerId: "my-custom-id",
},
refreshInterval: 600,
},
profiles: [
{
width: 1280,
name: "720p",
height: 486589,
bitrate: 3000000,
fps: 30,
fpsDen: 1,
quality: 23,
gop: "2",
profile: Profile.H264Baseline,
},
],
record: false,
recordingSpec: {
profiles: [
{
width: 1280,
name: "720p",
height: 489382,
bitrate: 3000000,
fps: 30,
fpsDen: 1,
quality: 23,
gop: "2",
profile: Profile.H264Baseline,
},
],
},
multistream: {
targets: [
{
profile: "720p",
videoOnly: false,
id: "PUSH123",
spec: {
name: "My target",
url: "rtmps:https://live.my-service.tv/channel/secretKey",
},
},
],
},
});
// Handle the result
console.log(result);
}
run();
The default server can also be overridden globally by passing a URL to the serverURL
optional parameter when initializing the SDK client instance. For example:
import { Livepeer } from "livepeer";
import { Profile, Type } from "livepeer/models/components";
const livepeer = new Livepeer({
serverURL: "https://livepeer.studio/api",
apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await livepeer.stream.create({
name: "test_stream",
pull: {
source: "https://myservice.com/live/stream.flv",
headers: {
Authorization: "Bearer 123",
},
location: {
lat: 39.739,
lon: -104.988,
},
},
playbackPolicy: {
type: Type.Webhook,
webhookId: "1bde4o2i6xycudoy",
webhookContext: {
streamerId: "my-custom-id",
},
refreshInterval: 600,
},
profiles: [
{
width: 1280,
name: "720p",
height: 486589,
bitrate: 3000000,
fps: 30,
fpsDen: 1,
quality: 23,
gop: "2",
profile: Profile.H264Baseline,
},
],
record: false,
recordingSpec: {
profiles: [
{
width: 1280,
name: "720p",
height: 489382,
bitrate: 3000000,
fps: 30,
fpsDen: 1,
quality: 23,
gop: "2",
profile: Profile.H264Baseline,
},
],
},
multistream: {
targets: [
{
profile: "720p",
videoOnly: false,
id: "PUSH123",
spec: {
name: "My target",
url: "rtmps:https://live.my-service.tv/channel/secretKey",
},
},
],
},
});
// Handle the result
console.log(result);
}
run();
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 });
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. For example:
import { Livepeer } from "livepeer";
import { Profile, Type } from "livepeer/models/components";
const livepeer = new Livepeer({
apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await livepeer.stream.create({
name: "test_stream",
pull: {
source: "https://myservice.com/live/stream.flv",
headers: {
Authorization: "Bearer 123",
},
location: {
lat: 39.739,
lon: -104.988,
},
},
playbackPolicy: {
type: Type.Webhook,
webhookId: "1bde4o2i6xycudoy",
webhookContext: {
streamerId: "my-custom-id",
},
refreshInterval: 600,
},
profiles: [
{
width: 1280,
name: "720p",
height: 486589,
bitrate: 3000000,
fps: 30,
fpsDen: 1,
quality: 23,
gop: "2",
profile: Profile.H264Baseline,
},
],
record: false,
recordingSpec: {
profiles: [
{
width: 1280,
name: "720p",
height: 489382,
bitrate: 3000000,
fps: 30,
fpsDen: 1,
quality: 23,
gop: "2",
profile: Profile.H264Baseline,
},
],
},
multistream: {
targets: [
{
profile: "720p",
videoOnly: false,
id: "PUSH123",
spec: {
name: "My target",
url: "rtmps:https://live.my-service.tv/channel/secretKey",
},
},
],
},
});
// Handle the result
console.log(result);
}
run();
npm add https://github.com/livepeer/livepeer-js
yarn add https://github.com/livepeer/livepeer-js
For supported JavaScript runtimes, please consult RUNTIMES.md.
import { Livepeer } from "livepeer";
import { Profile, Type } from "livepeer/models/components";
const livepeer = new Livepeer({
apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await livepeer.stream.create({
name: "test_stream",
pull: {
source: "https://myservice.com/live/stream.flv",
headers: {
Authorization: "Bearer 123",
},
location: {
lat: 39.739,
lon: -104.988,
},
},
playbackPolicy: {
type: Type.Webhook,
webhookId: "1bde4o2i6xycudoy",
webhookContext: {
streamerId: "my-custom-id",
},
refreshInterval: 600,
},
profiles: [
{
width: 1280,
name: "720p",
height: 486589,
bitrate: 3000000,
fps: 30,
fpsDen: 1,
quality: 23,
gop: "2",
profile: Profile.H264Baseline,
},
],
record: false,
recordingSpec: {
profiles: [
{
width: 1280,
name: "720p",
height: 489382,
bitrate: 3000000,
fps: 30,
fpsDen: 1,
quality: 23,
gop: "2",
profile: Profile.H264Baseline,
},
],
},
multistream: {
targets: [
{
profile: "720p",
videoOnly: false,
id: "PUSH123",
spec: {
name: "My target",
url: "rtmps:https://live.my-service.tv/channel/secretKey",
},
},
],
},
});
// Handle the result
console.log(result);
}
run();
- 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
- getAll - Retrieve Multistream Targets
- create - Create a multistream target
- get - Retrieve a multistream target
- update - Update Multistream Target
- delete - Delete a multistream target
- 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
- getAll - Retrieve assets
- create - Upload an asset
- createViaUrl - Upload asset via URL
- get - Retrieves an asset
- update - Patch an asset
- delete - Delete an asset
- getClips - Retrieve clips of a session
- getAll - Retrieve sessions
- get - Retrieve a session
- getRecorded - Retrieve Recorded Sessions
create- Create a room⚠️ Deprecatedget- Retrieve a room⚠️ Deprecateddelete- Delete a room⚠️ DeprecatedstartEgress- Start room RTMP egress⚠️ DeprecatedstopEgress- Stop room RTMP egress⚠️ DeprecatedcreateUser- Create a room user⚠️ DeprecatedgetUser- Get user details⚠️ DeprecatedupdateUser- Update a room user⚠️ DeprecateddeleteUser- Remove a user from the room⚠️ Deprecated
- getViewership - Query viewership metrics
- getCreatorViewership - Query creator viewership metrics
- getPublicViewership - Query public total views metrics
- getUsage - Query usage metrics
- create - Create a signing key
- getAll - Retrieves signing keys
- delete - Delete Signing Key
- get - Retrieves a signing key
- update - Update a signing key
- create - Transcode a video
- get - Retrieve Playback Info