Core API

Nutzen Sie die Vorteile einer FFmpeg REST API für die schnelle und einfache Entwicklung von Videoanwendungen.

Der Core von datarhei Restreamer ist frei und Open Source. Erweitern Sie datarhei Restreamer nach Ihren Bedürfnissen. Flexible Videoverarbeitung mit dem FFMpeg Media Framework wird durch eine API leicht gemacht. Erstellen Sie Ihre eigene Videostreaming- und Verwaltungsplattform mit dem datarhei Core.

| 100% FFmpeg media framework inside | JSON REST-API (Swagger documented) | datarhei Core in Go | GraphQL

https://github.com/datarhei/coregithub.com

datarhei Core auf GitHub

API

API version and build info in case auth is valid or not required. If auth is required, just the name field is populated. https://demo.datarhei.com/api/swagger/index.html

GraphQL

Load GraphQL playground

Load GraphQL playground

GET//api/graph

Authorization

ApiKeyAuth

Response

200

OK

Request

JavaScriptCurl

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

Login

Swagger

Config

Disk filesystem

In-Memory filesystem

Logging

Application log

Get the last log lines of the Restreamer application

GET//api/v3/log

Authorization

ApiKeyAuth

Query parameters

Response

200

application log

Body

application/json

itemsstring

Request

JavaScriptCurl

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

Response

[
  "text"
]

Metadata

Add JSON metadata under the given key

Add arbitrary JSON metadata under the given key. If the key exists, all already stored metadata with this key will be overwritten. If the key doesn't exist, it will be created.

PUT//api/v3/metadata/{key}

Authorization

ApiKeyAuth

Path parameters

key*string

Key for data store

Body

application/json

Arbitrary JSON data

any

Response

200400

OK

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('//api/v3/metadata/{key}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Metrics

Query the collected metrics

Query the collected metrics

POST//api/v3/metrics

Authorization

ApiKeyAuth

Body

application/json

Metrics query

interval_secinteger (int64)

metricsarray of api.MetricsQueryMetric (object)

timerange_secinteger (int64)

Response

200400

OK

Body

application/json

interval_secinteger (int64)

metricsarray of api.MetricsResponseMetric (object)

timerange_secinteger (int64)

Request

JavaScriptCurl

const response = await fetch('//api/v3/metrics', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "metrics": [
    {
      "name": "text",
      "values": [
        {
          "ts": "text",
          "value": 0
        }
      ]
    }
  ]
}

Process

Add a new process

Add a new FFmpeg process

POST//api/v3/process

Authorization

ApiKeyAuth

Body

application/json

Process config

autostartboolean

idstring

input*array of api.ProcessConfigIO (object)

limitsapi.ProcessConfigLimits (object)

optionsarray of string

output*array of api.ProcessConfigIO (object)

reconnectboolean

reconnect_delay_secondsinteger (uint64)

referencestring

stale_timeout_secondsinteger (uint64)

typeenum

ffmpeg

Response

200400

OK

Body

application/json

autostartboolean

idstring

input*array of api.ProcessConfigIO (object)

limitsapi.ProcessConfigLimits (object)

optionsarray of string

output*array of api.ProcessConfigIO (object)

reconnectboolean

reconnect_delay_secondsinteger (uint64)

referencestring

stale_timeout_secondsinteger (uint64)

typeenum

ffmpeg

Request

JavaScriptCurl

const response = await fetch('//api/v3/process', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "input": [
        {
          "address": "text"
        }
      ],
      "output": [
        {
          "address": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "autostart": false,
  "id": "text",
  "input": [
    {
      "address": "text",
      "cleanup": [
        {
          "pattern": "text",
          "purge_on_delete": false
        }
      ],
      "id": "text",
      "options": [
        "text"
      ]
    }
  ],
  "limits": {
    "cpu_usage": 0
  },
  "options": [
    "text"
  ],
  "output": [
    {
      "address": "text",
      "cleanup": [
        {
          "pattern": "text",
          "purge_on_delete": false
        }
      ],
      "id": "text",
      "options": [
        "text"
      ]
    }
  ],
  "reconnect": false,
  "reference": "text",
  "type": "ffmpeg"
}

List a process by its ID

List a process by its ID. Use the filter parameter to specifiy the level of detail of the output.

GET//api/v3/process/{id}

Authorization

ApiKeyAuth

Path parameters

id*string

Process ID

Query parameters

Response

200404

OK

Body

application/json

configapi.ProcessConfig (object)

created_atinteger (int64)

idstring

metadataany

referencestring

reportapi.ProcessReport (object)

stateapi.ProcessState (object)

typestring

updated_atinteger (int64)

Request

JavaScriptCurl

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

Response

{
  "config": {
    "autostart": false,
    "id": "text",
    "input": [
      {
        "address": "text",
        "cleanup": [
          {
            "pattern": "text",
            "purge_on_delete": false
          }
        ],
        "id": "text",
        "options": [
          "text"
        ]
      }
    ],
    "limits": {
      "cpu_usage": 0
    },
    "options": [
      "text"
    ],
    "output": [
      {
        "address": "text",
        "cleanup": [
          {
            "pattern": "text",
            "purge_on_delete": false
          }
        ],
        "id": "text",
        "options": [
          "text"
        ]
      }
    ],
    "reconnect": false,
    "reference": "text",
    "type": "ffmpeg"
  },
  "id": "text",
  "reference": "text",
  "report": {
    "history": [
      {
        "log": [
          [
            "text"
          ]
        ],
        "prelude": [
          "text"
        ]
      }
    ],
    "log": [
      [
        "text"
      ]
    ],
    "prelude": [
      "text"
    ]
  },
  "state": {
    "command": [
      "text"
    ],
    "cpu_usage": 0,
    "exec": "text",
    "last_logline": "text",
    "order": "text",
    "progress": {
      "bitrate_kbit": 0,
      "fps": 0,
      "inputs": [
        {
          "address": "text",
          "avstream": {
            "duplicating": false,
            "gop": "text",
            "input": {
              "state": "running"
            },
            "looping": false,
            "output": {
              "state": "running"
            }
          },
          "bitrate_kbit": 0,
          "codec": "text",
          "coder": "text",
          "format": "text",
          "fps": 0,
          "framerate": {
            "avg": 0,
            "max": 0,
            "min": 0
          },
          "id": "text",
          "layout": "text",
          "pix_fmt": "text",
          "pps": 0,
          "q": 0,
          "type": "text"
        }
      ],
      "outputs": [
        {
          "address": "text",
          "avstream": {
            "duplicating": false,
            "gop": "text",
            "input": {
              "state": "running"
            },
            "looping": false,
            "output": {
              "state": "running"
            }
          },
          "bitrate_kbit": 0,
          "codec": "text",
          "coder": "text",
          "format": "text",
          "fps": 0,
          "framerate": {
            "avg": 0,
            "max": 0,
            "min": 0
          },
          "id": "text",
          "layout": "text",
          "pix_fmt": "text",
          "pps": 0,
          "q": 0,
          "type": "text"
        }
      ],
      "q": 0,
      "speed": 0,
      "time": 0
    }
  },
  "type": "text"
}

Replace an existing process

Replace an existing process.

PUT//api/v3/process/{id}

Authorization

ApiKeyAuth

Path parameters

id*string

Process ID

Body

application/json

Process config

autostartboolean

idstring

input*array of api.ProcessConfigIO (object)

limitsapi.ProcessConfigLimits (object)

optionsarray of string

output*array of api.ProcessConfigIO (object)

reconnectboolean

reconnect_delay_secondsinteger (uint64)

referencestring

stale_timeout_secondsinteger (uint64)

typeenum

ffmpeg

Response

200400404

OK

Body

application/json

autostartboolean

idstring

input*array of api.ProcessConfigIO (object)

limitsapi.ProcessConfigLimits (object)

optionsarray of string

output*array of api.ProcessConfigIO (object)

reconnectboolean

reconnect_delay_secondsinteger (uint64)

referencestring

stale_timeout_secondsinteger (uint64)

typeenum

ffmpeg

Request

JavaScriptCurl

const response = await fetch('//api/v3/process/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "input": [
        {
          "address": "text"
        }
      ],
      "output": [
        {
          "address": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "autostart": false,
  "id": "text",
  "input": [
    {
      "address": "text",
      "cleanup": [
        {
          "pattern": "text",
          "purge_on_delete": false
        }
      ],
      "id": "text",
      "options": [
        "text"
      ]
    }
  ],
  "limits": {
    "cpu_usage": 0
  },
  "options": [
    "text"
  ],
  "output": [
    {
      "address": "text",
      "cleanup": [
        {
          "pattern": "text",
          "purge_on_delete": false
        }
      ],
      "id": "text",
      "options": [
        "text"
      ]
    }
  ],
  "reconnect": false,
  "reference": "text",
  "type": "ffmpeg"
}

Delete a process by its ID

Delete a process by its ID

DELETE//api/v3/process/{id}

Authorization

ApiKeyAuth

Path parameters

id*string

Process ID

Response

200404

OK

Body

application/json

string

Request

JavaScriptCurl

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

Response

"text"

Issue a command to a process

Issue a command to a process: start, stop, reload, restart

PUT//api/v3/process/{id}/command

Authorization

ApiKeyAuth

Path parameters

id*string

Process ID

Body

application/json

Process command

command*enum

startstoprestartreload

Response

200400404

OK

Body

application/json

string

Request

JavaScriptCurl

const response = await fetch('//api/v3/process/{id}/command', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "command": "start"
    }),
});
const data = await response.json();

Response

"text"

Get the configuration of a process

Get the configuration of a process. This is the configuration as provided by Add or Update.

GET//api/v3/process/{id}/config

Authorization

ApiKeyAuth

Path parameters

id*string

Process ID

Response

200400404

OK

Body

application/json

autostartboolean

idstring

input*array of api.ProcessConfigIO (object)

limitsapi.ProcessConfigLimits (object)

optionsarray of string

output*array of api.ProcessConfigIO (object)

reconnectboolean

reconnect_delay_secondsinteger (uint64)

referencestring

stale_timeout_secondsinteger (uint64)

typeenum

ffmpeg

Request

JavaScriptCurl

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

Response

{
  "autostart": false,
  "id": "text",
  "input": [
    {
      "address": "text",
      "cleanup": [
        {
          "pattern": "text",
          "purge_on_delete": false
        }
      ],
      "id": "text",
      "options": [
        "text"
      ]
    }
  ],
  "limits": {
    "cpu_usage": 0
  },
  "options": [
    "text"
  ],
  "output": [
    {
      "address": "text",
      "cleanup": [
        {
          "pattern": "text",
          "purge_on_delete": false
        }
      ],
      "id": "text",
      "options": [
        "text"
      ]
    }
  ],
  "reconnect": false,
  "reference": "text",
  "type": "ffmpeg"
}

Retrieve JSON metadata stored with a process under a key

Retrieve the previously stored JSON metadata under the given key. If the key is empty, all metadata will be returned.

GET//api/v3/process/{id}/metadata/{key}

Authorization

ApiKeyAuth

Path parameters

id*string

Process ID

key*string

Key for data store

Response

200400404

OK

Body

application/json

any

Request

JavaScriptCurl

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

Add JSON metadata with a process under the given key

Add arbitrary JSON metadata under the given key. If the key exists, all already stored metadata with this key will be overwritten. If the key doesn't exist, it will be created.

PUT//api/v3/process/{id}/metadata/{key}

Authorization

ApiKeyAuth

Path parameters

id*string

Process ID

key*string

Key for data store

Body

application/json

Arbitrary JSON data. The null value will remove the key and its contents

any

Response

200400404

OK

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('//api/v3/process/{id}/metadata/{key}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Encode the errorframe

Immediately encode the errorframe (if available and looping)

GET//api/v3/process/{id}/playout/{inputid}/errorframe/encode

Authorization

ApiKeyAuth

Path parameters

id*string

Process ID

inputid*string

Process Input ID

Response

204404500

No Content

Body

text/plainapplication/json

string

Request

JavaScriptCurl

const response = await fetch('//api/v3/process/{id}/playout/{inputid}/errorframe/encode', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"text"

Upload an error frame

Upload an error frame which will be encoded immediately

POST//api/v3/process/{id}/playout/{inputid}/errorframe/{name}

Authorization

ApiKeyAuth

Path parameters

id*string

Process ID

inputid*string

Process Input ID

name*string

Any filename with a suitable extension

Body

application/octet-stream

Image to be used a error frame

itemsinteger

Response

204404500

No Content

Body

text/plainapplication/json

string

Request

JavaScriptCurl

const response = await fetch('//api/v3/process/{id}/playout/{inputid}/errorframe/{name}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/octet-stream"
    },
    body: JSON.stringify([]),
});
const data = await response.json();

Response

"text"

Get the last keyframe

Get the last keyframe of an input of a process. The extension of the name determines the return type.

GET//api/v3/process/{id}/playout/{inputid}/keyframe/{name}

Authorization

ApiKeyAuth

Path parameters

id*string

Process ID

inputid*string

Process Input ID

name*string

Any filename with an extension of .jpg or .png

Response

200404500

OK

Body

image/jpegimage/pngapplication/json

string (binary)

Request

JavaScriptCurl

const response = await fetch('//api/v3/process/{id}/playout/{inputid}/keyframe/{name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"binary"

Close the current input stream

Close the current input stream such that it will be automatically re-opened

GET//api/v3/process/{id}/playout/{inputid}/reopen

Authorization

ApiKeyAuth

Path parameters

id*string

Process ID

inputid*string

Process Input ID

Response

200404500

OK

Body

text/plain

string

Request

JavaScriptCurl

const response = await fetch('//api/v3/process/{id}/playout/{inputid}/reopen', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"text"

Get the current playout status

Get the current playout status of an input of a process

GET//api/v3/process/{id}/playout/{inputid}/status

Authorization

ApiKeyAuth

Path parameters

id*string

Process ID

inputid*string

Process Input ID

Response

200404500

OK

Body

application/json

aqueueinteger (uint64)

debugany

dropinteger (uint64)

dupinteger (uint64)

duplicatingboolean

encinteger (uint64)

gopstring

idstring

inputapi.PlayoutStatusIO (object)

loopingboolean

outputapi.PlayoutStatusIO (object)

queueinteger (uint64)

streaminteger (uint64)

swapapi.PlayoutStatusSwap (object)

urlstring

Request

JavaScriptCurl

const response = await fetch('//api/v3/process/{id}/playout/{inputid}/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "duplicating": false,
  "gop": "text",
  "id": "text",
  "input": {
    "state": "running"
  },
  "looping": false,
  "output": {
    "state": "running"
  },
  "swap": {
    "lasterror": "text",
    "lasturl": "text",
    "status": "text",
    "url": "text"
  },
  "url": "text"
}

Switch to a new stream

Replace the current stream with the one from the given URL. The switch will only happen if the stream parameters match.

PUT//api/v3/process/{id}/playout/{inputid}/stream

Authorization

ApiKeyAuth

Path parameters

id*string

Process ID

inputid*string

Process Input ID

Body

text/plain

URL of the new stream

string

Response

204404500

No Content

Body

text/plainapplication/json

string

Request

JavaScriptCurl

const response = await fetch('//api/v3/process/{id}/playout/{inputid}/stream', {
    method: 'PUT',
    headers: {
      "Content-Type": "text/plain"
    },
    body: JSON.stringify("text"),
});
const data = await response.json();

Response

"text"

Probe a process

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

GET//api/v3/process/{id}/probe

Authorization

ApiKeyAuth

Path parameters

id*string

Process ID

Response

200

OK

Body

application/json

logarray of string

streamsarray of api.ProbeIO (object)

Request

JavaScriptCurl

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

Response

{
  "log": [
    "text"
  ],
  "streams": [
    {
      "bitrate_kbps": 0,
      "codec": "text",
      "coder": "text",
      "duration_sec": 0,
      "format": "text",
      "fps": 0,
      "language": "text",
      "layout": "text",
      "pix_fmt": "text",
      "type": "text",
      "url": "text"
    }
  ]
}

Get the logs of a process

Get the logs and the log history of a process.

GET//api/v3/process/{id}/report

Authorization

ApiKeyAuth

Path parameters

id*string

Process ID

Response

200400404

OK

Body

application/json

created_atinteger (int64)

historyarray of api.ProcessReportHistoryEntry (object)

logarray of array of string

preludearray of string

Request

JavaScriptCurl

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

Response

{
  "history": [
    {
      "log": [
        [
          "text"
        ]
      ],
      "prelude": [
        "text"
      ]
    }
  ],
  "log": [
    [
      "text"
    ]
  ],
  "prelude": [
    "text"
  ]
}

Get the state of a process

Get the state and progress data of a process.

GET//api/v3/process/{id}/state

Authorization

ApiKeyAuth

Path parameters

id*string

Process ID

Response

200400404

OK

Body

application/json

commandarray of string

cpu_usagenumber

execstring

last_loglinestring

memory_bytesinteger (uint64)

orderstring

progressapi.Progress (object)

reconnect_secondsinteger (int64)

runtime_secondsinteger (int64)

Request

JavaScriptCurl

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

Response

{
  "command": [
    "text"
  ],
  "cpu_usage": 0,
  "exec": "text",
  "last_logline": "text",
  "order": "text",
  "progress": {
    "bitrate_kbit": 0,
    "fps": 0,
    "inputs": [
      {
        "address": "text",
        "avstream": {
          "duplicating": false,
          "gop": "text",
          "input": {
            "state": "running"
          },
          "looping": false,
          "output": {
            "state": "running"
          }
        },
        "bitrate_kbit": 0,
        "codec": "text",
        "coder": "text",
        "format": "text",
        "fps": 0,
        "framerate": {
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "id": "text",
        "layout": "text",
        "pix_fmt": "text",
        "pps": 0,
        "q": 0,
        "type": "text"
      }
    ],
    "outputs": [
      {
        "address": "text",
        "avstream": {
          "duplicating": false,
          "gop": "text",
          "input": {
            "state": "running"
          },
          "looping": false,
          "output": {
            "state": "running"
          }
        },
        "bitrate_kbit": 0,
        "codec": "text",
        "coder": "text",
        "format": "text",
        "fps": 0,
        "framerate": {
          "avg": 0,
          "max": 0,
          "min": 0
        },
        "id": "text",
        "layout": "text",
        "pix_fmt": "text",
        "pps": 0,
        "q": 0,
        "type": "text"
      }
    ],
    "q": 0,
    "speed": 0,
    "time": 0
  }
}

RTMP

Session

Get a minimal summary of all active sessions

Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth).

GET//api/v3/session/active

Authorization

ApiKeyAuth

Query parameters

Response

200

Active sessions listing

Body

application/json

Other propertiesarray of api.Session (object)

Request

JavaScriptCurl

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

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"
      }
    ]
  }
}

Widget

Metrics

Ping

Profiling

Mehr Informationen

pageLeitfädenpageHandbuch