mirror of
https://github.com/datarhei/core.git
synced 2025-09-27 12:22:28 +08:00
Add version annotation to API methods
This commit is contained in:
158
docs/docs.go
158
docs/docs.go
@@ -62,7 +62,7 @@ const docTemplate = `{
|
|||||||
"operationId": "graph-playground",
|
"operationId": "graph-playground",
|
||||||
"responses": {
|
"responses": {
|
||||||
"200": {
|
"200": {
|
||||||
"description": ""
|
"description": "OK"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -220,6 +220,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Retrieve the currently active Restreamer configuration",
|
"summary": "Retrieve the currently active Restreamer configuration",
|
||||||
"operationId": "config-3-get",
|
"operationId": "config-3-get",
|
||||||
"responses": {
|
"responses": {
|
||||||
@@ -244,6 +247,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Update the current Restreamer configuration",
|
"summary": "Update the current Restreamer configuration",
|
||||||
"operationId": "config-3-set",
|
"operationId": "config-3-set",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -290,6 +296,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"text/plain"
|
"text/plain"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Reload the currently active configuration",
|
"summary": "Reload the currently active configuration",
|
||||||
"operationId": "config-3-reload",
|
"operationId": "config-3-reload",
|
||||||
"responses": {
|
"responses": {
|
||||||
@@ -313,6 +322,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "List all files on the filesystem",
|
"summary": "List all files on the filesystem",
|
||||||
"operationId": "diskfs-3-list-files",
|
"operationId": "diskfs-3-list-files",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -360,6 +372,9 @@ const docTemplate = `{
|
|||||||
"application/data",
|
"application/data",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Fetch a file from the filesystem",
|
"summary": "Fetch a file from the filesystem",
|
||||||
"operationId": "diskfs-3-get-file",
|
"operationId": "diskfs-3-get-file",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -406,6 +421,9 @@ const docTemplate = `{
|
|||||||
"text/plain",
|
"text/plain",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Add a file to the filesystem",
|
"summary": "Add a file to the filesystem",
|
||||||
"operationId": "diskfs-3-put-file",
|
"operationId": "diskfs-3-put-file",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -460,6 +478,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"text/plain"
|
"text/plain"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Remove a file from the filesystem",
|
"summary": "Remove a file from the filesystem",
|
||||||
"operationId": "diskfs-3-delete-file",
|
"operationId": "diskfs-3-delete-file",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -498,6 +519,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "List all files on the memory filesystem",
|
"summary": "List all files on the memory filesystem",
|
||||||
"operationId": "memfs-3-list-files",
|
"operationId": "memfs-3-list-files",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -545,6 +569,9 @@ const docTemplate = `{
|
|||||||
"application/data",
|
"application/data",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Fetch a file from the memory filesystem",
|
"summary": "Fetch a file from the memory filesystem",
|
||||||
"operationId": "memfs-3-get-file",
|
"operationId": "memfs-3-get-file",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -591,6 +618,9 @@ const docTemplate = `{
|
|||||||
"text/plain",
|
"text/plain",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Add a file to the memory filesystem",
|
"summary": "Add a file to the memory filesystem",
|
||||||
"operationId": "memfs-3-put-file",
|
"operationId": "memfs-3-put-file",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -645,6 +675,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"text/plain"
|
"text/plain"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Remove a file from the memory filesystem",
|
"summary": "Remove a file from the memory filesystem",
|
||||||
"operationId": "memfs-3-delete-file",
|
"operationId": "memfs-3-delete-file",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -685,6 +718,9 @@ const docTemplate = `{
|
|||||||
"text/plain",
|
"text/plain",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Create a link to a file in the memory filesystem",
|
"summary": "Create a link to a file in the memory filesystem",
|
||||||
"operationId": "memfs-3-patch",
|
"operationId": "memfs-3-patch",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -732,6 +768,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Application log",
|
"summary": "Application log",
|
||||||
"operationId": "log-3",
|
"operationId": "log-3",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -766,6 +805,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Retrieve JSON metadata from a key",
|
"summary": "Retrieve JSON metadata from a key",
|
||||||
"operationId": "metadata-3-get",
|
"operationId": "metadata-3-get",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -806,6 +848,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Add JSON metadata under the given key",
|
"summary": "Add JSON metadata under the given key",
|
||||||
"operationId": "metadata-3-set",
|
"operationId": "metadata-3-set",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -849,6 +894,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.10.0"
|
||||||
|
],
|
||||||
"summary": "List all known metrics with their description and labels",
|
"summary": "List all known metrics with their description and labels",
|
||||||
"operationId": "metrics-3-describe",
|
"operationId": "metrics-3-describe",
|
||||||
"responses": {
|
"responses": {
|
||||||
@@ -876,6 +924,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Query the collected metrics",
|
"summary": "Query the collected metrics",
|
||||||
"operationId": "metrics-3-metrics",
|
"operationId": "metrics-3-metrics",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -916,6 +967,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "List all known processes",
|
"summary": "List all known processes",
|
||||||
"operationId": "process-3-get-all",
|
"operationId": "process-3-get-all",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -975,6 +1029,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Add a new process",
|
"summary": "Add a new process",
|
||||||
"operationId": "process-3-add",
|
"operationId": "process-3-add",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1015,6 +1072,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "List a process by its ID",
|
"summary": "List a process by its ID",
|
||||||
"operationId": "process-3-get",
|
"operationId": "process-3-get",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1053,13 +1113,16 @@ const docTemplate = `{
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Replace an existing process. This is a shortcut for DELETE+POST.",
|
"description": "Replace an existing process.",
|
||||||
"consumes": [
|
"consumes": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Replace an existing process",
|
"summary": "Replace an existing process",
|
||||||
"operationId": "process-3-update",
|
"operationId": "process-3-update",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1111,6 +1174,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Delete a process by its ID",
|
"summary": "Delete a process by its ID",
|
||||||
"operationId": "process-3-delete",
|
"operationId": "process-3-delete",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1152,6 +1218,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Issue a command to a process",
|
"summary": "Issue a command to a process",
|
||||||
"operationId": "process-3-command",
|
"operationId": "process-3-command",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1205,6 +1274,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Get the configuration of a process",
|
"summary": "Get the configuration of a process",
|
||||||
"operationId": "process-3-get-config",
|
"operationId": "process-3-get-config",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1249,6 +1321,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Retrieve JSON metadata stored with a process under a key",
|
"summary": "Retrieve JSON metadata stored with a process under a key",
|
||||||
"operationId": "process-3-get-process-metadata",
|
"operationId": "process-3-get-process-metadata",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1296,6 +1371,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Add JSON metadata with a process under the given key",
|
"summary": "Add JSON metadata with a process under the given key",
|
||||||
"operationId": "process-3-set-process-metadata",
|
"operationId": "process-3-set-process-metadata",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1353,6 +1431,9 @@ const docTemplate = `{
|
|||||||
"text/plain",
|
"text/plain",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Encode the errorframe",
|
"summary": "Encode the errorframe",
|
||||||
"operationId": "process-3-playout-errorframencode",
|
"operationId": "process-3-playout-errorframencode",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1408,6 +1489,9 @@ const docTemplate = `{
|
|||||||
"text/plain",
|
"text/plain",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Upload an error frame",
|
"summary": "Upload an error frame",
|
||||||
"operationId": "process-3-playout-errorframe",
|
"operationId": "process-3-playout-errorframe",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1480,6 +1564,9 @@ const docTemplate = `{
|
|||||||
"image/png",
|
"image/png",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Get the last keyframe",
|
"summary": "Get the last keyframe",
|
||||||
"operationId": "process-3-playout-keyframe",
|
"operationId": "process-3-playout-keyframe",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1538,6 +1625,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"text/plain"
|
"text/plain"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Close the current input stream",
|
"summary": "Close the current input stream",
|
||||||
"operationId": "process-3-playout-reopen-input",
|
"operationId": "process-3-playout-reopen-input",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1589,6 +1679,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Get the current playout status",
|
"summary": "Get the current playout status",
|
||||||
"operationId": "process-3-playout-status",
|
"operationId": "process-3-playout-status",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1644,6 +1737,9 @@ const docTemplate = `{
|
|||||||
"text/plain",
|
"text/plain",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Switch to a new stream",
|
"summary": "Switch to a new stream",
|
||||||
"operationId": "process-3-playout-stream",
|
"operationId": "process-3-playout-stream",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1700,10 +1796,13 @@ const docTemplate = `{
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Probe an existing process to get a detailed stream information on the inputs",
|
"description": "Probe an existing process to get a detailed stream information on the inputs.",
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Probe a process",
|
"summary": "Probe a process",
|
||||||
"operationId": "process-3-probe",
|
"operationId": "process-3-probe",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1732,10 +1831,13 @@ const docTemplate = `{
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Get the logs and the log history of a process",
|
"description": "Get the logs and the log history of a process.",
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Get the logs of a process",
|
"summary": "Get the logs of a process",
|
||||||
"operationId": "process-3-get-report",
|
"operationId": "process-3-get-report",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1776,10 +1878,13 @@ const docTemplate = `{
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Get the state and progress data of a process",
|
"description": "Get the state and progress data of a process.",
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Get the state of a process",
|
"summary": "Get the state of a process",
|
||||||
"operationId": "process-3-get-state",
|
"operationId": "process-3-get-state",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1820,10 +1925,13 @@ const docTemplate = `{
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "List all currently publishing RTMP streams",
|
"description": "List all currently publishing RTMP streams.",
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "List all publishing RTMP streams",
|
"summary": "List all publishing RTMP streams",
|
||||||
"operationId": "rtmp-3-list-channels",
|
"operationId": "rtmp-3-list-channels",
|
||||||
"responses": {
|
"responses": {
|
||||||
@@ -1846,10 +1954,13 @@ const docTemplate = `{
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Get a summary of all active and past sessions of the given collector",
|
"description": "Get a summary of all active and past sessions of the given collector.",
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Get a summary of all active and past sessions",
|
"summary": "Get a summary of all active and past sessions",
|
||||||
"operationId": "session-3-summary",
|
"operationId": "session-3-summary",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1877,10 +1988,13 @@ const docTemplate = `{
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth)",
|
"description": "Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth).",
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Get a minimal summary of all active sessions",
|
"summary": "Get a minimal summary of all active sessions",
|
||||||
"operationId": "session-3-current",
|
"operationId": "session-3-current",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1908,10 +2022,13 @@ const docTemplate = `{
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "List all detected FFmpeg capabilities",
|
"description": "List all detected FFmpeg capabilities.",
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "FFmpeg capabilities",
|
"summary": "FFmpeg capabilities",
|
||||||
"operationId": "skills-3",
|
"operationId": "skills-3",
|
||||||
"responses": {
|
"responses": {
|
||||||
@@ -1931,10 +2048,13 @@ const docTemplate = `{
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Refresh the available FFmpeg capabilities",
|
"description": "Refresh the available FFmpeg capabilities.",
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Refresh FFmpeg capabilities",
|
"summary": "Refresh FFmpeg capabilities",
|
||||||
"operationId": "skills-3-reload",
|
"operationId": "skills-3-reload",
|
||||||
"responses": {
|
"responses": {
|
||||||
@@ -1958,6 +2078,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.9.0"
|
||||||
|
],
|
||||||
"summary": "List all publishing SRT treams",
|
"summary": "List all publishing SRT treams",
|
||||||
"operationId": "srt-3-list-channels",
|
"operationId": "srt-3-list-channels",
|
||||||
"responses": {
|
"responses": {
|
||||||
@@ -1979,6 +2102,9 @@ const docTemplate = `{
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Fetch minimal statistics about a process",
|
"summary": "Fetch minimal statistics about a process",
|
||||||
"operationId": "widget-3-get",
|
"operationId": "widget-3-get",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -2427,7 +2553,7 @@ const docTemplate = `{
|
|||||||
"tenants": {
|
"tenants": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"$ref": "#/definitions/config.Auth0Tenant"
|
"$ref": "#/definitions/value.Auth0Tenant"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -2837,6 +2963,9 @@ const docTemplate = `{
|
|||||||
"cert_file": {
|
"cert_file": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
|
"email": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
"enable": {
|
"enable": {
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
},
|
},
|
||||||
@@ -4052,7 +4181,7 @@ const docTemplate = `{
|
|||||||
"tenants": {
|
"tenants": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"$ref": "#/definitions/config.Auth0Tenant"
|
"$ref": "#/definitions/value.Auth0Tenant"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -4462,6 +4591,9 @@ const docTemplate = `{
|
|||||||
"cert_file": {
|
"cert_file": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
|
"email": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
"enable": {
|
"enable": {
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
},
|
},
|
||||||
@@ -4741,7 +4873,7 @@ const docTemplate = `{
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"config.Auth0Tenant": {
|
"value.Auth0Tenant": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"audience": {
|
"audience": {
|
||||||
|
@@ -54,7 +54,7 @@
|
|||||||
"operationId": "graph-playground",
|
"operationId": "graph-playground",
|
||||||
"responses": {
|
"responses": {
|
||||||
"200": {
|
"200": {
|
||||||
"description": ""
|
"description": "OK"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -212,6 +212,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Retrieve the currently active Restreamer configuration",
|
"summary": "Retrieve the currently active Restreamer configuration",
|
||||||
"operationId": "config-3-get",
|
"operationId": "config-3-get",
|
||||||
"responses": {
|
"responses": {
|
||||||
@@ -236,6 +239,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Update the current Restreamer configuration",
|
"summary": "Update the current Restreamer configuration",
|
||||||
"operationId": "config-3-set",
|
"operationId": "config-3-set",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -282,6 +288,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"text/plain"
|
"text/plain"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Reload the currently active configuration",
|
"summary": "Reload the currently active configuration",
|
||||||
"operationId": "config-3-reload",
|
"operationId": "config-3-reload",
|
||||||
"responses": {
|
"responses": {
|
||||||
@@ -305,6 +314,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "List all files on the filesystem",
|
"summary": "List all files on the filesystem",
|
||||||
"operationId": "diskfs-3-list-files",
|
"operationId": "diskfs-3-list-files",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -352,6 +364,9 @@
|
|||||||
"application/data",
|
"application/data",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Fetch a file from the filesystem",
|
"summary": "Fetch a file from the filesystem",
|
||||||
"operationId": "diskfs-3-get-file",
|
"operationId": "diskfs-3-get-file",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -398,6 +413,9 @@
|
|||||||
"text/plain",
|
"text/plain",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Add a file to the filesystem",
|
"summary": "Add a file to the filesystem",
|
||||||
"operationId": "diskfs-3-put-file",
|
"operationId": "diskfs-3-put-file",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -452,6 +470,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"text/plain"
|
"text/plain"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Remove a file from the filesystem",
|
"summary": "Remove a file from the filesystem",
|
||||||
"operationId": "diskfs-3-delete-file",
|
"operationId": "diskfs-3-delete-file",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -490,6 +511,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "List all files on the memory filesystem",
|
"summary": "List all files on the memory filesystem",
|
||||||
"operationId": "memfs-3-list-files",
|
"operationId": "memfs-3-list-files",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -537,6 +561,9 @@
|
|||||||
"application/data",
|
"application/data",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Fetch a file from the memory filesystem",
|
"summary": "Fetch a file from the memory filesystem",
|
||||||
"operationId": "memfs-3-get-file",
|
"operationId": "memfs-3-get-file",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -583,6 +610,9 @@
|
|||||||
"text/plain",
|
"text/plain",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Add a file to the memory filesystem",
|
"summary": "Add a file to the memory filesystem",
|
||||||
"operationId": "memfs-3-put-file",
|
"operationId": "memfs-3-put-file",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -637,6 +667,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"text/plain"
|
"text/plain"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Remove a file from the memory filesystem",
|
"summary": "Remove a file from the memory filesystem",
|
||||||
"operationId": "memfs-3-delete-file",
|
"operationId": "memfs-3-delete-file",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -677,6 +710,9 @@
|
|||||||
"text/plain",
|
"text/plain",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Create a link to a file in the memory filesystem",
|
"summary": "Create a link to a file in the memory filesystem",
|
||||||
"operationId": "memfs-3-patch",
|
"operationId": "memfs-3-patch",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -724,6 +760,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Application log",
|
"summary": "Application log",
|
||||||
"operationId": "log-3",
|
"operationId": "log-3",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -758,6 +797,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Retrieve JSON metadata from a key",
|
"summary": "Retrieve JSON metadata from a key",
|
||||||
"operationId": "metadata-3-get",
|
"operationId": "metadata-3-get",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -798,6 +840,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Add JSON metadata under the given key",
|
"summary": "Add JSON metadata under the given key",
|
||||||
"operationId": "metadata-3-set",
|
"operationId": "metadata-3-set",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -841,6 +886,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.10.0"
|
||||||
|
],
|
||||||
"summary": "List all known metrics with their description and labels",
|
"summary": "List all known metrics with their description and labels",
|
||||||
"operationId": "metrics-3-describe",
|
"operationId": "metrics-3-describe",
|
||||||
"responses": {
|
"responses": {
|
||||||
@@ -868,6 +916,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Query the collected metrics",
|
"summary": "Query the collected metrics",
|
||||||
"operationId": "metrics-3-metrics",
|
"operationId": "metrics-3-metrics",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -908,6 +959,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "List all known processes",
|
"summary": "List all known processes",
|
||||||
"operationId": "process-3-get-all",
|
"operationId": "process-3-get-all",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -967,6 +1021,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Add a new process",
|
"summary": "Add a new process",
|
||||||
"operationId": "process-3-add",
|
"operationId": "process-3-add",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1007,6 +1064,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "List a process by its ID",
|
"summary": "List a process by its ID",
|
||||||
"operationId": "process-3-get",
|
"operationId": "process-3-get",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1045,13 +1105,16 @@
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Replace an existing process. This is a shortcut for DELETE+POST.",
|
"description": "Replace an existing process.",
|
||||||
"consumes": [
|
"consumes": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Replace an existing process",
|
"summary": "Replace an existing process",
|
||||||
"operationId": "process-3-update",
|
"operationId": "process-3-update",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1103,6 +1166,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Delete a process by its ID",
|
"summary": "Delete a process by its ID",
|
||||||
"operationId": "process-3-delete",
|
"operationId": "process-3-delete",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1144,6 +1210,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Issue a command to a process",
|
"summary": "Issue a command to a process",
|
||||||
"operationId": "process-3-command",
|
"operationId": "process-3-command",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1197,6 +1266,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Get the configuration of a process",
|
"summary": "Get the configuration of a process",
|
||||||
"operationId": "process-3-get-config",
|
"operationId": "process-3-get-config",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1241,6 +1313,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Retrieve JSON metadata stored with a process under a key",
|
"summary": "Retrieve JSON metadata stored with a process under a key",
|
||||||
"operationId": "process-3-get-process-metadata",
|
"operationId": "process-3-get-process-metadata",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1288,6 +1363,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Add JSON metadata with a process under the given key",
|
"summary": "Add JSON metadata with a process under the given key",
|
||||||
"operationId": "process-3-set-process-metadata",
|
"operationId": "process-3-set-process-metadata",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1345,6 +1423,9 @@
|
|||||||
"text/plain",
|
"text/plain",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Encode the errorframe",
|
"summary": "Encode the errorframe",
|
||||||
"operationId": "process-3-playout-errorframencode",
|
"operationId": "process-3-playout-errorframencode",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1400,6 +1481,9 @@
|
|||||||
"text/plain",
|
"text/plain",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Upload an error frame",
|
"summary": "Upload an error frame",
|
||||||
"operationId": "process-3-playout-errorframe",
|
"operationId": "process-3-playout-errorframe",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1472,6 +1556,9 @@
|
|||||||
"image/png",
|
"image/png",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Get the last keyframe",
|
"summary": "Get the last keyframe",
|
||||||
"operationId": "process-3-playout-keyframe",
|
"operationId": "process-3-playout-keyframe",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1530,6 +1617,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"text/plain"
|
"text/plain"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Close the current input stream",
|
"summary": "Close the current input stream",
|
||||||
"operationId": "process-3-playout-reopen-input",
|
"operationId": "process-3-playout-reopen-input",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1581,6 +1671,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Get the current playout status",
|
"summary": "Get the current playout status",
|
||||||
"operationId": "process-3-playout-status",
|
"operationId": "process-3-playout-status",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1636,6 +1729,9 @@
|
|||||||
"text/plain",
|
"text/plain",
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Switch to a new stream",
|
"summary": "Switch to a new stream",
|
||||||
"operationId": "process-3-playout-stream",
|
"operationId": "process-3-playout-stream",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1692,10 +1788,13 @@
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Probe an existing process to get a detailed stream information on the inputs",
|
"description": "Probe an existing process to get a detailed stream information on the inputs.",
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Probe a process",
|
"summary": "Probe a process",
|
||||||
"operationId": "process-3-probe",
|
"operationId": "process-3-probe",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1724,10 +1823,13 @@
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Get the logs and the log history of a process",
|
"description": "Get the logs and the log history of a process.",
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Get the logs of a process",
|
"summary": "Get the logs of a process",
|
||||||
"operationId": "process-3-get-report",
|
"operationId": "process-3-get-report",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1768,10 +1870,13 @@
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Get the state and progress data of a process",
|
"description": "Get the state and progress data of a process.",
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Get the state of a process",
|
"summary": "Get the state of a process",
|
||||||
"operationId": "process-3-get-state",
|
"operationId": "process-3-get-state",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1812,10 +1917,13 @@
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "List all currently publishing RTMP streams",
|
"description": "List all currently publishing RTMP streams.",
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "List all publishing RTMP streams",
|
"summary": "List all publishing RTMP streams",
|
||||||
"operationId": "rtmp-3-list-channels",
|
"operationId": "rtmp-3-list-channels",
|
||||||
"responses": {
|
"responses": {
|
||||||
@@ -1838,10 +1946,13 @@
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Get a summary of all active and past sessions of the given collector",
|
"description": "Get a summary of all active and past sessions of the given collector.",
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Get a summary of all active and past sessions",
|
"summary": "Get a summary of all active and past sessions",
|
||||||
"operationId": "session-3-summary",
|
"operationId": "session-3-summary",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1869,10 +1980,13 @@
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth)",
|
"description": "Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth).",
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Get a minimal summary of all active sessions",
|
"summary": "Get a minimal summary of all active sessions",
|
||||||
"operationId": "session-3-current",
|
"operationId": "session-3-current",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -1900,10 +2014,13 @@
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "List all detected FFmpeg capabilities",
|
"description": "List all detected FFmpeg capabilities.",
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "FFmpeg capabilities",
|
"summary": "FFmpeg capabilities",
|
||||||
"operationId": "skills-3",
|
"operationId": "skills-3",
|
||||||
"responses": {
|
"responses": {
|
||||||
@@ -1923,10 +2040,13 @@
|
|||||||
"ApiKeyAuth": []
|
"ApiKeyAuth": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"description": "Refresh the available FFmpeg capabilities",
|
"description": "Refresh the available FFmpeg capabilities.",
|
||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Refresh FFmpeg capabilities",
|
"summary": "Refresh FFmpeg capabilities",
|
||||||
"operationId": "skills-3-reload",
|
"operationId": "skills-3-reload",
|
||||||
"responses": {
|
"responses": {
|
||||||
@@ -1950,6 +2070,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.9.0"
|
||||||
|
],
|
||||||
"summary": "List all publishing SRT treams",
|
"summary": "List all publishing SRT treams",
|
||||||
"operationId": "srt-3-list-channels",
|
"operationId": "srt-3-list-channels",
|
||||||
"responses": {
|
"responses": {
|
||||||
@@ -1971,6 +2094,9 @@
|
|||||||
"produces": [
|
"produces": [
|
||||||
"application/json"
|
"application/json"
|
||||||
],
|
],
|
||||||
|
"tags": [
|
||||||
|
"v16.7.2"
|
||||||
|
],
|
||||||
"summary": "Fetch minimal statistics about a process",
|
"summary": "Fetch minimal statistics about a process",
|
||||||
"operationId": "widget-3-get",
|
"operationId": "widget-3-get",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -2419,7 +2545,7 @@
|
|||||||
"tenants": {
|
"tenants": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"$ref": "#/definitions/config.Auth0Tenant"
|
"$ref": "#/definitions/value.Auth0Tenant"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -2829,6 +2955,9 @@
|
|||||||
"cert_file": {
|
"cert_file": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
|
"email": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
"enable": {
|
"enable": {
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
},
|
},
|
||||||
@@ -4044,7 +4173,7 @@
|
|||||||
"tenants": {
|
"tenants": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"$ref": "#/definitions/config.Auth0Tenant"
|
"$ref": "#/definitions/value.Auth0Tenant"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -4454,6 +4583,9 @@
|
|||||||
"cert_file": {
|
"cert_file": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
|
"email": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
"enable": {
|
"enable": {
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
},
|
},
|
||||||
@@ -4733,7 +4865,7 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"config.Auth0Tenant": {
|
"value.Auth0Tenant": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"audience": {
|
"audience": {
|
||||||
|
@@ -122,7 +122,7 @@ definitions:
|
|||||||
type: boolean
|
type: boolean
|
||||||
tenants:
|
tenants:
|
||||||
items:
|
items:
|
||||||
$ref: '#/definitions/config.Auth0Tenant'
|
$ref: '#/definitions/value.Auth0Tenant'
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
disable_localhost:
|
disable_localhost:
|
||||||
@@ -388,6 +388,8 @@ definitions:
|
|||||||
type: boolean
|
type: boolean
|
||||||
cert_file:
|
cert_file:
|
||||||
type: string
|
type: string
|
||||||
|
email:
|
||||||
|
type: string
|
||||||
enable:
|
enable:
|
||||||
type: boolean
|
type: boolean
|
||||||
key_file:
|
key_file:
|
||||||
@@ -1245,7 +1247,7 @@ definitions:
|
|||||||
type: boolean
|
type: boolean
|
||||||
tenants:
|
tenants:
|
||||||
items:
|
items:
|
||||||
$ref: '#/definitions/config.Auth0Tenant'
|
$ref: '#/definitions/value.Auth0Tenant'
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
disable_localhost:
|
disable_localhost:
|
||||||
@@ -1511,6 +1513,8 @@ definitions:
|
|||||||
type: boolean
|
type: boolean
|
||||||
cert_file:
|
cert_file:
|
||||||
type: string
|
type: string
|
||||||
|
email:
|
||||||
|
type: string
|
||||||
enable:
|
enable:
|
||||||
type: boolean
|
type: boolean
|
||||||
key_file:
|
key_file:
|
||||||
@@ -1691,7 +1695,7 @@ definitions:
|
|||||||
uptime:
|
uptime:
|
||||||
type: integer
|
type: integer
|
||||||
type: object
|
type: object
|
||||||
config.Auth0Tenant:
|
value.Auth0Tenant:
|
||||||
properties:
|
properties:
|
||||||
audience:
|
audience:
|
||||||
type: string
|
type: string
|
||||||
@@ -1767,7 +1771,7 @@ paths:
|
|||||||
- text/html
|
- text/html
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: ""
|
description: OK
|
||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Load GraphQL playground
|
summary: Load GraphQL playground
|
||||||
@@ -1876,6 +1880,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Retrieve the currently active Restreamer configuration
|
summary: Retrieve the currently active Restreamer configuration
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
put:
|
put:
|
||||||
consumes:
|
consumes:
|
||||||
- application/json
|
- application/json
|
||||||
@@ -1907,6 +1913,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Update the current Restreamer configuration
|
summary: Update the current Restreamer configuration
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/config/reload:
|
/api/v3/config/reload:
|
||||||
get:
|
get:
|
||||||
description: Reload the currently active configuration. This will trigger a
|
description: Reload the currently active configuration. This will trigger a
|
||||||
@@ -1922,6 +1930,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Reload the currently active configuration
|
summary: Reload the currently active configuration
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/fs/disk:
|
/api/v3/fs/disk:
|
||||||
get:
|
get:
|
||||||
description: List all files on the filesystem. The listing can be ordered by
|
description: List all files on the filesystem. The listing can be ordered by
|
||||||
@@ -1952,6 +1962,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: List all files on the filesystem
|
summary: List all files on the filesystem
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/fs/disk/{path}:
|
/api/v3/fs/disk/{path}:
|
||||||
delete:
|
delete:
|
||||||
description: Remove a file from the filesystem
|
description: Remove a file from the filesystem
|
||||||
@@ -1976,6 +1988,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Remove a file from the filesystem
|
summary: Remove a file from the filesystem
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
get:
|
get:
|
||||||
description: Fetch a file from the filesystem. The contents of that file are
|
description: Fetch a file from the filesystem. The contents of that file are
|
||||||
returned.
|
returned.
|
||||||
@@ -2005,6 +2019,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Fetch a file from the filesystem
|
summary: Fetch a file from the filesystem
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
put:
|
put:
|
||||||
consumes:
|
consumes:
|
||||||
- application/data
|
- application/data
|
||||||
@@ -2043,6 +2059,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Add a file to the filesystem
|
summary: Add a file to the filesystem
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/fs/mem:
|
/api/v3/fs/mem:
|
||||||
get:
|
get:
|
||||||
description: List all files on the memory filesystem. The listing can be ordered
|
description: List all files on the memory filesystem. The listing can be ordered
|
||||||
@@ -2073,6 +2091,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: List all files on the memory filesystem
|
summary: List all files on the memory filesystem
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/fs/mem/{path}:
|
/api/v3/fs/mem/{path}:
|
||||||
delete:
|
delete:
|
||||||
description: Remove a file from the memory filesystem
|
description: Remove a file from the memory filesystem
|
||||||
@@ -2097,6 +2117,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Remove a file from the memory filesystem
|
summary: Remove a file from the memory filesystem
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
get:
|
get:
|
||||||
description: Fetch a file from the memory filesystem
|
description: Fetch a file from the memory filesystem
|
||||||
operationId: memfs-3-get-file
|
operationId: memfs-3-get-file
|
||||||
@@ -2125,6 +2147,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Fetch a file from the memory filesystem
|
summary: Fetch a file from the memory filesystem
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
patch:
|
patch:
|
||||||
consumes:
|
consumes:
|
||||||
- application/data
|
- application/data
|
||||||
@@ -2158,6 +2182,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Create a link to a file in the memory filesystem
|
summary: Create a link to a file in the memory filesystem
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
put:
|
put:
|
||||||
consumes:
|
consumes:
|
||||||
- application/data
|
- application/data
|
||||||
@@ -2196,6 +2222,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Add a file to the memory filesystem
|
summary: Add a file to the memory filesystem
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/log:
|
/api/v3/log:
|
||||||
get:
|
get:
|
||||||
description: Get the last log lines of the Restreamer application
|
description: Get the last log lines of the Restreamer application
|
||||||
@@ -2217,6 +2245,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Application log
|
summary: Application log
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/metadata/{key}:
|
/api/v3/metadata/{key}:
|
||||||
get:
|
get:
|
||||||
description: Retrieve the previously stored JSON metadata under the given key.
|
description: Retrieve the previously stored JSON metadata under the given key.
|
||||||
@@ -2245,6 +2275,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Retrieve JSON metadata from a key
|
summary: Retrieve JSON metadata from a key
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
put:
|
put:
|
||||||
description: Add arbitrary JSON metadata under the given key. If the key exists,
|
description: 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
|
all already stored metadata with this key will be overwritten. If the key
|
||||||
@@ -2274,6 +2306,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Add JSON metadata under the given key
|
summary: Add JSON metadata under the given key
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/metrics:
|
/api/v3/metrics:
|
||||||
get:
|
get:
|
||||||
description: List all known metrics with their description and labels
|
description: List all known metrics with their description and labels
|
||||||
@@ -2290,6 +2324,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: List all known metrics with their description and labels
|
summary: List all known metrics with their description and labels
|
||||||
|
tags:
|
||||||
|
- v16.10.0
|
||||||
post:
|
post:
|
||||||
consumes:
|
consumes:
|
||||||
- application/json
|
- application/json
|
||||||
@@ -2316,6 +2352,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Query the collected metrics
|
summary: Query the collected metrics
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/process:
|
/api/v3/process:
|
||||||
get:
|
get:
|
||||||
description: List all known processes. Use the query parameter to filter the
|
description: List all known processes. Use the query parameter to filter the
|
||||||
@@ -2360,6 +2398,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: List all known processes
|
summary: List all known processes
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
post:
|
post:
|
||||||
consumes:
|
consumes:
|
||||||
- application/json
|
- application/json
|
||||||
@@ -2386,6 +2426,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Add a new process
|
summary: Add a new process
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/process/{id}:
|
/api/v3/process/{id}:
|
||||||
delete:
|
delete:
|
||||||
description: Delete a process by its ID
|
description: Delete a process by its ID
|
||||||
@@ -2410,6 +2452,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Delete a process by its ID
|
summary: Delete a process by its ID
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
get:
|
get:
|
||||||
description: List a process by its ID. Use the filter parameter to specifiy
|
description: List a process by its ID. Use the filter parameter to specifiy
|
||||||
the level of detail of the output.
|
the level of detail of the output.
|
||||||
@@ -2439,10 +2483,12 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: List a process by its ID
|
summary: List a process by its ID
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
put:
|
put:
|
||||||
consumes:
|
consumes:
|
||||||
- application/json
|
- application/json
|
||||||
description: Replace an existing process. This is a shortcut for DELETE+POST.
|
description: Replace an existing process.
|
||||||
operationId: process-3-update
|
operationId: process-3-update
|
||||||
parameters:
|
parameters:
|
||||||
- description: Process ID
|
- description: Process ID
|
||||||
@@ -2474,6 +2520,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Replace an existing process
|
summary: Replace an existing process
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/process/{id}/command:
|
/api/v3/process/{id}/command:
|
||||||
put:
|
put:
|
||||||
consumes:
|
consumes:
|
||||||
@@ -2510,6 +2558,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Issue a command to a process
|
summary: Issue a command to a process
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/process/{id}/config:
|
/api/v3/process/{id}/config:
|
||||||
get:
|
get:
|
||||||
description: Get the configuration of a process. This is the configuration as
|
description: Get the configuration of a process. This is the configuration as
|
||||||
@@ -2539,6 +2589,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Get the configuration of a process
|
summary: Get the configuration of a process
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/process/{id}/metadata/{key}:
|
/api/v3/process/{id}/metadata/{key}:
|
||||||
get:
|
get:
|
||||||
description: Retrieve the previously stored JSON metadata under the given key.
|
description: Retrieve the previously stored JSON metadata under the given key.
|
||||||
@@ -2572,6 +2624,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Retrieve JSON metadata stored with a process under a key
|
summary: Retrieve JSON metadata stored with a process under a key
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
put:
|
put:
|
||||||
description: Add arbitrary JSON metadata under the given key. If the key exists,
|
description: 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
|
all already stored metadata with this key will be overwritten. If the key
|
||||||
@@ -2611,6 +2665,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Add JSON metadata with a process under the given key
|
summary: Add JSON metadata with a process under the given key
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/process/{id}/playout/{inputid}/errorframe/{name}:
|
/api/v3/process/{id}/playout/{inputid}/errorframe/{name}:
|
||||||
post:
|
post:
|
||||||
consumes:
|
consumes:
|
||||||
@@ -2660,6 +2716,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Upload an error frame
|
summary: Upload an error frame
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/process/{id}/playout/{inputid}/errorframe/encode:
|
/api/v3/process/{id}/playout/{inputid}/errorframe/encode:
|
||||||
get:
|
get:
|
||||||
description: Immediately encode the errorframe (if available and looping)
|
description: Immediately encode the errorframe (if available and looping)
|
||||||
@@ -2694,6 +2752,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Encode the errorframe
|
summary: Encode the errorframe
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/process/{id}/playout/{inputid}/keyframe/{name}:
|
/api/v3/process/{id}/playout/{inputid}/keyframe/{name}:
|
||||||
get:
|
get:
|
||||||
description: Get the last keyframe of an input of a process. The extension of
|
description: Get the last keyframe of an input of a process. The extension of
|
||||||
@@ -2735,6 +2795,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Get the last keyframe
|
summary: Get the last keyframe
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/process/{id}/playout/{inputid}/reopen:
|
/api/v3/process/{id}/playout/{inputid}/reopen:
|
||||||
get:
|
get:
|
||||||
description: Close the current input stream such that it will be automatically
|
description: Close the current input stream such that it will be automatically
|
||||||
@@ -2769,6 +2831,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Close the current input stream
|
summary: Close the current input stream
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/process/{id}/playout/{inputid}/status:
|
/api/v3/process/{id}/playout/{inputid}/status:
|
||||||
get:
|
get:
|
||||||
description: Get the current playout status of an input of a process
|
description: Get the current playout status of an input of a process
|
||||||
@@ -2802,6 +2866,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Get the current playout status
|
summary: Get the current playout status
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/process/{id}/playout/{inputid}/stream:
|
/api/v3/process/{id}/playout/{inputid}/stream:
|
||||||
put:
|
put:
|
||||||
consumes:
|
consumes:
|
||||||
@@ -2845,10 +2911,12 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Switch to a new stream
|
summary: Switch to a new stream
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/process/{id}/probe:
|
/api/v3/process/{id}/probe:
|
||||||
get:
|
get:
|
||||||
description: Probe an existing process to get a detailed stream information
|
description: Probe an existing process to get a detailed stream information
|
||||||
on the inputs
|
on the inputs.
|
||||||
operationId: process-3-probe
|
operationId: process-3-probe
|
||||||
parameters:
|
parameters:
|
||||||
- description: Process ID
|
- description: Process ID
|
||||||
@@ -2866,9 +2934,11 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Probe a process
|
summary: Probe a process
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/process/{id}/report:
|
/api/v3/process/{id}/report:
|
||||||
get:
|
get:
|
||||||
description: Get the logs and the log history of a process
|
description: Get the logs and the log history of a process.
|
||||||
operationId: process-3-get-report
|
operationId: process-3-get-report
|
||||||
parameters:
|
parameters:
|
||||||
- description: Process ID
|
- description: Process ID
|
||||||
@@ -2894,9 +2964,11 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Get the logs of a process
|
summary: Get the logs of a process
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/process/{id}/state:
|
/api/v3/process/{id}/state:
|
||||||
get:
|
get:
|
||||||
description: Get the state and progress data of a process
|
description: Get the state and progress data of a process.
|
||||||
operationId: process-3-get-state
|
operationId: process-3-get-state
|
||||||
parameters:
|
parameters:
|
||||||
- description: Process ID
|
- description: Process ID
|
||||||
@@ -2922,9 +2994,11 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Get the state of a process
|
summary: Get the state of a process
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/rtmp:
|
/api/v3/rtmp:
|
||||||
get:
|
get:
|
||||||
description: List all currently publishing RTMP streams
|
description: List all currently publishing RTMP streams.
|
||||||
operationId: rtmp-3-list-channels
|
operationId: rtmp-3-list-channels
|
||||||
produces:
|
produces:
|
||||||
- application/json
|
- application/json
|
||||||
@@ -2938,9 +3012,11 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: List all publishing RTMP streams
|
summary: List all publishing RTMP streams
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/session:
|
/api/v3/session:
|
||||||
get:
|
get:
|
||||||
description: Get a summary of all active and past sessions of the given collector
|
description: Get a summary of all active and past sessions of the given collector.
|
||||||
operationId: session-3-summary
|
operationId: session-3-summary
|
||||||
parameters:
|
parameters:
|
||||||
- description: Comma separated list of collectors
|
- description: Comma separated list of collectors
|
||||||
@@ -2957,10 +3033,12 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Get a summary of all active and past sessions
|
summary: Get a summary of all active and past sessions
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/session/active:
|
/api/v3/session/active:
|
||||||
get:
|
get:
|
||||||
description: Get a minimal summary of all active sessions (i.e. number of sessions,
|
description: Get a minimal summary of all active sessions (i.e. number of sessions,
|
||||||
bandwidth)
|
bandwidth).
|
||||||
operationId: session-3-current
|
operationId: session-3-current
|
||||||
parameters:
|
parameters:
|
||||||
- description: Comma separated list of collectors
|
- description: Comma separated list of collectors
|
||||||
@@ -2977,9 +3055,11 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Get a minimal summary of all active sessions
|
summary: Get a minimal summary of all active sessions
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/skills:
|
/api/v3/skills:
|
||||||
get:
|
get:
|
||||||
description: List all detected FFmpeg capabilities
|
description: List all detected FFmpeg capabilities.
|
||||||
operationId: skills-3
|
operationId: skills-3
|
||||||
produces:
|
produces:
|
||||||
- application/json
|
- application/json
|
||||||
@@ -2991,9 +3071,11 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: FFmpeg capabilities
|
summary: FFmpeg capabilities
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/skills/reload:
|
/api/v3/skills/reload:
|
||||||
get:
|
get:
|
||||||
description: Refresh the available FFmpeg capabilities
|
description: Refresh the available FFmpeg capabilities.
|
||||||
operationId: skills-3-reload
|
operationId: skills-3-reload
|
||||||
produces:
|
produces:
|
||||||
- application/json
|
- application/json
|
||||||
@@ -3005,6 +3087,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: Refresh FFmpeg capabilities
|
summary: Refresh FFmpeg capabilities
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/api/v3/srt:
|
/api/v3/srt:
|
||||||
get:
|
get:
|
||||||
description: List all currently publishing SRT streams. This endpoint is EXPERIMENTAL
|
description: List all currently publishing SRT streams. This endpoint is EXPERIMENTAL
|
||||||
@@ -3022,6 +3106,8 @@ paths:
|
|||||||
security:
|
security:
|
||||||
- ApiKeyAuth: []
|
- ApiKeyAuth: []
|
||||||
summary: List all publishing SRT treams
|
summary: List all publishing SRT treams
|
||||||
|
tags:
|
||||||
|
- v16.9.0
|
||||||
/api/v3/widget/process/{id}:
|
/api/v3/widget/process/{id}:
|
||||||
get:
|
get:
|
||||||
description: Fetch minimal statistics about a process, which is not protected
|
description: Fetch minimal statistics about a process, which is not protected
|
||||||
@@ -3045,6 +3131,8 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
$ref: '#/definitions/api.Error'
|
$ref: '#/definitions/api.Error'
|
||||||
summary: Fetch minimal statistics about a process
|
summary: Fetch minimal statistics about a process
|
||||||
|
tags:
|
||||||
|
- v16.7.2
|
||||||
/memfs/{path}:
|
/memfs/{path}:
|
||||||
delete:
|
delete:
|
||||||
description: Remove a file from the memory filesystem
|
description: Remove a file from the memory filesystem
|
||||||
|
@@ -28,6 +28,7 @@ func NewConfig(store cfgstore.Store) *ConfigHandler {
|
|||||||
// Get returns the currently active Restreamer configuration
|
// Get returns the currently active Restreamer configuration
|
||||||
// @Summary Retrieve the currently active Restreamer configuration
|
// @Summary Retrieve the currently active Restreamer configuration
|
||||||
// @Description Retrieve the currently active Restreamer configuration
|
// @Description Retrieve the currently active Restreamer configuration
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID config-3-get
|
// @ID config-3-get
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Success 200 {object} api.Config
|
// @Success 200 {object} api.Config
|
||||||
@@ -45,6 +46,7 @@ func (p *ConfigHandler) Get(c echo.Context) error {
|
|||||||
// Set will set the given configuration as new active configuration
|
// Set will set the given configuration as new active configuration
|
||||||
// @Summary Update the current Restreamer configuration
|
// @Summary Update the current Restreamer configuration
|
||||||
// @Description Update the current Restreamer configuration by providing a complete or partial configuration. Fields that are not provided will not be changed.
|
// @Description Update the current Restreamer configuration by providing a complete or partial configuration. Fields that are not provided will not be changed.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID config-3-set
|
// @ID config-3-set
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Produce json
|
// @Produce json
|
||||||
@@ -156,6 +158,7 @@ func (p *ConfigHandler) Set(c echo.Context) error {
|
|||||||
// Reload will reload the currently active configuration
|
// Reload will reload the currently active configuration
|
||||||
// @Summary Reload the currently active configuration
|
// @Summary Reload the currently active configuration
|
||||||
// @Description Reload the currently active configuration. This will trigger a restart of the Restreamer.
|
// @Description Reload the currently active configuration. This will trigger a restart of the Restreamer.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID config-3-reload
|
// @ID config-3-reload
|
||||||
// @Produce plain
|
// @Produce plain
|
||||||
// @Success 200 {string} string "OK"
|
// @Success 200 {string} string "OK"
|
||||||
|
@@ -34,6 +34,7 @@ func NewDiskFS(fs fs.Filesystem, cache cache.Cacher) *DiskFSHandler {
|
|||||||
// GetFile returns the file at the given path
|
// GetFile returns the file at the given path
|
||||||
// @Summary Fetch a file from the filesystem
|
// @Summary Fetch a file from the filesystem
|
||||||
// @Description Fetch a file from the filesystem. The contents of that file are returned.
|
// @Description Fetch a file from the filesystem. The contents of that file are returned.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID diskfs-3-get-file
|
// @ID diskfs-3-get-file
|
||||||
// @Produce application/data
|
// @Produce application/data
|
||||||
// @Produce json
|
// @Produce json
|
||||||
@@ -86,6 +87,7 @@ func (h *DiskFSHandler) GetFile(c echo.Context) error {
|
|||||||
// PutFile adds or overwrites a file at the given path
|
// PutFile adds or overwrites a file at the given path
|
||||||
// @Summary Add a file to the filesystem
|
// @Summary Add a file to the filesystem
|
||||||
// @Description Writes or overwrites a file on the filesystem
|
// @Description Writes or overwrites a file on the filesystem
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID diskfs-3-put-file
|
// @ID diskfs-3-put-file
|
||||||
// @Accept application/data
|
// @Accept application/data
|
||||||
// @Produce text/plain
|
// @Produce text/plain
|
||||||
@@ -125,6 +127,7 @@ func (h *DiskFSHandler) PutFile(c echo.Context) error {
|
|||||||
// DeleteFile removes a file from the filesystem
|
// DeleteFile removes a file from the filesystem
|
||||||
// @Summary Remove a file from the filesystem
|
// @Summary Remove a file from the filesystem
|
||||||
// @Description Remove a file from the filesystem
|
// @Description Remove a file from the filesystem
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID diskfs-3-delete-file
|
// @ID diskfs-3-delete-file
|
||||||
// @Produce text/plain
|
// @Produce text/plain
|
||||||
// @Param path path string true "Path to file"
|
// @Param path path string true "Path to file"
|
||||||
@@ -153,6 +156,7 @@ func (h *DiskFSHandler) DeleteFile(c echo.Context) error {
|
|||||||
// ListFiles lists all files on the filesystem
|
// ListFiles lists all files on the filesystem
|
||||||
// @Summary List all files on the filesystem
|
// @Summary List all files on the filesystem
|
||||||
// @Description List all files on the filesystem. The listing can be ordered by name, size, or date of last modification in ascending or descending order.
|
// @Description List all files on the filesystem. The listing can be ordered by name, size, or date of last modification in ascending or descending order.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID diskfs-3-list-files
|
// @ID diskfs-3-list-files
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Param glob query string false "glob pattern for file names"
|
// @Param glob query string false "glob pattern for file names"
|
||||||
|
@@ -31,6 +31,7 @@ func NewLog(buffer log.BufferWriter) *LogHandler {
|
|||||||
// Log returns the last log lines of the Restreamer application
|
// Log returns the last log lines of the Restreamer application
|
||||||
// @Summary Application log
|
// @Summary Application log
|
||||||
// @Description Get the last log lines of the Restreamer application
|
// @Description Get the last log lines of the Restreamer application
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID log-3
|
// @ID log-3
|
||||||
// @Param format query string false "Format of the list of log events (*console, raw)"
|
// @Param format query string false "Format of the list of log events (*console, raw)"
|
||||||
// @Produce json
|
// @Produce json
|
||||||
|
@@ -31,6 +31,7 @@ func NewMemFS(fs fs.Filesystem) *MemFSHandler {
|
|||||||
// GetFileAPI returns the file at the given path
|
// GetFileAPI returns the file at the given path
|
||||||
// @Summary Fetch a file from the memory filesystem
|
// @Summary Fetch a file from the memory filesystem
|
||||||
// @Description Fetch a file from the memory filesystem
|
// @Description Fetch a file from the memory filesystem
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID memfs-3-get-file
|
// @ID memfs-3-get-file
|
||||||
// @Produce application/data
|
// @Produce application/data
|
||||||
// @Produce json
|
// @Produce json
|
||||||
@@ -47,6 +48,7 @@ func (h *MemFSHandler) GetFile(c echo.Context) error {
|
|||||||
// PutFileAPI adds or overwrites a file at the given path
|
// PutFileAPI adds or overwrites a file at the given path
|
||||||
// @Summary Add a file to the memory filesystem
|
// @Summary Add a file to the memory filesystem
|
||||||
// @Description Writes or overwrites a file on the memory filesystem
|
// @Description Writes or overwrites a file on the memory filesystem
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID memfs-3-put-file
|
// @ID memfs-3-put-file
|
||||||
// @Accept application/data
|
// @Accept application/data
|
||||||
// @Produce text/plain
|
// @Produce text/plain
|
||||||
@@ -65,6 +67,7 @@ func (h *MemFSHandler) PutFile(c echo.Context) error {
|
|||||||
// DeleteFileAPI removes a file from the filesystem
|
// DeleteFileAPI removes a file from the filesystem
|
||||||
// @Summary Remove a file from the memory filesystem
|
// @Summary Remove a file from the memory filesystem
|
||||||
// @Description Remove a file from the memory filesystem
|
// @Description Remove a file from the memory filesystem
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID memfs-3-delete-file
|
// @ID memfs-3-delete-file
|
||||||
// @Produce text/plain
|
// @Produce text/plain
|
||||||
// @Param path path string true "Path to file"
|
// @Param path path string true "Path to file"
|
||||||
@@ -79,6 +82,7 @@ func (h *MemFSHandler) DeleteFile(c echo.Context) error {
|
|||||||
// PatchFile creates a symbolic link to a file in the filesystem
|
// PatchFile creates a symbolic link to a file in the filesystem
|
||||||
// @Summary Create a link to a file in the memory filesystem
|
// @Summary Create a link to a file in the memory filesystem
|
||||||
// @Description Create a link to a file in the memory filesystem. The file linked to has to exist.
|
// @Description Create a link to a file in the memory filesystem. The file linked to has to exist.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID memfs-3-patch
|
// @ID memfs-3-patch
|
||||||
// @Accept application/data
|
// @Accept application/data
|
||||||
// @Produce text/plain
|
// @Produce text/plain
|
||||||
@@ -118,6 +122,7 @@ func (h *MemFSHandler) PatchFile(c echo.Context) error {
|
|||||||
// ListFiles lists all files on the filesystem
|
// ListFiles lists all files on the filesystem
|
||||||
// @Summary List all files on the memory filesystem
|
// @Summary List all files on the memory filesystem
|
||||||
// @Description List all files on the memory filesystem. The listing can be ordered by name, size, or date of last modification in ascending or descending order.
|
// @Description List all files on the memory filesystem. The listing can be ordered by name, size, or date of last modification in ascending or descending order.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID memfs-3-list-files
|
// @ID memfs-3-list-files
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Param glob query string false "glob pattern for file names"
|
// @Param glob query string false "glob pattern for file names"
|
||||||
|
@@ -32,6 +32,7 @@ func NewMetrics(config MetricsConfig) *MetricsHandler {
|
|||||||
// Describe the known metrics
|
// Describe the known metrics
|
||||||
// @Summary List all known metrics with their description and labels
|
// @Summary List all known metrics with their description and labels
|
||||||
// @Description List all known metrics with their description and labels
|
// @Description List all known metrics with their description and labels
|
||||||
|
// @Tags v16.10.0
|
||||||
// @ID metrics-3-describe
|
// @ID metrics-3-describe
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Success 200 {array} api.MetricsDescription
|
// @Success 200 {array} api.MetricsDescription
|
||||||
@@ -60,6 +61,7 @@ func (r *MetricsHandler) Describe(c echo.Context) error {
|
|||||||
// Query the collected metrics
|
// Query the collected metrics
|
||||||
// @Summary Query the collected metrics
|
// @Summary Query the collected metrics
|
||||||
// @Description Query the collected metrics
|
// @Description Query the collected metrics
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID metrics-3-metrics
|
// @ID metrics-3-metrics
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Produce json
|
// @Produce json
|
||||||
|
@@ -31,6 +31,7 @@ func NewPlayout(restream restream.Restreamer) *PlayoutHandler {
|
|||||||
// Status return the current playout status
|
// Status return the current playout status
|
||||||
// @Summary Get the current playout status
|
// @Summary Get the current playout status
|
||||||
// @Description Get the current playout status of an input of a process
|
// @Description Get the current playout status of an input of a process
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-playout-status
|
// @ID process-3-playout-status
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Param id path string true "Process ID"
|
// @Param id path string true "Process ID"
|
||||||
@@ -84,6 +85,7 @@ func (h *PlayoutHandler) Status(c echo.Context) error {
|
|||||||
// Keyframe returns the last keyframe
|
// Keyframe returns the last keyframe
|
||||||
// @Summary Get the last keyframe
|
// @Summary Get the last keyframe
|
||||||
// @Description Get the last keyframe of an input of a process. The extension of the name determines the return type.
|
// @Description Get the last keyframe of an input of a process. The extension of the name determines the return type.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-playout-keyframe
|
// @ID process-3-playout-keyframe
|
||||||
// @Produce image/jpeg
|
// @Produce image/jpeg
|
||||||
// @Produce image/png
|
// @Produce image/png
|
||||||
@@ -133,6 +135,7 @@ func (h *PlayoutHandler) Keyframe(c echo.Context) error {
|
|||||||
// EncodeErrorframe encodes the errorframe
|
// EncodeErrorframe encodes the errorframe
|
||||||
// @Summary Encode the errorframe
|
// @Summary Encode the errorframe
|
||||||
// @Description Immediately encode the errorframe (if available and looping)
|
// @Description Immediately encode the errorframe (if available and looping)
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-playout-errorframencode
|
// @ID process-3-playout-errorframencode
|
||||||
// @Produce text/plain
|
// @Produce text/plain
|
||||||
// @Produce json
|
// @Produce json
|
||||||
@@ -173,6 +176,7 @@ func (h *PlayoutHandler) EncodeErrorframe(c echo.Context) error {
|
|||||||
// SetErrorframe sets an errorframe
|
// SetErrorframe sets an errorframe
|
||||||
// @Summary Upload an error frame
|
// @Summary Upload an error frame
|
||||||
// @Description Upload an error frame which will be encoded immediately
|
// @Description Upload an error frame which will be encoded immediately
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-playout-errorframe
|
// @ID process-3-playout-errorframe
|
||||||
// @Produce text/plain
|
// @Produce text/plain
|
||||||
// @Produce json
|
// @Produce json
|
||||||
@@ -221,6 +225,7 @@ func (h *PlayoutHandler) SetErrorframe(c echo.Context) error {
|
|||||||
// ReopenInput closes the current input stream
|
// ReopenInput closes the current input stream
|
||||||
// @Summary Close the current input stream
|
// @Summary Close the current input stream
|
||||||
// @Description Close the current input stream such that it will be automatically re-opened
|
// @Description Close the current input stream such that it will be automatically re-opened
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-playout-reopen-input
|
// @ID process-3-playout-reopen-input
|
||||||
// @Produce plain
|
// @Produce plain
|
||||||
// @Param id path string true "Process ID"
|
// @Param id path string true "Process ID"
|
||||||
@@ -260,6 +265,7 @@ func (h *PlayoutHandler) ReopenInput(c echo.Context) error {
|
|||||||
// SetStream replaces the current stream
|
// SetStream replaces the current stream
|
||||||
// @Summary Switch to a new stream
|
// @Summary Switch to a new stream
|
||||||
// @Description Replace the current stream with the one from the given URL. The switch will only happen if the stream parameters match.
|
// @Description Replace the current stream with the one from the given URL. The switch will only happen if the stream parameters match.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-playout-stream
|
// @ID process-3-playout-stream
|
||||||
// @Produce text/plain
|
// @Produce text/plain
|
||||||
// @Produce json
|
// @Produce json
|
||||||
|
@@ -27,6 +27,7 @@ func NewRestream(restream restream.Restreamer) *RestreamHandler {
|
|||||||
// Add adds a new process
|
// Add adds a new process
|
||||||
// @Summary Add a new process
|
// @Summary Add a new process
|
||||||
// @Description Add a new FFmpeg process
|
// @Description Add a new FFmpeg process
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-add
|
// @ID process-3-add
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Produce json
|
// @Produce json
|
||||||
@@ -68,6 +69,7 @@ func (h *RestreamHandler) Add(c echo.Context) error {
|
|||||||
// GetAll returns all known processes
|
// GetAll returns all known processes
|
||||||
// @Summary List all known processes
|
// @Summary List all known processes
|
||||||
// @Description List all known processes. Use the query parameter to filter the listed processes.
|
// @Description List all known processes. Use the query parameter to filter the listed processes.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-get-all
|
// @ID process-3-get-all
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Param filter query string false "Comma separated list of fields (config, state, report, metadata) that will be part of the output. If empty, all fields will be part of the output."
|
// @Param filter query string false "Comma separated list of fields (config, state, report, metadata) that will be part of the output. If empty, all fields will be part of the output."
|
||||||
@@ -118,6 +120,7 @@ func (h *RestreamHandler) GetAll(c echo.Context) error {
|
|||||||
// Get returns the process with the given ID
|
// Get returns the process with the given ID
|
||||||
// @Summary List a process by its ID
|
// @Summary List a process by its ID
|
||||||
// @Description List a process by its ID. Use the filter parameter to specifiy the level of detail of the output.
|
// @Description List a process by its ID. Use the filter parameter to specifiy the level of detail of the output.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-get
|
// @ID process-3-get
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Param id path string true "Process ID"
|
// @Param id path string true "Process ID"
|
||||||
@@ -141,6 +144,7 @@ func (h *RestreamHandler) Get(c echo.Context) error {
|
|||||||
// Delete deletes the process with the given ID
|
// Delete deletes the process with the given ID
|
||||||
// @Summary Delete a process by its ID
|
// @Summary Delete a process by its ID
|
||||||
// @Description Delete a process by its ID
|
// @Description Delete a process by its ID
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-delete
|
// @ID process-3-delete
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Param id path string true "Process ID"
|
// @Param id path string true "Process ID"
|
||||||
@@ -164,7 +168,8 @@ func (h *RestreamHandler) Delete(c echo.Context) error {
|
|||||||
|
|
||||||
// Update replaces an existing process
|
// Update replaces an existing process
|
||||||
// @Summary Replace an existing process
|
// @Summary Replace an existing process
|
||||||
// @Description Replace an existing process. This is a shortcut for DELETE+POST.
|
// @Description Replace an existing process.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-update
|
// @ID process-3-update
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Produce json
|
// @Produce json
|
||||||
@@ -206,6 +211,7 @@ func (h *RestreamHandler) Update(c echo.Context) error {
|
|||||||
// Command issues a command to a process
|
// Command issues a command to a process
|
||||||
// @Summary Issue a command to a process
|
// @Summary Issue a command to a process
|
||||||
// @Description Issue a command to a process: start, stop, reload, restart
|
// @Description Issue a command to a process: start, stop, reload, restart
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-command
|
// @ID process-3-command
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Produce json
|
// @Produce json
|
||||||
@@ -248,6 +254,7 @@ func (h *RestreamHandler) Command(c echo.Context) error {
|
|||||||
// GetConfig returns the configuration of a process
|
// GetConfig returns the configuration of a process
|
||||||
// @Summary Get the configuration of a process
|
// @Summary Get the configuration of a process
|
||||||
// @Description Get the configuration of a process. This is the configuration as provided by Add or Update.
|
// @Description Get the configuration of a process. This is the configuration as provided by Add or Update.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-get-config
|
// @ID process-3-get-config
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Param id path string true "Process ID"
|
// @Param id path string true "Process ID"
|
||||||
@@ -272,7 +279,8 @@ func (h *RestreamHandler) GetConfig(c echo.Context) error {
|
|||||||
|
|
||||||
// GetState returns the current state of a process
|
// GetState returns the current state of a process
|
||||||
// @Summary Get the state of a process
|
// @Summary Get the state of a process
|
||||||
// @Description Get the state and progress data of a process
|
// @Description Get the state and progress data of a process.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-get-state
|
// @ID process-3-get-state
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Param id path string true "Process ID"
|
// @Param id path string true "Process ID"
|
||||||
@@ -297,7 +305,8 @@ func (h *RestreamHandler) GetState(c echo.Context) error {
|
|||||||
|
|
||||||
// GetReport return the current log and the log history of a process
|
// GetReport return the current log and the log history of a process
|
||||||
// @Summary Get the logs of a process
|
// @Summary Get the logs of a process
|
||||||
// @Description Get the logs and the log history of a process
|
// @Description Get the logs and the log history of a process.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-get-report
|
// @ID process-3-get-report
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Param id path string true "Process ID"
|
// @Param id path string true "Process ID"
|
||||||
@@ -322,7 +331,8 @@ func (h *RestreamHandler) GetReport(c echo.Context) error {
|
|||||||
|
|
||||||
// Probe probes a process
|
// Probe probes a process
|
||||||
// @Summary Probe a process
|
// @Summary Probe a process
|
||||||
// @Description Probe an existing process to get a detailed stream information on the inputs
|
// @Description Probe an existing process to get a detailed stream information on the inputs.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-probe
|
// @ID process-3-probe
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Param id path string true "Process ID"
|
// @Param id path string true "Process ID"
|
||||||
@@ -342,7 +352,8 @@ func (h *RestreamHandler) Probe(c echo.Context) error {
|
|||||||
|
|
||||||
// Skills returns the detected FFmpeg capabilities
|
// Skills returns the detected FFmpeg capabilities
|
||||||
// @Summary FFmpeg capabilities
|
// @Summary FFmpeg capabilities
|
||||||
// @Description List all detected FFmpeg capabilities
|
// @Description List all detected FFmpeg capabilities.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID skills-3
|
// @ID skills-3
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Success 200 {object} api.Skills
|
// @Success 200 {object} api.Skills
|
||||||
@@ -359,7 +370,8 @@ func (h *RestreamHandler) Skills(c echo.Context) error {
|
|||||||
|
|
||||||
// ReloadSkills will refresh the FFmpeg capabilities
|
// ReloadSkills will refresh the FFmpeg capabilities
|
||||||
// @Summary Refresh FFmpeg capabilities
|
// @Summary Refresh FFmpeg capabilities
|
||||||
// @Description Refresh the available FFmpeg capabilities
|
// @Description Refresh the available FFmpeg capabilities.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID skills-3-reload
|
// @ID skills-3-reload
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Success 200 {object} api.Skills
|
// @Success 200 {object} api.Skills
|
||||||
@@ -378,6 +390,7 @@ func (h *RestreamHandler) ReloadSkills(c echo.Context) error {
|
|||||||
// GetProcessMetadata returns the metadata stored with a process
|
// GetProcessMetadata returns the metadata stored with a process
|
||||||
// @Summary Retrieve JSON metadata stored with a process under a key
|
// @Summary Retrieve JSON metadata stored with a process under a key
|
||||||
// @Description Retrieve the previously stored JSON metadata under the given key. If the key is empty, all metadata will be returned.
|
// @Description Retrieve the previously stored JSON metadata under the given key. If the key is empty, all metadata will be returned.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-get-process-metadata
|
// @ID process-3-get-process-metadata
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Param id path string true "Process ID"
|
// @Param id path string true "Process ID"
|
||||||
@@ -402,6 +415,7 @@ func (h *RestreamHandler) GetProcessMetadata(c echo.Context) error {
|
|||||||
// SetProcessMetadata stores metadata with a process
|
// SetProcessMetadata stores metadata with a process
|
||||||
// @Summary Add JSON metadata with a process under the given key
|
// @Summary Add JSON metadata with a process under the given key
|
||||||
// @Description 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.
|
// @Description 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.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID process-3-set-process-metadata
|
// @ID process-3-set-process-metadata
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Param id path string true "Process ID"
|
// @Param id path string true "Process ID"
|
||||||
@@ -436,6 +450,7 @@ func (h *RestreamHandler) SetProcessMetadata(c echo.Context) error {
|
|||||||
// GetMetadata returns the metadata stored with the Restreamer
|
// GetMetadata returns the metadata stored with the Restreamer
|
||||||
// @Summary Retrieve JSON metadata from a key
|
// @Summary Retrieve JSON metadata from a key
|
||||||
// @Description Retrieve the previously stored JSON metadata under the given key. If the key is empty, all metadata will be returned.
|
// @Description Retrieve the previously stored JSON metadata under the given key. If the key is empty, all metadata will be returned.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID metadata-3-get
|
// @ID metadata-3-get
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Param key path string true "Key for data store"
|
// @Param key path string true "Key for data store"
|
||||||
@@ -458,6 +473,7 @@ func (h *RestreamHandler) GetMetadata(c echo.Context) error {
|
|||||||
// SetMetadata stores metadata with the Restreamer
|
// SetMetadata stores metadata with the Restreamer
|
||||||
// @Summary Add JSON metadata under the given key
|
// @Summary Add JSON metadata under the given key
|
||||||
// @Description 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.
|
// @Description 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.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID metadata-3-set
|
// @ID metadata-3-set
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Param key path string true "Key for data store"
|
// @Param key path string true "Key for data store"
|
||||||
|
@@ -23,7 +23,8 @@ func NewRTMP(rtmp rtmp.Server) *RTMPHandler {
|
|||||||
|
|
||||||
// ListChannels lists all currently publishing RTMP streams
|
// ListChannels lists all currently publishing RTMP streams
|
||||||
// @Summary List all publishing RTMP streams
|
// @Summary List all publishing RTMP streams
|
||||||
// @Description List all currently publishing RTMP streams
|
// @Description List all currently publishing RTMP streams.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID rtmp-3-list-channels
|
// @ID rtmp-3-list-channels
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Success 200 {array} api.RTMPChannel
|
// @Success 200 {array} api.RTMPChannel
|
||||||
|
@@ -25,7 +25,8 @@ func NewSession(registry session.RegistryReader) *SessionHandler {
|
|||||||
|
|
||||||
// Summary returns a summary of all active and past sessions
|
// Summary returns a summary of all active and past sessions
|
||||||
// @Summary Get a summary of all active and past sessions
|
// @Summary Get a summary of all active and past sessions
|
||||||
// @Description Get a summary of all active and past sessions of the given collector
|
// @Description Get a summary of all active and past sessions of the given collector.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID session-3-summary
|
// @ID session-3-summary
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
@@ -49,7 +50,8 @@ func (s *SessionHandler) Summary(c echo.Context) error {
|
|||||||
|
|
||||||
// Active returns a list of active sessions
|
// Active returns a list of active sessions
|
||||||
// @Summary Get a minimal summary of all active sessions
|
// @Summary Get a minimal summary of all active sessions
|
||||||
// @Description Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth)
|
// @Description Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth).
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID session-3-current
|
// @ID session-3-current
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
|
@@ -24,6 +24,7 @@ func NewSRT(srt srt.Server) *SRTHandler {
|
|||||||
// ListChannels lists all currently publishing SRT streams
|
// ListChannels lists all currently publishing SRT streams
|
||||||
// @Summary List all publishing SRT treams
|
// @Summary List all publishing SRT treams
|
||||||
// @Description List all currently publishing SRT streams. This endpoint is EXPERIMENTAL and may change in future.
|
// @Description List all currently publishing SRT streams. This endpoint is EXPERIMENTAL and may change in future.
|
||||||
|
// @Tags v16.9.0
|
||||||
// @ID srt-3-list-channels
|
// @ID srt-3-list-channels
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Success 200 {array} api.SRTChannels
|
// @Success 200 {array} api.SRTChannels
|
||||||
|
@@ -34,6 +34,7 @@ func NewWidget(config WidgetConfig) *WidgetHandler {
|
|||||||
// Get returns minimal public statistics about a process
|
// Get returns minimal public statistics about a process
|
||||||
// @Summary Fetch minimal statistics about a process
|
// @Summary Fetch minimal statistics about a process
|
||||||
// @Description Fetch minimal statistics about a process, which is not protected by any auth.
|
// @Description Fetch minimal statistics about a process, which is not protected by any auth.
|
||||||
|
// @Tags v16.7.2
|
||||||
// @ID widget-3-get
|
// @ID widget-3-get
|
||||||
// @Produce json
|
// @Produce json
|
||||||
// @Param id path string true "ID of a process"
|
// @Param id path string true "ID of a process"
|
||||||
|
Reference in New Issue
Block a user