Playback
Retrieve Playback Info
- Documentation
- API Reference
- Livepeer Dev Kit
- Catalyst
- What's New
- Community
Asset
Livestream
Multistream target
Session
Access control
Webhook
Task
Playback
Transcode
Viewership
APIs
Playback
Retrieve Playback Info
GET
/
playback
/
{id}
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
id
string
*
id
Required
string
The playback ID from the asset or livestream, e.g. eaw4nk06ts2d0mzb.
curl --request GET \
--url https://livepeer.studio/api/playback/{id} \
--header 'Authorization: Bearer <api-key>'
{
"type": "vod",
"meta": {
"live": 0,
"playbackPolicy": {
"type": "webhook",
"webhookId": "1bde4o2i6xycudoy",
"webhookContext": {
"streamerId": "my-custom-id"
},
"refreshInterval": 600
},
"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
}
],
"dvrPlayback": [
{
"hrn": "MP4",
"type": "html5/video/mp4",
"url": "https://asset-cdn.lp-playback.monster/hls/1bde4o2i6xycudoy/static360p0.mp4",
"error": "<string>"
}
],
"attestation": {
"id": "5b9e63bb-6fd0-4bea-aff2-cc5d4eb9cad0",
"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,
"createdAt": 1587667174725,
"signatureType": "eip712",
"storage": {
"ipfs": {
"updatedAt": 1587667174725,
"cid": "<string>",
"url": "<string>",
"gatewayUrl": "<string>"
},
"status": {
"phase": "ready",
"progress": 0.5,
"errorMessage": "Failed to update storage",
"tasks": {
"pending": "09F8B46C-61A0-4254-9875-F71F4C605BC7",
"last": "09F8B46C-61A0-4254-9875-F71F4C605BC7",
"failed": "09F8B46C-61A0-4254-9875-F71F4C605BC7"
}
}
}
}
}
}Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
id
string
requiredThe playback ID from the asset or livestream, e.g. eaw4nk06ts2d0mzb.
Response
200 - application/json
type
enum<string>
requiredAvailable options:
live, vod, recording meta
object
requiredmeta.live
enum<number>
Available options:
0, 1 meta.playbackPolicy
object
Whether the playback policy for a asset or stream is public or signed
meta.playbackPolicy.type
enum<string>
requiredAvailable options:
public, jwt, webhook meta.playbackPolicy.webhookId
string
ID of the webhook to use for playback policy
meta.playbackPolicy.webhookContext
object
User-defined webhook context
meta.playbackPolicy.refreshInterval
number
Interval (in seconds) at which the playback policy should be refreshed (default 600 seconds)
meta.source
object[]
requiredmeta.source.hrn
enum<string>
requiredHuman Readable Name
Available options:
HLS (TS), MP4, WebRTC (H264), FLV (H264), Thumbnail (JPEG), Thumbnails meta.source.type
enum<string>
requiredAvailable options:
html5/application/vnd.apple.mpegurl, html5/video/mp4, html5/video/h264, video/x-flv, image/jpeg, text/vtt meta.source.url
string
requiredmeta.source.size
number
meta.source.width
number
meta.source.height
number
meta.source.bitrate
number
meta.dvrPlayback
object[]
meta.dvrPlayback.hrn
enum<string>
Available options:
HLS (TS) meta.dvrPlayback.type
enum<string>
Available options:
html5/application/vnd.apple.mpegurl meta.dvrPlayback.url
string
meta.dvrPlayback.error
string
meta.attestation
object
meta.attestation.id
string
meta.attestation.primaryType
enum<string>
requiredVideo Metadata EIP-712 primaryType
Available options:
VideoAttestation meta.attestation.domain
object
requiredVideo Metadata EIP-712 domain
meta.attestation.domain.name
enum<string>
requiredAvailable options:
Verifiable Video meta.attestation.domain.version
enum<string>
requiredAvailable options:
1 meta.attestation.message
object
requiredVideo Metadata EIP-712 message content
meta.attestation.message.video
string
requiredmeta.attestation.message.attestations
object[]
requiredmeta.attestation.message.attestations.role
string
requiredmeta.attestation.message.attestations.address
string
requiredmeta.attestation.message.signer
string
requiredmeta.attestation.message.timestamp
number
requiredmeta.attestation.signature
string
requiredVideo Metadata EIP-712 message signature
meta.attestation.createdAt
number
Timestamp (in milliseconds) at which the object was created
meta.attestation.signatureType
enum<string>
Available options:
eip712, flow meta.attestation.storage
object
meta.attestation.storage.ipfs
object
meta.attestation.storage.ipfs.updatedAt
number
Timestamp (in milliseconds) at which IPFS export task was updated
meta.attestation.storage.ipfs.cid
string
CID of the file on IPFS
meta.attestation.storage.ipfs.url
string
URL with IPFS scheme for the file
meta.attestation.storage.ipfs.gatewayUrl
string
URL to access file via HTTP through an IPFS gateway
meta.attestation.storage.status
object
meta.attestation.storage.status.phase
enum<string>
requiredPhase of the asset storage
Available options:
waiting, processing, ready, failed, reverted meta.attestation.storage.status.progress
number
Current progress of the task updating the storage.
meta.attestation.storage.status.errorMessage
string
Error message if the last storage changed failed.
meta.attestation.storage.status.tasks
object
requiredmeta.attestation.storage.status.tasks.pending
string
ID of any currently running task that is exporting this asset to IPFS.
meta.attestation.storage.status.tasks.last
string
ID of the last task to run successfully, that created the currently saved data.
meta.attestation.storage.status.tasks.failed
string
ID of the last task to fail execution.
curl --request GET \
--url https://livepeer.studio/api/playback/{id} \
--header 'Authorization: Bearer <api-key>'
{
"type": "vod",
"meta": {
"live": 0,
"playbackPolicy": {
"type": "webhook",
"webhookId": "1bde4o2i6xycudoy",
"webhookContext": {
"streamerId": "my-custom-id"
},
"refreshInterval": 600
},
"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
}
],
"dvrPlayback": [
{
"hrn": "MP4",
"type": "html5/video/mp4",
"url": "https://asset-cdn.lp-playback.monster/hls/1bde4o2i6xycudoy/static360p0.mp4",
"error": "<string>"
}
],
"attestation": {
"id": "5b9e63bb-6fd0-4bea-aff2-cc5d4eb9cad0",
"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,
"createdAt": 1587667174725,
"signatureType": "eip712",
"storage": {
"ipfs": {
"updatedAt": 1587667174725,
"cid": "<string>",
"url": "<string>",
"gatewayUrl": "<string>"
},
"status": {
"phase": "ready",
"progress": 0.5,
"errorMessage": "Failed to update storage",
"tasks": {
"pending": "09F8B46C-61A0-4254-9875-F71F4C605BC7",
"last": "09F8B46C-61A0-4254-9875-F71F4C605BC7",
"failed": "09F8B46C-61A0-4254-9875-F71F4C605BC7"
}
}
}
}
}
}