Overview

The Playback API is used to retrieve playback object from pipeline.

Playback Object

type · string

Type of playback, such as live, vod, or recording.

meta · object

Metadata for the playback information. This includes details about the source, playback policy, and attestation.

Response

{
  "type": "vod",
  "meta": {
    "live": 0,
    "playbackPolicy": {
      "type": "public",
      "webhookId": "3e02c844-d364-4d48-b401-24b2773b5d6c",
      "webhookContext": {
        "foo": "bar"
      }
    },
    "source": [
      {
        "hrn": "MP4",
        "type": "html5/video/mp4",
        "url": "https://asset-cdn.lp-playback.studio/hls/1bde4o2i6xycudoy/static360p0.mp4",
        "size": 494778,
        "width": 204,
        "height": 360,
        "bitrate": 449890
      }
    ],
    "attestation": {
      "id": "5b9e63bb-6fd0-4bea-aff2-cc5d4eb9cad0",
      "primaryType": "VideoAttestation",
      "domain": {
        "name": "Verifiable Video",
        "version": "1"
      },
      "message": {
        "video": "string",
        "attestations": [
          {
            "role": "string",
            "address": "string"
          }
        ],
        "signer": "string",
        "timestamp": "number"
      },
      "signature": "string",
      "createdAt": 1587667174725,
      "signatureType": "eip712",
      "storage": {
        "ipfs": {
          "cid": "bafybeihoqtemwitqajy6d654tmghqqvxmzgblddj2egst6yilplr5num6u",
          "url": "ipfs://bafybeihoqtemwitqajy6d654tmghqqvxmzgblddj2egst6yilplr5num6u",
          "gatewayUrl": "https://ipfs.io",
          "updatedAt": 1587667174725
        },
        "status": {
          "phase": "ready",
          "progress": 0.5,
          "errorMessage": "Failed to export to IPFS",
          "tasks": {
            "pending": "string",
            "last": "string",
            "failed": "string"
          }
        }
      }
    }
  }
}