Retrieve all sessions

GET

session

import { Livepeer } from "livepeer";

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

async function run() {
  const result = await livepeer.session.getAll();

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

run();

[
  {
    "id": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
    "kind": "stream",
    "userId": "66E2161C-7670-4D05-B71D-DA2D6979556F",
    "name": "test_session",
    "lastSeen": 1587667174725,
    "sourceSegments": 1,
    "transcodedSegments": 2,
    "sourceSegmentsDuration": 1,
    "transcodedSegmentsDuration": 2,
    "sourceBytes": 1,
    "transcodedBytes": 2,
    "ingestRate": 1,
    "outgoingRate": 2,
    "isHealthy": null,
    "issues": null,
    "createdAt": 1587667174725,
    "parentId": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
    "projectId": "aac12556-4d65-4d34-9fb6-d1f0985eb0a9",
    "record": false,
    "recordingStatus": "waiting",
    "recordingUrl": "<string>",
    "mp4Url": "<string>",
    "playbackId": "eaw4nk06ts2d0mzb",
    "profiles": [
      {
        "name": "240p0",
        "fps": 0,
        "bitrate": 250000,
        "width": 426,
        "height": 240
      },
      {
        "name": "360p0",
        "fps": 0,
        "bitrate": 800000,
        "width": 640,
        "height": 360
      },
      {
        "name": "480p0",
        "fps": 0,
        "bitrate": 1600000,
        "width": 854,
        "height": 480
      },
      {
        "name": "720p0",
        "fps": 0,
        "bitrate": 3000000,
        "width": 1280,
        "height": 720
      }
    ],
    "recordingSpec": {
      "profiles": [
        {
          "width": 1280,
          "name": "720p",
          "height": 720,
          "bitrate": 3000000,
          "quality": 23,
          "fps": 30,
          "fpsDen": 1,
          "gop": 2,
          "profile": "H264Baseline",
          "encoder": "H.264"
        }
      ]
    }
  }
]

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

application/json

Success

name

string

required

Example:

"test_session"

string

Example:

"de7818e7-610a-4057-8f6f-b785dc1e6f88"

kind

string

deprecated

Example:

"stream"

userId

string

deprecated

Example:

"66E2161C-7670-4D05-B71D-DA2D6979556F"

lastSeen

number

Example:

1587667174725

sourceSegments

number

Example:

1

transcodedSegments

number

Example:

2

sourceSegmentsDuration

number

Duration of all the source segments, sec

Example:

1

transcodedSegmentsDuration

number

Duration of all the transcoded segments, sec

Example:

2

sourceBytes

number

Example:

1

transcodedBytes

number

Example:

2

ingestRate

number

Rate at which sourceBytes increases (bytes/second)

Example:

1

outgoingRate

number

Rate at which transcodedBytes increases (bytes/second)

Example:

2

isHealthy

any

issues

any

createdAt

number

Timestamp (in milliseconds) at which stream object was created

Example:

1587667174725

parentId

string

Points to parent stream object

Example:

"de7818e7-610a-4057-8f6f-b785dc1e6f88"

projectId

string

The ID of the project

Example:

"aac12556-4d65-4d34-9fb6-d1f0985eb0a9"

record

boolean

Whether the stream should be recorded. Uses default settings. For more customization, create and configure an object store.

Example:

false

recordingStatus

enum<string>

The status of the recording process of this stream session.

Available options:

waiting,

ready,

failed,

deleted,

none

recordingUrl

string

URL for accessing the recording of this stream session.

mp4Url

string

The URL for the stream session recording packaged in an MP4.

playbackId

string

The playback ID to use with the Playback Info endpoint to retrieve playback URLs.

Example:

"eaw4nk06ts2d0mzb"

profiles

any

recordingSpec

any

Was this page helpful?

Suggest edits Raise issue

Retrieve a session Retrieve recorded sessions

import { Livepeer } from "livepeer";

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

async function run() {
  const result = await livepeer.session.getAll();

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

run();

[
  {
    "id": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
    "kind": "stream",
    "userId": "66E2161C-7670-4D05-B71D-DA2D6979556F",
    "name": "test_session",
    "lastSeen": 1587667174725,
    "sourceSegments": 1,
    "transcodedSegments": 2,
    "sourceSegmentsDuration": 1,
    "transcodedSegmentsDuration": 2,
    "sourceBytes": 1,
    "transcodedBytes": 2,
    "ingestRate": 1,
    "outgoingRate": 2,
    "isHealthy": null,
    "issues": null,
    "createdAt": 1587667174725,
    "parentId": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
    "projectId": "aac12556-4d65-4d34-9fb6-d1f0985eb0a9",
    "record": false,
    "recordingStatus": "waiting",
    "recordingUrl": "<string>",
    "mp4Url": "<string>",
    "playbackId": "eaw4nk06ts2d0mzb",
    "profiles": [
      {
        "name": "240p0",
        "fps": 0,
        "bitrate": 250000,
        "width": 426,
        "height": 240
      },
      {
        "name": "360p0",
        "fps": 0,
        "bitrate": 800000,
        "width": 640,
        "height": 360
      },
      {
        "name": "480p0",
        "fps": 0,
        "bitrate": 1600000,
        "width": 854,
        "height": 480
      },
      {
        "name": "720p0",
        "fps": 0,
        "bitrate": 3000000,
        "width": 1280,
        "height": 720
      }
    ],
    "recordingSpec": {
      "profiles": [
        {
          "width": 1280,
          "name": "720p",
          "height": 720,
          "bitrate": 3000000,
          "quality": 23,
          "fps": 30,
          "fpsDen": 1,
          "gop": 2,
          "profile": "H264Baseline",
          "encoder": "H.264"
        }
      ]
    }
  }
]

Overview

APIs

Authorizations

Response