Substream Metadata

Returns technical metadata about the audio and video streams for a specific substream.

Request

Property	Value
Method	`GET`
URL	`/api/streams/{appName}/{streamKey}/{substreamName}/metadata`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X GET "{BASE_URL}/api/streams/{appName}/{streamKey}/{substreamName}/metadata" \
  -H "Authorization: Bearer YOUR_TOKEN"

Path Parameters

Parameter	Type	Required	Description
`appName`	string	Yes	Application name
`streamKey`	string	Yes	Stream key
`substreamName`	string	Yes	Substream name

Request

bash

curl -X GET "{BASE_URL}/api/streams/{appName}/{streamKey}/{substreamName}/metadata" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

General Info

Parameter	Type	Description
`data.encoderName`	string	Encoder software name and version
`data.legacyEncoder`	string	Legacy encoder identifier
`data.duration`	integer	Stream duration (0 for live)

Video Metadata

Parameter	Type	Description
`data.videoCodec`	string	Video codec name
`data.videoCodecID`	integer	Video codec ID
`data.videoDataRate`	integer	Video bitrate in kbps
`data.videoTimeScale`	integer	Video time scale (ticks per second)
`data.width`	integer	Video width in pixels
`data.height`	integer	Video height in pixels
`data.frameRate`	number	Frame rate in fps
`data.frameRateSpecified`	boolean	Indicates if frame rate is explicitly set

Audio Metadata

Parameter	Type	Description
`data.audioCodec`	string	Audio codec name
`data.audioCodecID`	integer	Audio codec ID
`data.audioDataRate`	integer	Audio bitrate in kbps
`data.audioSampleRate`	integer	Audio sample rate in Hz
`data.audioSampleSize`	integer	Audio sample size in bits
`data.audioChannels`	integer	Number of audio channels

Metadata

Parameter	Type	Description
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "data": {
    "encoderName": "Lavf60.16.100",
    "legacyEncoder": "Unknown",
    "duration": 0,
    "videoCodec": "AVC_H264",
    "videoCodecID": 7,
    "videoDataRate": 3417,
    "videoTimeScale": 90000,
    "width": 1720,
    "height": 720,
    "frameRate": 30,
    "frameRateSpecified": true,
    "audioCodec": "AAC",
    "audioCodecID": 10,
    "audioDataRate": 146,
    "audioSampleRate": 48000,
    "audioSampleSize": 16,
    "audioChannels": 0
  },
  "meta": {
    "executionTime": 1,
    "generatedAt": 1764757205404
  }
}

Error Responses

Substream Not Found (404)

Parameter	Type	Description
`message`	string	Human-readable error message

json

{
  "message": "Substream not found"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.