Codecs
For users operating multiple hardware devices, this API supports the following features:
Which codecs/modules are available on each hardware device?
How much of each device’s encoder and decoder capacity is in use?
How much each hardware device is actually being used?
Get Codecs (List and Usage)
On a host running OvenMediaEngine Enterprise, you can query the HW/SW codecs available per hardware device and see their current usage.
Request
GET /v2/internals/codecs
Header
Authorization: Basic {credentials}
# Authorization
Credentials for HTTP Basic Authentication created with <AccessToken>Responses
200 Ok
The request has succeeded
Header
Content-Type: application/jsonBody
{
"message": "OK",
"response": [
{
"busId": "-",
"displayName": "FFmpeg Video Codecs",
"id": 0,
"isDecoder": true,
"isDefault": true,
"isEncoder": false,
"isHwAccel": false,
"mediaType": "Video",
"metrics": {
"active": {
"decoder": 0,
"encoder": 0
}
},
"module": "default",
"name": "default:0",
"supportedCodecs": [
"H264",
"H265",
"VP8"
]
},
{
"busId": "-",
"displayName": "Open Source H.264 Codec",
"id": 0,
"isDecoder": false,
"isDefault": true,
"isEncoder": true,
"isHwAccel": false,
"mediaType": "Video",
"metrics": {
"active": {
"decoder": 0,
"encoder": 0
}
},
"module": "openh264",
"name": "openh264:0",
"supportedCodecs": [
"H264"
]
},
{
"busId": "-",
"displayName": "x264 H.264 Codec",
"id": 0,
"isDecoder": false,
"isDefault": false,
"isEncoder": true,
"isHwAccel": false,
"mediaType": "Video",
"metrics": {
"active": {
"decoder": 0,
"encoder": 0
}
},
"module": "x264",
"name": "x264:0",
"supportedCodecs": [
"H264"
]
},
{
"busId": "-",
"displayName": "WebM VP8/VP9 Codec SDK",
"id": 0,
"isDecoder": false,
"isDefault": true,
"isEncoder": true,
"isHwAccel": false,
"mediaType": "Video",
"metrics": {
"active": {
"decoder": 0,
"encoder": 0
}
},
"module": "libvpx",
"name": "libvpx:0",
"supportedCodecs": [
"VP8"
]
},
{
"busId": "-",
"displayName": "FFmpeg Audio Codecs",
"id": 0,
"isDecoder": true,
"isDefault": true,
"isEncoder": false,
"isHwAccel": false,
"mediaType": "Audio",
"metrics": {
"active": {
"decoder": 5,
"encoder": 0
}
},
"module": "default",
"name": "default:0",
"supportedCodecs": [
"AAC",
"OPUS"
]
},
{
"busId": "-",
"displayName": "Fraunhofer FDK AAC",
"id": 0,
"isDecoder": false,
"isDefault": true,
"isEncoder": true,
"isHwAccel": false,
"mediaType": "Audio",
"metrics": {
"active": {
"decoder": 0,
"encoder": 0
}
},
"module": "fdkaac",
"name": "fdkaac:0",
"supportedCodecs": [
"AAC"
]
},
{
"busId": "-",
"displayName": "Opus Interactive Audio Codec",
"id": 0,
"isDecoder": false,
"isDefault": true,
"isEncoder": true,
"isHwAccel": false,
"mediaType": "Audio",
"metrics": {
"active": {
"decoder": 0,
"encoder": 5
}
},
"module": "libopus",
"name": "libopus:0",
"supportedCodecs": [
"OPUS"
]
},
{
"busId": "-",
"displayName": "FFmpeg Image Codec",
"id": 0,
"isDecoder": false,
"isDefault": true,
"isEncoder": true,
"isHwAccel": false,
"mediaType": "Video",
"metrics": {
"active": {
"decoder": 0,
"encoder": 0
}
},
"module": "default",
"name": "default:0",
"supportedCodecs": [
"JPEG",
"PNG",
"WEBP"
]
},
{
"busId": "00000000:3B:00.0",
"displayName": "NVIDIA GeForce GTX 1050",
"id": 0,
"isDecoder": true,
"isDefault": false,
"isEncoder": true,
"isHwAccel": true,
"mediaType": "Video",
"metrics": {
"active": {
"decoder": 0,
"encoder": 0
}
},
"module": "nv",
"name": "nv:0",
"supportedCodecs": [
"H264",
"H265"
]
},
{
"busId": "00000000:3B:00.0",
"displayName": "NVIDIA GeForce GTX 1050",
"id": 0,
"isDecoder": false,
"isDefault": false,
"isEncoder": true,
"isHwAccel": true,
"mediaType": "Audio",
"metrics": {
"active": {
"decoder": 0,
"encoder": 0
}
},
"module": "nv",
"name": "nv:0",
"supportedCodecs": [
"WHISPER"
]
},
{
"busId": "00000000:AF:00.0",
"displayName": "NVIDIA RTX 4000 SFF Ada Generation",
"id": 1,
"isDecoder": true,
"isDefault": false,
"isEncoder": true,
"isHwAccel": true,
"mediaType": "Video",
"metrics": {
"active": {
"decoder": 0,
"encoder": 0
}
},
"module": "nv",
"name": "nv:1",
"supportedCodecs": [
"H264",
"H265"
]
},
{
"busId": "00000000:AF:00.0",
"displayName": "NVIDIA RTX 4000 SFF Ada Generation",
"id": 1,
"isDecoder": false,
"isDefault": false,
"isEncoder": true,
"isHwAccel": true,
"mediaType": "Audio",
"metrics": {
"active": {
"decoder": 0,
"encoder": 0
}
},
"module": "nv",
"name": "nv:1",
"supportedCodecs": [
"WHISPER"
]
},
{
"busId": "18:01.0",
"displayName": "Xilinx Corporation Device 513d",
"id": 0,
"isDecoder": true,
"isDefault": false,
"isEncoder": true,
"isHwAccel": true,
"mediaType": "Video",
"metrics": {
"active": {
"decoder": 5,
"encoder": 4
}
},
"module": "xma",
"name": "xma:0",
"supportedCodecs": [
"H264",
"H265"
]
}
],
"statusCode": 200
}busId
-
Unique bus identifier of this module or device.
displayName
-
Human-readable display name of this module or device.
id
-
ID assigned to this module or device.
isDecoder
ture | false
Whether this module/device supports decoding.
isDefault
ture | false
Whether this module/device is the default.
isEncoder
ture | false
Whether this module/device supports encoding.
isHwAccel
ture | false
Whether this module/device supports hardware acceleration.
metrics.active.decoder
-
Count of active decoders using this module/device.
metrics.active.encoder
-
Count of active encoders using this module/device.
module
-
Type of the module.
name
{module}:{#}
Module name. e.g., nv:0, nv:1, nv:2, ...
supportedCodecs
-
List of codecs supported by this module.
Last updated
Was this helpful?