Get Media Player Manifest

GET 
/manifest/live/:streamKey

Retrieve the media player manifest including various formats and encodings. This endpoint is also available with a .json suffix

Generate JWT

Request

Path Parameters

streamKey stringrequired

The unique key identifying the stream.

Query Parameters

accessToken string

Optional access token for authorization.

Responses

200

Successful response with media manifest

application/json

Schema

Schema

selfuri

URL to the manifest itself

formats

object

mp4-hls

object

manifesturi

URL to the HLS manifest

videoCodecstring

Video codec used

audioCodecstring

Audio codec used

encodings

object[]

Array [

videoWidthinteger

Video width in pixels

videoHeightinteger

Video height in pixels

videoKbpsinteger

Video bitrate in Kbps

audioKbpsinteger

Audio bitrate in Kbps

videoPtsinteger

Video presentation timestamp

audioPtsinteger

Audio presentation timestamp

collectedinteger

Timestamp when the data was collected

locationuri

URL to the specific encoding

]

jpeg

object

encodings

object[]

Array [

videoWidthinteger

Image width in pixels

videoHeightinteger

Image height in pixels

locationuri

URL to the JPEG image

]

webrtc

object

origin

object

tokenstring

Access token for WebRTC

rsrcstring

Resource identifier

locationuri

URL to the WebRTC call join endpoint

callIdstring

Unique call identifier

peerIdstring

Peer identifier

streamNamesstring[]

publicKeystring

Public key associated with the stream

uriuri

WebSocket URI for WebRTC connection

httpUriuri

HTTP URI for WebRTC connection

regionstring

Region of the WebRTC server

versioninteger

Version of the WebRTC protocol

turn

object

servers

object[]

Array [

urlsuri[]

usernamestring

Username for TURN server authentication

credentialstring

Credential for TURN server authentication

credentialTypestring

Type of credential (e.g., password)

]

atrstring

Assigned transcode region

aorstring

Assigned origin region

abrstring

Assigned order region

repboolean

Replication status

clientEncoderstring

Information about the client encoder

Example (from schema)

{
  "self": "string",
  "formats": {
    "mp4-hls": {
      "manifest": "string",
      "videoCodec": "string",
      "audioCodec": "string",
      "encodings": [
        {
          "videoWidth": 0,
          "videoHeight": 0,
          "videoKbps": 0,
          "audioKbps": 0,
          "videoPts": 0,
          "audioPts": 0,
          "collected": 0,
          "location": "string"
        }
      ]
    },
    "jpeg": {
      "encodings": [
        {
          "videoWidth": 0,
          "videoHeight": 0,
          "location": "string"
        }
      ]
    },
    "webrtc": {
      "origin": {
        "token": "string",
        "rsrc": "string",
        "location": "string",
        "callId": "string",
        "peerId": "string",
        "streamNames": [
          "string"
        ],
        "publicKey": "string",
        "uri": "string",
        "httpUri": "string",
        "region": "string",
        "version": 0,
        "turn": {
          "servers": [
            {
              "urls": [
                "string"
              ],
              "username": "string",
              "credential": "string",
              "credentialType": "string"
            }
          ]
        }
      }
    }
  },
  "atr": "string",
  "aor": "string",
  "abr": "string",
  "rep": true,
  "clientEncoder": "string"
}

404

Not Found - The specified stream key is offline.

500

Internal Server Error - A server error occurred.