Retrieve Playback Info

Get playback information for a stream or asset

GET /playback/{id}

TypeScript

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();

200

{
  "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

id · string · required

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

Response

200

application/json

Successful response

type · enum<string> · required

Available options: live, vod, recording

Example:

"vod"

meta · object · required

Show child attributes