Probe

Probing a process means to detect the vitals of the inputs of a process, e.g. frames, bitrate, codec, ... for each input and stream, e.g. a video file on disk may contain two video streams (low and high resolution, audio and subtitle streams in different languages).

A process must already exists before it can be probed. During probing only the global FFmpeg options and the inputs are used to construct the FFmpeg command line.

The probe returns an object with an array of the detected streams and any array of lines from the output from the ffmpeg command.

In the following example we assume the process config with these inputs for the process test. Parts that are not relevant for probing have been left out for brevity:

{
    "options": ["-err_detect", "ignore_err", "-y"],
    "input": [
      {
        "address": "testsrc2=rate=25:size=640x360",
        "id": "input_0",
        "options": ["-f", "lavfi", "-re"]
      },
      {
        "address": "anullsrc=r=44100:cl=stereo",
        "id": "input_1",
        "options": ["-f", "lavfi"]
      }
    ]
}

The expected result would be:

The field index refers to the input and the field stream refers to the stream of an input.

Example: probe the inputs of a process with the ID test:

Description:

Probe a process

get

Probe an existing process to get a detailed stream information on the inputs.

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired

Process ID

Responses
200

OK

application/json
get
/api/v3/process/{id}/probe
200

OK

Last updated

Was this helpful?