Retrieve Playback Info - Livepeer Docs

TypeScript

import { Livepeer } from "livepeer";

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

async function run() {
  const result = await livepeer.playback.get("<id>");

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

run();

{
  "type": "vod",
  "meta": {
    "source": [
      {
        "hrn": "MP4",
        "type": "html5/video/mp4",
        "url": "https://asset-cdn.lp-playback.monster/hls/1bde4o2i6xycudoy/static360p0.mp4",
        "size": 494778,
        "width": 204,
        "height": 360,
        "bitrate": 449890
      }
    ],
    "live": 0,
    "playbackPolicy": {
      "type": "webhook",
      "webhookId": "1bde4o2i6xycudoy",
      "webhookContext": {
        "streamerId": "my-custom-id"
      },
      "refreshInterval": 600,
      "allowedOrigins": [
        "<string>"
      ]
    },
    "dvrPlayback": [
      {
        "hrn": "MP4",
        "type": "html5/video/mp4",
        "url": "https://asset-cdn.lp-playback.monster/hls/1bde4o2i6xycudoy/static360p0.mp4",
        "error": "<string>"
      }
    ],
    "attestation": {
      "primaryType": "VideoAttestation",
      "domain": {
        "name": "Verifiable Video",
        "version": "1"
      },
      "message": {
        "video": "5b9e63bb-6fd0-4bea-aff2-cc5d4eb9cad0",
        "attestations": [
          {
            "role": "creator",
            "address": 1311768467294899700
          }
        ],
        "signer": 1311768467294899700,
        "timestamp": 1587667174725
      },
      "signature": 1311768467294899700,
      "id": "5b9e63bb-6fd0-4bea-aff2-cc5d4eb9cad0",
      "createdAt": 1587667174725,
      "signatureType": "eip712",
      "storage": {
        "ipfs": {
          "updatedAt": 1587667174725
        },
        "status": {
          "phase": "ready",
          "tasks": {
            "pending": "09F8B46C-61A0-4254-9875-F71F4C605BC7",
            "last": "09F8B46C-61A0-4254-9875-F71F4C605BC7",
            "failed": "09F8B46C-61A0-4254-9875-F71F4C605BC7"
          },
          "progress": 0.5,
          "errorMessage": "Failed to update storage"
        }
      }
    }
  }
}

GET

playback

{id}

TypeScript

import { Livepeer } from "livepeer";

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

async function run() {
  const result = await livepeer.playback.get("<id>");

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

run();

{
  "type": "vod",
  "meta": {
    "source": [
      {
        "hrn": "MP4",
        "type": "html5/video/mp4",
        "url": "https://asset-cdn.lp-playback.monster/hls/1bde4o2i6xycudoy/static360p0.mp4",
        "size": 494778,
        "width": 204,
        "height": 360,
        "bitrate": 449890
      }
    ],
    "live": 0,
    "playbackPolicy": {
      "type": "webhook",
      "webhookId": "1bde4o2i6xycudoy",
      "webhookContext": {
        "streamerId": "my-custom-id"
      },
      "refreshInterval": 600,
      "allowedOrigins": [
        "<string>"
      ]
    },
    "dvrPlayback": [
      {
        "hrn": "MP4",
        "type": "html5/video/mp4",
        "url": "https://asset-cdn.lp-playback.monster/hls/1bde4o2i6xycudoy/static360p0.mp4",
        "error": "<string>"
      }
    ],
    "attestation": {
      "primaryType": "VideoAttestation",
      "domain": {
        "name": "Verifiable Video",
        "version": "1"
      },
      "message": {
        "video": "5b9e63bb-6fd0-4bea-aff2-cc5d4eb9cad0",
        "attestations": [
          {
            "role": "creator",
            "address": 1311768467294899700
          }
        ],
        "signer": 1311768467294899700,
        "timestamp": 1587667174725
      },
      "signature": 1311768467294899700,
      "id": "5b9e63bb-6fd0-4bea-aff2-cc5d4eb9cad0",
      "createdAt": 1587667174725,
      "signatureType": "eip712",
      "storage": {
        "ipfs": {
          "updatedAt": 1587667174725
        },
        "status": {
          "phase": "ready",
          "tasks": {
            "pending": "09F8B46C-61A0-4254-9875-F71F4C605BC7",
            "last": "09F8B46C-61A0-4254-9875-F71F4C605BC7",
            "failed": "09F8B46C-61A0-4254-9875-F71F4C605BC7"
          },
          "progress": 0.5,
          "errorMessage": "Failed to update storage"
        }
      }
    }
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

The playback ID from the asset or livestream, e.g. eaw4nk06ts2d0mzb.

Response

Successful response

type

enum<string>

required

Available options:

live,

vod,

recording

Example:

"vod"

meta

object

required

Show child attributes

meta.source

object[]

required

Show child attributes

meta.source.hrn

enum<string>

required

Human Readable Name

Available options:

HLS (TS),

MP4,

WebRTC (H264),

FLV (H264),

Thumbnail (JPEG),

Thumbnail (PNG),

Thumbnails

Example:

"MP4"

meta.source.type

enum<string>

required

Available options:

html5/application/vnd.apple.mpegurl,

html5/video/mp4,

html5/video/h264,

video/x-flv,

image/jpeg,

image/png,

text/vtt

Example:

"html5/video/mp4"

meta.source.url

string

required

Example:

"https://asset-cdn.lp-playback.monster/hls/1bde4o2i6xycudoy/static360p0.mp4"

meta.source.size

number

Example:

494778

meta.source.width

number

Example:

204

meta.source.height

number

Example:

360

meta.source.bitrate

number

Example:

449890

meta.live

enum<integer>

Available options:

0,

1

Example:

0

meta.playbackPolicy

object

Whether the playback policy for an asset or stream is public or signed

Show child attributes

meta.playbackPolicy.type

enum<string>

required

Available options:

public,

jwt,

webhook

Example:

"webhook"

meta.playbackPolicy.webhookId

string

ID of the webhook to use for playback policy

Example:

"1bde4o2i6xycudoy"

meta.playbackPolicy.webhookContext

object

User-defined webhook context

Example:

{ "streamerId": "my-custom-id" }

meta.playbackPolicy.refreshInterval

number

Interval (in seconds) at which the playback policy should be refreshed (default 600 seconds)

Example:

600

meta.playbackPolicy.allowedOrigins

string[]

List of allowed origins for CORS playback (://:, ://)

meta.dvrPlayback

object[]

Show child attributes

meta.dvrPlayback.hrn

enum<string>

Available options:

HLS (TS)

Example:

"MP4"

meta.dvrPlayback.type

enum<string>

Available options:

html5/application/vnd.apple.mpegurl

Example:

"html5/video/mp4"

meta.dvrPlayback.url

string

Example:

"https://asset-cdn.lp-playback.monster/hls/1bde4o2i6xycudoy/static360p0.mp4"

meta.dvrPlayback.error

string

meta.attestation

object

Show child attributes

meta.attestation.primaryType

enum<string>

required

Video Metadata EIP-712 primaryType

Available options:

VideoAttestation

Example:

"VideoAttestation"

meta.attestation.domain

object

required

Video Metadata EIP-712 domain

Show child attributes

meta.attestation.domain.name

enum<string>

required

Available options:

Verifiable Video

Example:

"Verifiable Video"

meta.attestation.domain.version

enum<string>

required

Available options:

1

Example:

"1"

meta.attestation.message

object

required

Video Metadata EIP-712 message content

Show child attributes

meta.attestation.message.video

string

required

Example:

"5b9e63bb-6fd0-4bea-aff2-cc5d4eb9cad0"

meta.attestation.message.attestations

object[]

required

Show child attributes

meta.attestation.message.attestations.role

string

required

Example:

"creator"

meta.attestation.message.attestations.address

string

required

Example:

1311768467294899700

meta.attestation.message.signer

string

required

Example:

1311768467294899700

meta.attestation.message.timestamp

number

required

Example:

1587667174725

meta.attestation.signature

string

required

Video Metadata EIP-712 message signature

Example:

1311768467294899700

meta.attestation.id

string

Example:

"5b9e63bb-6fd0-4bea-aff2-cc5d4eb9cad0"

meta.attestation.createdAt

number

Timestamp (in milliseconds) at which the object was created

Example:

1587667174725

meta.attestation.signatureType

enum<string>

Available options:

eip712,

flow

Example:

"eip712"

meta.attestation.storage

object

Show child attributes

meta.attestation.storage.ipfs

object

Show child attributes

meta.attestation.storage.ipfs.updatedAt

number

Timestamp (in milliseconds) at which IPFS export task was updated

Example:

1587667174725

meta.attestation.storage.status

object

Show child attributes

meta.attestation.storage.status.phase

enum<string>

required

Phase of the asset storage

Available options:

waiting,

processing,

ready,

failed,

reverted

Example:

"ready"

meta.attestation.storage.status.tasks

object

required

Show child attributes

meta.attestation.storage.status.tasks.pending

string

ID of any currently running task that is exporting this asset to IPFS.

Example:

"09F8B46C-61A0-4254-9875-F71F4C605BC7"

meta.attestation.storage.status.tasks.last

string

ID of the last task to run successfully, that created the currently saved data.

Example:

"09F8B46C-61A0-4254-9875-F71F4C605BC7"

meta.attestation.storage.status.tasks.failed

string

ID of the last task to fail execution.

Example:

"09F8B46C-61A0-4254-9875-F71F4C605BC7"

meta.attestation.storage.status.progress

number

Current progress of the task updating the storage.

Example:

0.5

meta.attestation.storage.status.errorMessage

string

Error message if the last storage changed failed.

Example:

"Failed to update storage"

Overview Overview

⌘I

Overview

APIs

Authorizations

Path Parameters

Response