RTMP-Server

Verwenden Sie RTMP-Server, um OBS, Encoder und Gast-Publisher an stabilen RTMP-Ingest-Endpunkten zu empfangen. Kontrollieren Sie die Veröffentlichung und den Wiedergabezugriff, und überprüfen Sie dann die Live-Bitrate und die Verbindungsdaten.

FunktionRTMP-Contribution-Stream empfangen

Geeignet, wennOBS, ein RTMP-Encoder oder ein Gast-Publisher benötigt eine stabile Push-URL, Zugriffskontrolle und Live-Verbindungsstatistiken.

Anderes Modul verwenden, wennVerwenden Sie SRT-Server für SRT-Transport und Failover oder Streams für einzelne Identitäten innerhalb eines vorhandenen Servers.

1RTMP-Publisher verbinden2Zugriff steuern3Routen oder wiedergeben

POST /api/rtmp-servers/create

Endpunkte filtern10 Endpunkte

Voraussetzungen

Alle Verwaltungsmethoden erfordern einen gültigen x-access-token. Reservieren Sie einen erreichbaren Listener-Port und legen Sie die Stream-Steuerung und Zugriffsregeln des Servers fest, bevor Sie Verbindungsdetails weitergeben.

Funktionen

create und update konfigurieren den Listen-Port, den Player-Puffer und die Stream-Zugriffsrichtlinie.
getAll, getCount und getById inspizieren Server und erlaubte Stream-Einträge.
start und stop steuern den RTMP-Listener.
getStatistics meldet Eingabe- und Ausgabebitrate, die Anzahl der Publisher und Receiver sowie verfügbare Angaben zu Clientadresse, Region und Anwendung.
getStatisticHistory gibt die verfügbare aktuelle Statistikhistorie zurück.
remove löscht den Server.

Beispiel-Workflow

Erstellen Sie den RTMP-Server mit seinem Listen-Port und Player-Puffer.
Wählen Sie einen Stream-Key- oder IP-basierten Zugriff oder erlauben Sie Gastverbindungen nur, wenn der Workflow dies erfordert.
Starten Sie den Listener und geben Sie jedem Publisher die gewünschten Verbindungsdetails.
Rufen Sie getStatistics auf, um Bitrate, Rollen und den Verbindungsursprung zu überprüfen.
Verbinden Sie das Ingest mit einem Aufnahme-, Restream- oder Webplayer.

Typische Anwendungsfälle

Empfangen Sie wiederkehrende OBS- oder Encoder-Contribution-Streams an einem stabilen Endpunkt.
Erlauben Sie zugelassenen Gast-Publishern und -Receivern, im Rahmen der gewählten Zugriffsrichtlinie eigene Stream-Keys zu erstellen.
Überwachen Sie Kunden- oder Veranstaltungsortverbindungen nach Bitrate, Rolle, Adresse und Region.
Stellen Sie einen RTMP-Contribution-Feed als HLS- oder DASH-Browser-Wiedergabe bereit.

Einschränkungen und Fehlerbehebung

Der Port muss frei und erreichbar sein. Zugangsregeln, Stream-Schlüssel und Publisher- oder Receiver-Rollen müssen mit der Verbindung übereinstimmen. Aktuelle Statistiken sind Betriebsdaten und kein dauerhafter Analysespeicher; exportieren Sie sie, wenn eine längere Aufbewahrung oder Warnung erforderlich ist.

Nächste Schritte

Prüfen Sie einen Publisher mit getStatistics und verbinden Sie den Server anschließend mit Restreams, Aufzeichnungen oder Webplayern.

REST-Lösungsrezept

RTMP-Publisher annehmen und Live-Bitrate prüfen

Stellen Sie einen RTMP-Einstiegspunkt mit der benötigten Zugriffsrichtlinie bereit, starten Sie ihn und lesen Sie aktuelle sowie letzte Prozessstatistiken derselben Ressource.

RTMP-Ingest erstellenWählen Sie Listen-Port, Puffer und offenen, Stream-ID- oder IP-Zugriff.POST /api/rtmp-servers/create
Server startenAktivieren Sie den Einstiegspunkt vor der Verbindung von OBS, Encoder oder Publisher.POST /api/rtmp-servers/start
Live-Statistik lesenPrüfen Sie aktuelle Bitrate und Verbindungsdaten; verwenden Sie die Historie für letzte Samples.POST /api/rtmp-servers/getStatistics

Eine erfolgreiche Create-Antwort bestätigt die Konfiguration, nicht den Medienzustand. Starten Sie die Ressource und prüfen Sie ihre Laufzeitstatistik, bevor Sie Produktionsverkehr senden.

Produktseite des RTMP-Servers öffnen

REST-Lösungsrezept

Gastzugriff für RTMP-Publishing und -Empfang ausgeben

Erstellen Sie einen temporär offenen Server für frei gewählte Gast-Stream-Keys oder explizite Publisher-/Receiver-Datensätze für kontrollierte Keys bzw. feste Hosts und prüfen Sie Verbindungen in der Live-Statistik.

Offenen oder kontrollierten Ingest erstellenWählen Sie Allow-all-, Stream-Key- oder IP-Steuerung und fügen Sie bei benötigten access_settings Publisher- und Receiver-Rollen hinzu.POST /api/rtmp-servers/create
Befüllte Zugriffsliste lesenVerwenden Sie getById, da die Create-Antwort verknüpfte Zugriffsdaten möglicherweise nicht befüllt.POST /api/rtmp-servers/getById
Publisher und Receiver prüfenBestätigen Sie aktuelle Bitrate, Rollenzahlen, Client-Adressen und geografische Anreicherung für die erwarteten Gäste.POST /api/rtmp-servers/getStatistics

CONTROL_ACCESS_ALLOW_ALL lässt Gäste mit einem gewählten Stream-Key verbinden; es ist keine Authentifizierung. Bevorzugen Sie in Produktion CONTROL_ACCESS_STREAM_ID oder CONTROL_ACCESS_IP_ADDRESS mit rollenspezifischen access_settings und beenden Sie temporären Gastzugriff nach dem Event.

Produktseite des RTMP-Servers öffnen Live-Operator-Demo öffnen

POST

/api/rtmp-servers/create

API-Token erforderlich

Erstellen Sie einen RTMP-Ingest-Server mit Listener-Port, Player-Puffer, Aktivstatus und optionalen Zugriffsregeln für Stream-Keys oder IP-Adressen. Senden Sie das API-Token im x-access-token-Header.

server_buflen wird in Sekunden gemessen. Der Standard ist 5, und akzeptierte Werte sind 1 bis 120.

Wenn Sie stream_control_type und access_settings mitsenden, erstellt Callaba die Zugriffsregeln zusammen mit dem Server. Die Erstellungsantwort kann trotzdem access: [] enthalten; rufen Sie getById auf, um die ausgefüllte Zugriffsliste zu lesen.

Anfragebeispiele

Wählen Sie eine Voreinstellung für offenen Ingest, explizite Stream-Keys oder feste IP-Adressen. Für eine operatorgesteuerte Bereitstellung steht außerdem ein Beispiel unter vMix Script bereit.

Typische Anwendungsfälle

Stellen Sie OBS oder einem anderen Software-Encoder einen stabilen RTMP-Contribution-Endpunkt bereit.
Beschränken Sie den Zugriff von Partnern oder Studios mit Stream-Keys oder einer IP-Allowlist.
Erstellen Sie einen Ingest-Endpunkt, der die nachgelagerte Browser-Wiedergabe über HLS oder DASH ermöglicht.

Nur spezifizierte Stream-Keys zulassen

Verwenden Sie dieses Muster, wenn Publisher und Receiver sich mit expliziten RTMP-Stream-Keys anstelle von offenem Ingest authentifizieren sollen. Es spiegelt die Dashboard-Voreinstellung wider, mit je einem Publisher- und Receiver-Key.

Nur spezifizierte Stream-Keys zulassen

curl --request POST \
  --url http://localhost/api/rtmp-servers/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "server_name": "Live Protected",
  "server_type": "SERVER_TYPE_RTMP",
  "server_port": 1945,
  "server_buflen": 5,
  "server_active": true,
  "stream_control_type": "CONTROL_ACCESS_STREAM_ID",
  "access_settings": [
    {
      "stream_id": "rtmp-stream-01",
      "role_name": "publisher"
    },
    {
      "stream_id": "rtmp-stream-01",
      "role_name": "receiver"
    }
  ]
}'

Nur angegebene IP-Adressen zulassen

Verwenden Sie dieses Muster, wenn die RTMP-Peers als feste Hosts bekannt sind. Die Dashboard-Voreinstellung erstellt Publisher- und Receiver-Regeln, die anhand des Hosts statt der Stream-ID greifen.

Nur angegebene IP-Adressen zulassen

curl --request POST \
  --url http://localhost/api/rtmp-servers/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "server_name": "Live Allowlisted",
  "server_type": "SERVER_TYPE_RTMP",
  "server_port": 1945,
  "server_buflen": 5,
  "server_active": true,
  "stream_control_type": "CONTROL_ACCESS_IP_ADDRESS",
  "access_settings": [
    {
      "host": "127.0.0.1",
      "role_name": "publisher"
    },
    {
      "host": "127.0.0.1",
      "role_name": "receiver"
    }
  ]
}'

Parameter im Request-Body

Grundeinstellungen

server_name

string

Dashboard-Bezeichnung: Name.

Das Formular ist standardmäßig Live.

server_type

string

Der aktuell validierte API-Vertrag akzeptiert SERVER_TYPE_RTMP.

server_active

boolean

Dashboard-Bezeichnung: Einmal erstellt aktivieren.

„Aktiviert“ beschreibt den Serverzustand. Durch Ausschalten werden alle Publisher und Receiver, die mit dem RTMP-Server verbunden sind, getrennt.

Laufzeiteinstellungen

server_port

integer

Dashboard-Bezeichnung: Port.

Das Dashboard beginnt mit 1945. Die REST API akzeptiert Ports von 1 bis 65535. Wählen Sie einen freien Port, den Publisher und Zuschauer erreichen können.

server_buflen

integer

Dashboard-Bezeichnung: Pufferlänge (s).

Dieser Wert wird in Sekunden konfiguriert. Das Dashboard beginnt mit 5; der zulässige Bereich reicht von 1 bis 120.

Diese Einstellung steuert, wie viele Mediendaten der Player vor dem Wiedergabestart puffert.

Zugriffskontrolle

stream_control_type

string

Dashboard-Bereich: Erlaubte Streams.

Steuert, ob der RTMP-Server eingehende Publisher und Receiver durch explizite Stream-Keys oder durch IP-Allowlist validiert. Der Erstellungsablauf verwendet derzeit Werte wie CONTROL_ACCESS_STREAM_ID und CONTROL_ACCESS_IP_ADDRESS.

access_settings

array

Optionaler Satz von Zugriffsregeln, die zusammen mit dem Server erstellt werden können.

Für den Stream-Key-Modus enthält jedes Element in der Regel stream_id und role_name. Für den IP-basierten Modus verwendet jedes Element host und role_name.

RTMP-Server erstellen

Antwort

Identität und Laufzeit

_id

string

Ressourcen-ID, die beim Erstellen oder Auflisten des RTMP-Servers zurückgegeben wird.

string

Kurzform für _id.

server_name

string

Name, der für den RTMP-Server gespeichert ist.

server_type

string

Die API gibt SERVER_TYPE_RTMP zurück.

server_port

string

RTMP-Listener-Port, den die API zurückgibt.

server_buflen

integer

Konfigurierte RTMP-Pufferlänge.

server_active

boolean

Ein aktuelles Status-Flag, das auf dem Serverobjekt gespeichert ist.

server_port_id

string

Portzuweisung, die dem RTMP-Listener zugeordnet ist.

server_created

string

Erstellungszeitstempel.

server_modified

string

Zeitstempel der letzten Änderung.

Zugriffskontrolle

stream_control_type

string

Zugriffssteuerungsmodus, der auf dem RTMP-Server gespeichert ist, sofern vorhanden.

access

array

Die Antwort von create gibt dies derzeit als leeres Array zurück, auch wenn access_settings übermittelt wurden. Verwenden Sie getById zum Abrufen der vollständig aufgelösten Zugriffseinträge.

Betriebsergebnis

success

boolean

Bei erfolgreicher Ausführung enthält die Antwort success: true.

Antwort: RTMP-Server erstellen

JSON

POST

/api/rtmp-servers/getCount

API-Token erforderlich

POST

/api/rtmp-servers/getAll

API-Token erforderlich

Gibt die RTMP-Serverliste für den aktuellen Benutzerkontext zurück.

Der Request-Body kann Paginierungs- und Sortierfelder enthalten, beispielsweise { server_created: 1 }.

Die Antwort ist ein einfaches Array von RTMP-Serverobjekten. Anders als getById löst die Listenmethode die zugehörigen Zugriffseinträge nicht auf.

Parameter im Request-Body

limit

integer

Optionale Seitengröße für die Listenabfrage.

skip

integer

Optionaler Offset für die paginierte Liste.

sort

object

Optionaler Sortier-Deskriptor: Das Dashboard sortiert standardmäßig nach { server_created: 1 }.

filter

object

Optionales Filterobjekt, das an die Backend-Abfrage weitergeleitet wird.

Alle RTMP-Server abrufen

Antwort

array of RTMP server objects

array

Die API gibt ein einfaches Array zurück, kein Objekt-Wrapper. Jedes Element folgt der gleichen Struktur der obersten Ebene wie die Antworten beim Erstellen, Aktualisieren, Starten und Stoppen.

Antwort: Alle RTMP-Server abrufen

JSON

POST

/api/rtmp-servers/getById

API-Token erforderlich

Lädt einen RTMP-Server anhand seiner ID.

Verwenden Sie diese Methode, wenn Sie das vollständige RTMP-Serverobjekt einschließlich der aufgelösten access-Liste benötigen.

Die Antwort von create kann trotz erstellter Zugriffsregeln access: [] anzeigen. getById gibt dagegen die zugehörigen Stream-Einträge zurück.

Parameter im Request-Body

string

Kennung des RTMP-Servers zum Laden.

RTMP-Server nach ID abrufen

Antwort

Serverobjekt

server fields

object

Die RTMP-Serverfelder der obersten Ebene entsprechen dem Format der Erstellungsantwort.

Aufgelöste Zugriffsliste

access[]

array

Im Gegensatz zur Antwort von create löst getById die zugehörigen Zugriffseinträge vollständig auf.

access[].role_name

string

Dem Zugriffseintrag zugeordnete Rolle, z. B. publisher oder receiver.

access[].stream_id

string

RTMP-Stream-Keys, wenn eine Stream-ID-basierte Zugriffskontrolle verwendet wird.

access[].host

string

Zugelassener Host, wenn eine IP-basierte Zugriffskontrolle verwendet wird.

access[].name

string

Lesbare Stream-/Zugriffsbezeichnung, die das Backend erzeugt, beispielsweise Server name: publisher.

Antwort: RTMP-Server nach ID abrufen

JSON

{
  "_id": "69c1fb2f28c95839e0e02359",
  "__v": 0,
  "access": [
    {
      "_id": "69c1fb2f28c95839e0e0235e",
      "__v": 0,
      "active": true,
      "audio_settings": {
        "streams": []
      },
      "created": "2026-03-24T02:47:11.807Z",
      "entityModel": "RTMPServerModel",
      "entity_id": "69c1fb2f28c95839e0e02359",
      "host": "",
      "module_name": "MODULE_RTMP_SERVERS",
      "name": "Docs RTMP Protected: publisher",
      "role_name": "publisher",
      "stream_id": "rtmp-stream-01",
      "user_id": "69360341db559495f643de6a",
      "id": "69c1fb2f28c95839e0e0235e",
      "success": true
    },
    {
      "_id": "69c1fb2f28c95839e0e02361",
      "__v": 0,
      "active": true,
      "audio_settings": {
        "streams": []
      },
      "created": "2026-03-24T02:47:11.807Z",
      "entityModel": "RTMPServerModel",
      "entity_id": "69c1fb2f28c95839e0e02359",
      "host": "",
      "module_name": "MODULE_RTMP_SERVERS",
      "name": "Docs RTMP Protected: receiver",
      "role_name": "receiver",
      "stream_id": "rtmp-stream-01",
      "user_id": "69360341db559495f643de6a",
      "id": "69c1fb2f28c95839e0e02361",
      "success": true
    }
  ],
  "server_active": true,
  "server_buflen": 5,
  "server_created": "2026-03-24T02:47:11.801Z",
  "server_name": "Docs RTMP Protected",
  "server_port": "1946",
  "server_type": "SERVER_TYPE_RTMP",
  "server_user_id": "69360341db559495f643de6a",
  "stream_control_type": "CONTROL_ACCESS_STREAM_ID",
  "server_modified": "2026-03-24T02:47:11.804Z",
  "server_port_id": "69c1fb2f28c95839e0e0235b",
  "id": "69c1fb2f28c95839e0e02359",
  "success": true
}

{
  "_id": "69c1fb2f28c95839e0e02359",
  "__v": 0,
  "access": [
    {
      "_id": "69c1fb2f28c95839e0e0235e",
      "__v": 0,
      "active": true,
      "audio_settings": {
        "streams": []
      },
      "created": "2026-03-24T02:47:11.807Z",
      "entityModel": "RTMPServerModel",
      "entity_id": "69c1fb2f28c95839e0e02359",
      "host": "",
      "module_name": "MODULE_RTMP_SERVERS",
      "name": "Docs RTMP Protected: publisher",
      "role_name": "publisher",
      "stream_id": "rtmp-stream-01",
      "user_id": "69360341db559495f643de6a",
      "id": "69c1fb2f28c95839e0e0235e",
      "success": true
    },
    {
      "_id": "69c1fb2f28c95839e0e02361",
      "__v": 0,
      "active": true,
      "audio_settings": {
        "streams": []
      },
      "created": "2026-03-24T02:47:11.807Z",
      "entityModel": "RTMPServerModel",
      "entity_id": "69c1fb2f28c95839e0e02359",
      "host": "",
      "module_name": "MODULE_RTMP_SERVERS",
      "name": "Docs RTMP Protected: receiver",
      "role_name": "receiver",
      "stream_id": "rtmp-stream-01",
      "user_id": "69360341db559495f643de6a",
      "id": "69c1fb2f28c95839e0e02361",
      "success": true
    }
  ],
  "server_active": true,
  "server_buflen": 5,
  "server_created": "2026-03-24T02:47:11.801Z",
  "server_name": "Docs RTMP Protected",
  "server_port": "1946",
  "server_type": "SERVER_TYPE_RTMP",
  "server_user_id": "69360341db559495f643de6a",
  "stream_control_type": "CONTROL_ACCESS_STREAM_ID",
  "server_modified": "2026-03-24T02:47:11.804Z",
  "server_port_id": "69c1fb2f28c95839e0e0235b",
  "id": "69c1fb2f28c95839e0e02359",
  "success": true
}

POST

/api/rtmp-servers/getStatistics

API-Token erforderlich

Lesen Sie die aggregierte und serverspezifische Bitrate, aktive Streams, die Anzahl der Publisher und Receiver sowie – sofern verfügbar – Client-IP und geografische Angaben.

Lassen Sie id weg, um alle RTMP-Server des Token-Kontexts einzubeziehen, oder übergeben Sie eine Server-ID für ein gezieltes Ergebnis. Jeder Aufruf fügt außerdem eine kurzlebige Momentaufnahme für getStatisticHistory hinzu.

Wenn Statistiken nicht verfügbar sind, kann der Endpunkt success: false mit Null-Servereinträgen und einem Fehlerfeld zurückgeben.

Typische Anwendungsfälle

Bestätigen Sie, dass ein erwarteter Publisher verbunden ist und Bitrate sendet.
Vergleichen Sie während einer Live-Veranstaltung die Anzahl der Publisher und Receiver.
Bereichern Sie eine Betriebsansicht mit Client-IP, Stadt und Land, wenn diese Felder verfügbar sind.

Parameter im Request-Body

Optionaler Anwendungsbereich

string

Optionale RTMP-Server-ID. Lassen Sie das Feld weg, um Live-Statistiken für alle RTMP-Server des authentifizierten Benutzers abzurufen.

RTMP-Serverstatistiken abrufen

Antwort

Aggregat

success

boolean

Zeigt an, ob der Laufzeitstatistikdienst einen gültigen Snapshot zurückgegeben hat.

input_bitrate_kbps

number

Aggregierte eingehende RTMP-Bitrate in kbit/s.

output_bitrate_kbps

number

Aggregierte ausgehende RTMP-Bitrate in kbit/s.

Servereinträge

servers[]

array

Bitrate pro Server, Publisher, Receiver, Stream-Count und Stream-Detaildaten.

Stream-Einträge

streams[]

array

Abgeflachte Stream-Snapshots mit Dauer, Byte-Zählern, Bitrate, Codec und Client-Rollen-Arrays.

Client-Verbindungen

publishers[] / receivers[] / clients[]

array

Verbindungsdatensätze umfassen Rolle, Client-ID, IP / Adresse, Stadt, Land, Standort, Seiten-URL, Client-Software, Timing, fallengelassene Frames und A / V-Synchronisierung, sofern diese Laufzeitdaten verfügbar sind.

Antwort: RTMP-Serverstatistiken abrufen

JSON

{
  "success": true,
  "nginx_version": "1.25.x",
  "nginx_rtmp_version": "1.2.x",
  "uptime": 86400,
  "input_bitrate_kbps": 2380,
  "output_bitrate_kbps": 4760,
  "servers": [
    {
      "entity_id": "69c1fb0128c95839e0e022d5",
      "server_id": "69c1fb0128c95839e0e022d5",
      "server_name": "Docs RTMP Server",
      "server_port": "1945",
      "app_name": "docs-rtmp-server",
      "input_bitrate_kbps": 2380,
      "output_bitrate_kbps": 4760,
      "publishers_count": 1,
      "receivers_count": 2,
      "streams_count": 1,
      "streams": [
        {
          "entity_id": "69c1fb0128c95839e0e022d5",
          "server_id": "69c1fb0128c95839e0e022d5",
          "server_name": "Docs RTMP Server",
          "server_port": "1945",
          "app_name": "docs-rtmp-server",
          "stream_id": "main-stage",
          "duration_ms": 42000,
          "bytes_in": 12400000,
          "bytes_out": 24800000,
          "input_bitrate_kbps": 2380,
          "output_bitrate_kbps": 4760,
          "bitrate_kbps": 7140,
          "codec": "H264",
          "publishers_count": 1,
          "receivers_count": 2,
          "publishers": [
            {
              "id": "rtmp-client-17",
              "client_id": "rtmp-client-17",
              "role_name": "publisher",
              "address": "198.51.100.24",
              "ip": "198.51.100.24",
              "country": "DE",
              "city": "Frankfurt am Main",
              "location": "Frankfurt am Main, DE",
              "pageurl": "",
              "flashver": "FMLE/3.0",
              "time": 42000,
              "dropped": 0,
              "avsync": 0,
              "internal": false
            }
          ],
          "receivers": [
            {
              "id": "rtmp-client-18",
              "client_id": "rtmp-client-18",
              "role_name": "receiver",
              "address": "203.0.113.31",
              "ip": "203.0.113.31",
              "country": "GB",
              "city": "London",
              "location": "London, GB",
              "pageurl": "",
              "flashver": "FMLE/3.0",
              "time": 42000,
              "dropped": 0,
              "avsync": 0,
              "internal": false
            }
          ]
        }
      ]
    }
  ],
  "streams": [
    {
      "entity_id": "69c1fb0128c95839e0e022d5",
      "server_id": "69c1fb0128c95839e0e022d5",
      "server_name": "Docs RTMP Server",
      "server_port": "1945",
      "app_name": "docs-rtmp-server",
      "stream_id": "main-stage",
      "duration_ms": 42000,
      "bytes_in": 12400000,
      "bytes_out": 24800000,
      "input_bitrate_kbps": 2380,
      "output_bitrate_kbps": 4760,
      "bitrate_kbps": 7140,
      "codec": "H264",
      "publishers_count": 1,
      "receivers_count": 2,
      "publishers": [
        {
          "id": "rtmp-client-17",
          "client_id": "rtmp-client-17",
          "role_name": "publisher",
          "address": "198.51.100.24",
          "ip": "198.51.100.24",
          "country": "DE",
          "city": "Frankfurt am Main",
          "location": "Frankfurt am Main, DE",
          "pageurl": "",
          "flashver": "FMLE/3.0",
          "time": 42000,
          "dropped": 0,
          "avsync": 0,
          "internal": false
        }
      ],
      "receivers": [
        {
          "id": "rtmp-client-18",
          "client_id": "rtmp-client-18",
          "role_name": "receiver",
          "address": "203.0.113.31",
          "ip": "203.0.113.31",
          "country": "GB",
          "city": "London",
          "location": "London, GB",
          "pageurl": "",
          "flashver": "FMLE/3.0",
          "time": 42000,
          "dropped": 0,
          "avsync": 0,
          "internal": false
        }
      ]
    }
  ]
}

{
  "success": true,
  "nginx_version": "1.25.x",
  "nginx_rtmp_version": "1.2.x",
  "uptime": 86400,
  "input_bitrate_kbps": 2380,
  "output_bitrate_kbps": 4760,
  "servers": [
    {
      "entity_id": "69c1fb0128c95839e0e022d5",
      "server_id": "69c1fb0128c95839e0e022d5",
      "server_name": "Docs RTMP Server",
      "server_port": "1945",
      "app_name": "docs-rtmp-server",
      "input_bitrate_kbps": 2380,
      "output_bitrate_kbps": 4760,
      "publishers_count": 1,
      "receivers_count": 2,
      "streams_count": 1,
      "streams": [
        {
          "entity_id": "69c1fb0128c95839e0e022d5",
          "server_id": "69c1fb0128c95839e0e022d5",
          "server_name": "Docs RTMP Server",
          "server_port": "1945",
          "app_name": "docs-rtmp-server",
          "stream_id": "main-stage",
          "duration_ms": 42000,
          "bytes_in": 12400000,
          "bytes_out": 24800000,
          "input_bitrate_kbps": 2380,
          "output_bitrate_kbps": 4760,
          "bitrate_kbps": 7140,
          "codec": "H264",
          "publishers_count": 1,
          "receivers_count": 2,
          "publishers": [
            {
              "id": "rtmp-client-17",
              "client_id": "rtmp-client-17",
              "role_name": "publisher",
              "address": "198.51.100.24",
              "ip": "198.51.100.24",
              "country": "DE",
              "city": "Frankfurt am Main",
              "location": "Frankfurt am Main, DE",
              "pageurl": "",
              "flashver": "FMLE/3.0",
              "time": 42000,
              "dropped": 0,
              "avsync": 0,
              "internal": false
            }
          ],
          "receivers": [
            {
              "id": "rtmp-client-18",
              "client_id": "rtmp-client-18",
              "role_name": "receiver",
              "address": "203.0.113.31",
              "ip": "203.0.113.31",
              "country": "GB",
              "city": "London",
              "location": "London, GB",
              "pageurl": "",
              "flashver": "FMLE/3.0",
              "time": 42000,
              "dropped": 0,
              "avsync": 0,
              "internal": false
            }
          ]
        }
      ]
    }
  ],
  "streams": [
    {
      "entity_id": "69c1fb0128c95839e0e022d5",
      "server_id": "69c1fb0128c95839e0e022d5",
      "server_name": "Docs RTMP Server",
      "server_port": "1945",
      "app_name": "docs-rtmp-server",
      "stream_id": "main-stage",
      "duration_ms": 42000,
      "bytes_in": 12400000,
      "bytes_out": 24800000,
      "input_bitrate_kbps": 2380,
      "output_bitrate_kbps": 4760,
      "bitrate_kbps": 7140,
      "codec": "H264",
      "publishers_count": 1,
      "receivers_count": 2,
      "publishers": [
        {
          "id": "rtmp-client-17",
          "client_id": "rtmp-client-17",
          "role_name": "publisher",
          "address": "198.51.100.24",
          "ip": "198.51.100.24",
          "country": "DE",
          "city": "Frankfurt am Main",
          "location": "Frankfurt am Main, DE",
          "pageurl": "",
          "flashver": "FMLE/3.0",
          "time": 42000,
          "dropped": 0,
          "avsync": 0,
          "internal": false
        }
      ],
      "receivers": [
        {
          "id": "rtmp-client-18",
          "client_id": "rtmp-client-18",
          "role_name": "receiver",
          "address": "203.0.113.31",
          "ip": "203.0.113.31",
          "country": "GB",
          "city": "London",
          "location": "London, GB",
          "pageurl": "",
          "flashver": "FMLE/3.0",
          "time": 42000,
          "dropped": 0,
          "avsync": 0,
          "internal": false
        }
      ]
    }
  ]
}

GET

/api/rtmp-servers/:serverPort/getStatisticHistory

API-Token erforderlich

Rufen Sie aktuelle RTMP-Momentaufnahmen für einen Server-Port des authentifizierten Benutzers ab. Die Antwort ist nach Stream-ID gruppiert.

getStatistics füllt diese kurzlebige Historie; ein Neustart der Engine löscht sie. Exportieren Sie Messwerte in Ihr Monitoring-System, wenn Sie eine längere Aufbewahrung benötigen.

Abfrageparameter

Routenparameter

serverPort

string

Listener-Port eines RTMP-Servers, der dem authentifizierten Benutzer gehört.

RTMP-Statistikverlauf abrufen

Antwort

Objekt der obersten Ebene

stream_id

object key

Jeder Schlüssel der obersten Ebene identifiziert einen Stream, der auf dem ausgewählten RTMP-Port beobachtet wird.

Verlauf

[]

array

Flüchtiger Snapshot-Verlauf, den Aufrufe von getStatistics erzeugen. Die Daten sind nicht dauerhaft und werden beim Neustart des Engine-Prozesses zurückgesetzt.

Antwort: RTMP-Statistikverlauf abrufen

JSON

{
  "main-stage": [
    {
      "entity_id": "69c1fb0128c95839e0e022d5",
      "server_id": "69c1fb0128c95839e0e022d5",
      "server_name": "Docs RTMP Server",
      "server_port": "1945",
      "app_name": "docs-rtmp-server",
      "stream_id": "main-stage",
      "duration_ms": 42000,
      "bytes_in": 12400000,
      "bytes_out": 24800000,
      "input_bitrate_kbps": 2380,
      "output_bitrate_kbps": 4760,
      "bitrate_kbps": 7140,
      "codec": "H264",
      "publishers_count": 1,
      "receivers_count": 2,
      "publishers": [
        {
          "id": "rtmp-client-17",
          "client_id": "rtmp-client-17",
          "role_name": "publisher",
          "address": "198.51.100.24",
          "ip": "198.51.100.24",
          "country": "DE",
          "city": "Frankfurt am Main",
          "location": "Frankfurt am Main, DE",
          "pageurl": "",
          "flashver": "FMLE/3.0",
          "time": 42000,
          "dropped": 0,
          "avsync": 0,
          "internal": false
        }
      ],
      "receivers": [
        {
          "id": "rtmp-client-18",
          "client_id": "rtmp-client-18",
          "role_name": "receiver",
          "address": "203.0.113.31",
          "ip": "203.0.113.31",
          "country": "GB",
          "city": "London",
          "location": "London, GB",
          "pageurl": "",
          "flashver": "FMLE/3.0",
          "time": 42000,
          "dropped": 0,
          "avsync": 0,
          "internal": false
        }
      ],
      "sequence": 1774330100000
    }
  ]
}

{
  "main-stage": [
    {
      "entity_id": "69c1fb0128c95839e0e022d5",
      "server_id": "69c1fb0128c95839e0e022d5",
      "server_name": "Docs RTMP Server",
      "server_port": "1945",
      "app_name": "docs-rtmp-server",
      "stream_id": "main-stage",
      "duration_ms": 42000,
      "bytes_in": 12400000,
      "bytes_out": 24800000,
      "input_bitrate_kbps": 2380,
      "output_bitrate_kbps": 4760,
      "bitrate_kbps": 7140,
      "codec": "H264",
      "publishers_count": 1,
      "receivers_count": 2,
      "publishers": [
        {
          "id": "rtmp-client-17",
          "client_id": "rtmp-client-17",
          "role_name": "publisher",
          "address": "198.51.100.24",
          "ip": "198.51.100.24",
          "country": "DE",
          "city": "Frankfurt am Main",
          "location": "Frankfurt am Main, DE",
          "pageurl": "",
          "flashver": "FMLE/3.0",
          "time": 42000,
          "dropped": 0,
          "avsync": 0,
          "internal": false
        }
      ],
      "receivers": [
        {
          "id": "rtmp-client-18",
          "client_id": "rtmp-client-18",
          "role_name": "receiver",
          "address": "203.0.113.31",
          "ip": "203.0.113.31",
          "country": "GB",
          "city": "London",
          "location": "London, GB",
          "pageurl": "",
          "flashver": "FMLE/3.0",
          "time": 42000,
          "dropped": 0,
          "avsync": 0,
          "internal": false
        }
      ],
      "sequence": 1774330100000
    }
  ]
}

POST

/api/rtmp-servers/update

API-Token erforderlich

Aktualisiert einen vorhandenen RTMP-Server.

Der Request-Body entspricht create und enthält zusätzlich die id des Servers.

Ändern Sie damit Listener-Port, Player-Puffer, Aktivstatus oder Zugriffsregeln, ohne den Ingest-Endpunkt zu löschen und neu zu erstellen.

Parameter im Request-Body

string

Kennung des RTMP-Servers, der aktualisiert wird.

server_name / server_port / server_buflen / server_active

mixed

Der Request-Body entspricht create. Der Dienst verwendet den gleichen Validierungspfad wieder und regeneriert die RTMP-Konfiguration nach dem Speichern des Dokuments.

RTMP-Server aktualisieren

Antwort

updated RTMP server object

object

Die API gibt das aktualisierte Serverobjekt auf der obersten Ebene zusammen mit success: true zurück.

Antwort: RTMP-Server aktualisieren

JSON

POST

/api/rtmp-servers/start

API-Token erforderlich

Startet einen RTMP-Server per ID.

Ein erfolgreicher Aufruf setzt server_active auf true, bringt den gespeicherten Ingest-Server online und gibt das aktualisierte Serverobjekt zurück.

Verwenden Sie diese Methode, um den RTMP-Ingest-Endpunkt wieder online zu bringen, ohne die übrige gespeicherte Konfiguration zu ändern.

Für die Ausführung aus einem Operator-Workflow enthält das folgende Beispiel zusätzlich einen Tab vMix Script.

Parameter im Request-Body

string

Kennung des RTMP-Servers zum Starten.

RTMP-Server starten

Antwort

started RTMP server object

object

Das Backend setzt server_active auf true, regeneriert die RTMP-Konfiguration und gibt das Serverobjekt zurück.

Antwort: RTMP-Server starten

JSON

POST

/api/rtmp-servers/stop

API-Token erforderlich

Stoppt einen RTMP-Server per ID.

Ein erfolgreicher Aufruf setzt server_active auf false, nimmt den Ingest-Server offline und gibt das aktualisierte Serverobjekt zurück.

Verwenden Sie diese Methode, wenn der Ingest-Endpunkt offline gehen, seine Konfiguration aber für einen späteren start erhalten bleiben soll.

Für die Ausführung aus einem Operator-Workflow enthält das folgende Beispiel zusätzlich einen Tab vMix Script.

Parameter im Request-Body

string

Kennung des RTMP-Servers zum Stoppen.

RTMP-Server stoppen

Antwort

stopped RTMP server object

object

Das Backend setzt server_active auf false, entfernt die generierte RTMP-Konfiguration und gibt das Serverobjekt zurück.

Antwort: RTMP-Server stoppen

JSON

DELETE

/api/rtmp-servers/remove

API-Token erforderlich

Zurück zuAutorisierung Weiter zuSRT-Routen