View Source

List all the Codecs

GET /codecs/

Parameters

start: offset for paging (optional)
limit: number of codec items per page (optional)
sort: The key by which to sort the result, e.g. "sort=created_at" to sort by creation date.
direction: sort records in ascending ("1") or descending ("-1") order. Default value: "1".
format: json or xml. This will override the Request Accept header.
human: true or false. If true, will return the response in a structured, more human-readable form. Useful when calling the API through curl or from the browser.
type: audio or video. Restricts output to codecs of the specified type.

Response

Besides the array of Codecs, the resource will also return a total number of available Codecs (only if start/limit are set). This can be used to determine how many pages there are and prepare pagination accordingly when presenting the results in a GUI.

codecs: array of Codec items
total: number of total Codec items (optional, see above)
start: offset for paging
limit: number of profile items per page

Example:

curl "https://api.xvid.com/v1/codecs/?format=json&human=true&limit=2"
{
  "codecs": [
    {
      "name": "H.265",
      "description": "H.265 Encoder",
      "type": "video",
      "passes": [
        1,
        1
      ],
      "autograph": [
        false
      ],
      "profiles": [
        {
          "name": "Main",
          "containers": [
            "mkv"
          ],
          "capabilities": {
            "interlaced": [
              false
            ],
            "max_key_distance": [
              1,
              30
            ],
            "max_width": [
              64,
              4096
            ],
            "max_height": [
              64,
              4096
            ],
            "max_framerate": [
              5,
              7.5,
              10,
              15,
              23.976,
              24,
              25,
              29.97,
              30,
              59.94,
              60
            ],
            "max_bitrate": [
              64,
              50000
            ],
            "max_buffersize": [
              128,
              4096
            ]
          }
        }
      ],
      "version": 1,
      "created_at": 1362119988773,
      "updated_at": 1362119988773,
      "id": "525ce63284aed52635e85d04",
      "href": "https://api.xvid.com/v1/codecs/525ce63284aed52635e85d04"
    },
    {
      "name": "H.264",
      "description": "H.264 Encoder",
      "type": "video",
      "passes": [
        1,
        1
      ],
      "autograph": [
        true,
        false
      ],
      "profiles": [
        {
          "name": "Baseline",
          "containers": [
            "flv",
            "mp4",
            "mkv",
            "mov",
            "m4v"
          ],
          "capabilities": {
            "interlaced": [
              false
            ],
            "max_key_distance": [
              1,
              30
            ],
            "max_width": [
              64,
              4096
            ],
            "max_height": [
              64,
              3072
            ],
            "max_framerate": [
              5,
              7.5,
              10,
              15,
              23.976,
              24,
              25,
              29.97,
              30,
              59.94,
              60
            ],
            "max_bitrate": [
              64,
              20000
            ],
            "max_buffersize": [
              128,
              2048
            ],
            "max_ref_frames": [
              1,
              5
            ]
          }
        },
        {
          "name": "Main",
          "containers": [
            "mp4",
            "mkv",
            "mov",
            "m4v"
          ],
          "capabilities": {
            "interlaced": [
              true,
              false
            ],
            "max_key_distance": [
              1,
              30
            ],
            "max_width": [
              64,
              4096
            ],
            "max_height": [
              64,
              3072
            ],
            "max_framerate": [
              5,
              7.5,
              10,
              15,
              23.976,
              24,
              25,
              29.97,
              30,
              59.94,
              60
            ],
            "max_bitrate": [
              64,
              50000
            ],
            "max_buffersize": [
              128,
              2048
            ],
            "max_ref_frames": [
              1,
              5
            ]
          }
        },
        {
          "name": "High",
          "containers": [
            "mp4",
            "mkv",
            "m4v",
            "mov"
          ],
          "capabilities": {
            "interlaced": [
              true,
              false
            ],
            "max_key_distance": [
              1,
              30
            ],
            "max_width": [
              64,
              4096
            ],
            "max_height": [
              64,
              3072
            ],
            "max_framerate": [
              5,
              7.5,
              10,
              15,
              23.976,
              24,
              25,
              29.97,
              30,
              59.94,
              60
            ],
            "max_bitrate": [
              64,
              60000
            ],
            "max_buffersize": [
              256,
              2048
            ],
            "max_ref_frames": [
              1,
              5
            ]
          }
        }
      ],
      "version": 1,
      "created_at": 1362119988773,
      "updated_at": 1362119988773,
      "id": "525ce63284aed52635e85d05",
      "href": "https://api.xvid.com/v1/codecs/525ce63284aed52635e85d05"
    }
  ],
  "total": 9,
  "start": 0,
  "limit": 2,
  "first": {
    "href": "https://api.xvid.com/v1/codecs/?start=0&limit=2&format=json&human=true"
  },
  "last": {
    "href": "https://api.xvid.com/v1/codecs/?start=8&limit=2&format=json&human=true"
  },
  "next": {
    "href": "https://api.xvid.com/v1/codecs/?start=2&limit=2&format=json&human=true"
  },
  "prev": {
    "href": "https://api.xvid.com/v1/codecs/?start=0&limit=2&format=json&human=true"
  }
}