Skip to main content

Get Media Player Manifest

GET 
/live/:streamKey.json

Retrieve the media player manifest including various formats and encodings.

Generate JWT

Request​

Path Parameters

    streamKey stringrequired

    The unique key identifying the stream.

Query Parameters

    accessToken string

    Optional access token for authorization.

Responses​

Successful response with media manifest

Schema

    self uri

    URL to the manifest itself

    formats

    object

    mp4-hls

    object

    manifest uri

    URL to the HLS manifest

    videoCodec string

    Video codec used

    audioCodec string

    Audio codec used

    encodings

    object[]

  • Array [

    • videoWidth integer

    Video width in pixels

    videoHeight integer

    Video height in pixels

    videoKbps integer

    Video bitrate in Kbps

    audioKbps integer

    Audio bitrate in Kbps

    videoPts integer

    Video presentation timestamp

    audioPts integer

    Audio presentation timestamp

    collected integer

    Timestamp when the data was collected

    location uri

    URL to the specific encoding

  • ]

    • jpeg

    object

    encodings

    object[]

  • Array [

    • videoWidth integer

    Image width in pixels

    videoHeight integer

    Image height in pixels

    location uri

    URL to the JPEG image

  • ]

    • webrtc

    object

    origin

    object

    token string

    Access token for WebRTC

    rsrc string

    Resource identifier

    location uri

    URL to the WebRTC call join endpoint

    callId string

    Unique call identifier

    peerId string

    Peer identifier

    streamNames string[]
    publicKey string

    Public key associated with the stream

    uri uri

    WebSocket URI for WebRTC connection

    httpUri uri

    HTTP URI for WebRTC connection

    region string

    Region of the WebRTC server

    version integer

    Version of the WebRTC protocol

    turn

    object

    servers

    object[]

  • Array [

    • urls uri[]
    username string

    Username for TURN server authentication

    credential string

    Credential for TURN server authentication

    credentialType string

    Type of credential (e.g., password)

  • ]

    • atr string

    Assigned transcode region

    aor string

    Assigned origin region

    abr string

    Assigned order region

    rep boolean

    Replication status

    clientEncoder string

    Information about the client encoder

Loading...