Skills

Skills denote the capabilities of the used FFmpeg binary. It includes version information, supported input and output protocols, available hardware accelerators, supported formats for muxing and demuxing, filters, and available input and output devices.

Read

Example:

Curl

curl http://127.0.0.1:8080/api/v3/skills \
   -H 'accept: application/json' \
   -X GET

PyClient

from core_client import Client

client = Client(
    base_url="http://127.0.0.1:8080"
)
client.login()

core_ffmpeg_skills = client.v3_skills_get()
print(core_ffmpeg_skills)

GoClient

import (
    "fmt"
    "github.com/datarhei/core-client-go/v16"
)

client, _ := coreclient.New(coreclient.Config{
    Address: "https://127.0.0.1:8080",
})

skills, err := client.Skills()
fmt.Printf("%+v\n", skills)

Description:

FFmpeg capabilities

List all detected FFmpeg capabilities.

GET//api/v3/skills

Authorization

ApiKeyAuth

Response

200

OK

Body

application/json

codecsobject

devicesobject

ffmpegobject

filterarray of api.SkillsFilter (object)

formatsobject

hwaccelsarray of api.SkillsHWAccel (object)

protocolsobject

Request

JavaScriptCurl

const response = await fetch('//api/v3/skills', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "codecs": {
    "audio": [
      {
        "decoders": [
          "text"
        ],
        "encoders": [
          "text"
        ],
        "id": "text",
        "name": "text"
      }
    ],
    "subtitle": [
      {
        "decoders": [
          "text"
        ],
        "encoders": [
          "text"
        ],
        "id": "text",
        "name": "text"
      }
    ],
    "video": [
      {
        "decoders": [
          "text"
        ],
        "encoders": [
          "text"
        ],
        "id": "text",
        "name": "text"
      }
    ]
  },
  "devices": {
    "demuxers": [
      {
        "devices": [
          {
            "extra": "text",
            "id": "text",
            "media": "text",
            "name": "text"
          }
        ],
        "id": "text",
        "name": "text"
      }
    ],
    "muxers": [
      {
        "devices": [
          {
            "extra": "text",
            "id": "text",
            "media": "text",
            "name": "text"
          }
        ],
        "id": "text",
        "name": "text"
      }
    ]
  },
  "ffmpeg": {
    "compiler": "text",
    "configuration": "text",
    "libraries": [
      {
        "compiled": "text",
        "linked": "text",
        "name": "text"
      }
    ],
    "version": "text"
  },
  "filter": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "formats": {
    "demuxers": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "muxers": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  },
  "hwaccels": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "protocols": {
    "input": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "output": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}

Reload

Reloading the skills might be necessary if you plug e.g. an USB device. It will only show up in the list of available devices if they are probed again.

Example:

Curl

curl http://127.0.0.1:8080/api/v3/skills/reload \
   -H 'accept: application/json' \
   -X GET

PyClient

from core_client import Client

client = Client(
    base_url="http://127.0.0.1:8080"
)
client.login()

client.v3_skills_reload()

GoClient

import (
    "fmt"
    "github.com/datarhei/core-client-go/v16"
)

client, _ := coreclient.New(coreclient.Config{
    Address: "https://127.0.0.1:8080",
})

err := client.SkillsReload()
if err != nil {
    ...
}

skills, err := client.Skills()
fmt.Printf("%+v\n", skills)

Refresh FFmpeg capabilities

Refresh the available FFmpeg capabilities.

GET//api/v3/skills/reload

Authorization

ApiKeyAuth

Response

200

OK

Body

application/json

codecsobject

devicesobject

ffmpegobject

filterarray of api.SkillsFilter (object)

formatsobject

hwaccelsarray of api.SkillsHWAccel (object)

protocolsobject

Request

JavaScriptCurl

const response = await fetch('//api/v3/skills/reload', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "codecs": {
    "audio": [
      {
        "decoders": [
          "text"
        ],
        "encoders": [
          "text"
        ],
        "id": "text",
        "name": "text"
      }
    ],
    "subtitle": [
      {
        "decoders": [
          "text"
        ],
        "encoders": [
          "text"
        ],
        "id": "text",
        "name": "text"
      }
    ],
    "video": [
      {
        "decoders": [
          "text"
        ],
        "encoders": [
          "text"
        ],
        "id": "text",
        "name": "text"
      }
    ]
  },
  "devices": {
    "demuxers": [
      {
        "devices": [
          {
            "extra": "text",
            "id": "text",
            "media": "text",
            "name": "text"
          }
        ],
        "id": "text",
        "name": "text"
      }
    ],
    "muxers": [
      {
        "devices": [
          {
            "extra": "text",
            "id": "text",
            "media": "text",
            "name": "text"
          }
        ],
        "id": "text",
        "name": "text"
      }
    ]
  },
  "ffmpeg": {
    "compiler": "text",
    "configuration": "text",
    "libraries": [
      {
        "compiled": "text",
        "linked": "text",
        "name": "text"
      }
    ],
    "version": "text"
  },
  "filter": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "formats": {
    "demuxers": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "muxers": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  },
  "hwaccels": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "protocols": {
    "input": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "output": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}