Streams

Verwenden Sie Streams, um benannte Publisher- und Empfängerverbindungen für SRT- oder RTMP-Endpunkte zu erstellen. Jeder Datensatz gibt Anwendungen eine stabile Verbindungsidentität und wiederverwendbare Medieneinstellungen.

FunktionBenannte Medienverbindung erstellen

Geeignet, wennJeder Publisher oder Receiver benötigt eine eigene Identität auf einem vorhandenen SRT- oder RTMP-Server.

Anderes Modul verwenden, wennVerwenden Sie SRT-Server oder RTMP-Server, um den eigentlichen Ingest-Endpunkt zu erstellen.

1Publisher oder Receiver wählen2Endpunkt festlegen3Verbindung verwenden

POST /api/streams/create

Endpunkte filtern10 Endpunkte

Voraussetzungen

Alle Methoden erfordern einen gültigen x-access-token. Erstellen Sie zuerst den zugehörigen SRT- oder RTMP-Server und verwenden Sie konsistente Server- und Stream-Kennungen.

Funktionen

create, update, getAll, getCount und getById verwalten Verbindungseinträge.
start und stop steuern unterstützte Stream-Lifecycle-Aktionen.
getStreamInfo liest Verbindungsinformationen.
setStreamInfo wendet unterstützte Stream-Informationen an.
remove löscht einen Stream-Eintrag.

Beispiel-Workflow

Erstellen Sie einen Publisher-Eintrag für den vorgesehenen SRT- oder RTMP-Server.
Weisen Sie seine Rolle, stream_id, Hostdetails und erforderliche Audioeinstellungen zu.
Geben Sie die generierten Verbindungsdetails an den Publisher weiter.
Verwenden Sie getStreamInfo während der Einrichtung und Fehlerbehebung.

Typische Anwendungsfälle

Stellen Sie jedem Remote-Kamerateam eine eigene Verbindung bereit.
Trennen Sie Publisher- und Receiver-Identitäten auf einem gemeinsam genutzten Ingest-Server.
Speichern Sie Audiokanaleinstellungen für wiederholbare Contribution-Feeds.

Einschränkungen und Fehlerbehebung

Doppelte oder nicht übereinstimmende Stream-Kennungen können die erwartete Verbindung verhindern. Ein Stream-Eintrag hängt von seinem übergeordneten Server ab und kann einen nicht erreichbaren Publisher nicht verfügbar machen. Geben Sie Zugangsdaten oder uneingeschränkte Verbindungsdetails nur an die vorgesehenen Teilnehmer weiter.

Nächste Schritte

Verbinden Sie den Publisher oder Receiver und prüfen Sie anschließend die Laufzeitstatistiken des übergeordneten SRT- oder RTMP-Servers.

REST-Lösungsrezept

Eine wiederverwendbare Stream-Quelle registrieren und betreiben

Erstellen Sie Identität und Verbindung einmal, starten Sie die Quelle bei Bedarf und lesen Sie ihre Informationen für die Downstream-Automatisierung.

Stream erstellenSpeichern Sie die geprüfte Quellenidentität und Verbindung.POST /api/streams/create
Quelle startenStarten Sie sie vor dem Anbinden nachgelagerter Module.POST /api/streams/start
Stream-Informationen lesenVerwenden Sie aktuelle Stream-Metadaten im Steuerungs-Workflow.POST /api/streams/getStreamInfo

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.

POST

/api/streams/create

API-Token erforderlich

Erstellen Sie eine verwaltete Stream-Identität für eine SRT- oder RTMP-Transportressource. Der Eintrag speichert Name, Publisher- oder Receiver-Rolle, Stream-ID, optionalen Host, verknüpfte Ressource und optionale Audio-Metadaten.

Für die Bereitstellung aus einem Operator-Workflow steht ein Beispiel unter vMix Script bereit.

Anfragebeispiele

Wählen Sie die Voreinstellung für einen SRT-Publisher, einen SRT-Receiver, einen RTMP-Publisher oder einen Stream mit gespeichertem Audiolayout.

Typische Anwendungsfälle

Benennen Sie mehrere Publisher-Streams, die sich einen SRT-Listener teilen.
Verwenden Sie eine stabile Receiver-Identität für gerouteten oder abgerufenen Datenverkehr.
Speichern Sie Kanalnamen, Layouts oder Track-Bedeutung mit dem Stream.

SRT-Publisher-Stream

Verwenden Sie dies, wenn ein SRT-Listener einen benannten Publisher-Stream hostet, den Betreiber als eigenständige Ressource behandeln sollen.

SRT-Publisher-Stream

SRT-Receiver-Stream

Verwenden Sie dies, wenn ein Receiver- oder Return-Feed seine eigene Stream-Identität und optionale Host-Bindung beibehalten soll.

SRT-Receiver-Stream

RTMP-Publisher-Stream

Verwenden Sie dies, wenn die zugrunde liegende Transportressource ein RTMP-Server und kein SRT-Listener ist.

RTMP-Publisher-Stream

Stream mit gespeichertem Audio-Layout

Verwenden Sie dies, wenn Kanallayout und Kanalnamen nach der Analyse im Stream-Eintrag gespeichert werden sollen.

Stream mit gespeichertem Audio-Layout

curl --request POST \
  --url http://localhost/api/streams/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Commentary audio stream",
  "role_name": "publisher",
  "stream_id": "publisher/commentary/audio-main",
  "entity_id": "680400000000000000000001",
  "module_name": "MODULE_SRT_SERVERS",
  "audio_settings": {
    "streams": [
      {
        "id": 0,
        "name": "Commentary",
        "channel_layout": "mono",
        "channels": [
          {
            "id": "FC",
            "name": "Commentary"
          }
        ]
      }
    ]
  },
  "active": true
}'

Parameter im Request-Body

Identität

name

string

Dashboard-Bezeichnung: Name.

Lesbarer Name des gespeicherten Stream-Eintrags.

role_name

string

Dashboard-Bezeichnung: Role.

Typische Produktwerte sind publisher, receiver, pusher und puller.

stream_id

string

Stabile Stream-Kennung, die über der unterstützenden Transporteinheit gespeichert ist.

host

string

Optionale Hostbindung, die verwendet wird, wenn die Stream-Identität an einen konkreten Remote-Peer gebunden bleiben soll.

Zugeordnete Ressource

entity_id

string

Kennung der zugrunde liegenden Transportressource, beispielsweise ein SRT-Server oder RTMP-Server.

module_name

string

In der Praxis ist dies meist MODULE_SRT_SERVERS oder MODULE_RTMP_SERVERS.

Metadaten

audio_settings

object

Optional gespeichertes Audiolayout mit benannten Tracks und Kanälen.

Laufzeit

active

boolean

Dashboard-Bezeichnung: Einmal erstellt aktivieren.

Steuert, ob der Stream-Eintrag direkt nach der Bereitstellung aktiv sein soll.

Stream erstellen

Antwort

Identität

_id / id / name / role_name / stream_id / host

mixed

Bezeichner und die gespeicherten Stream-Identitätsfelder.

Zugeordnete Ressource

entity_id / entityModel / module_name

mixed

Verweis auf das Transportobjekt, das den Stream bereitstellt.

Metadaten

stream_meta_data / audio_settings

mixed

Gespeichertes Analyseergebnis, Codec-Notizen und optionale Kanal-Mapping-Metadaten.

Laufzeit

active / created / modified

mixed

Laufzeit-Flag und Backend-verwaltete Zeitstempel.

Betriebsergebnis

success

boolean

Erfolgreiche Antworten auf Stream-Modelle zeigen success: true als virtuelles Feld.

Antwort: Stream erstellen

JSON

{
  "_id": "680600000000000000000001",
  "id": "680600000000000000000001",
  "name": "Main stage publisher",
  "role_name": "publisher",
  "host": "",
  "stream_id": "publisher/main-stage/srt-main",
  "entity_id": "680400000000000000000001",
  "entityModel": "ServerModel",
  "module_name": "MODULE_SRT_SERVERS",
  "stream_meta_data": {
    "codec_name": "h264",
    "fps": "30/1"
  },
  "audio_settings": {
    "streams": [
      {
        "id": 0,
        "name": "Track-0",
        "channel_layout": "stereo",
        "channels": [
          {
            "id": "FL",
            "name": "Left"
          },
          {
            "id": "FR",
            "name": "Right"
          }
        ]
      }
    ]
  },
  "created": "2026-03-24T08:45:00.000Z",
  "modified": "2026-03-24T08:45:00.000Z",
  "active": true,
  "success": true
}

POST

/api/streams/getCount

API-Token erforderlich

POST

/api/streams/getAll

API-Token erforderlich

Gibt die für das authentifizierte Konto sichtbaren Stream-Ressourcen zurück.

Verwenden Sie die Methode für eine Übersicht aktiver Stream-Identitäten in SRT- und RTMP-Workflows, insbesondere wenn Publisher- und Receiver-Rollen im Betrieb schnell erkennbar sein sollen.

Parameter im Request-Body

limit

integer

Optionale Seitengröße für die Auflistungsabfrage.

skip

integer

Optionaler Offset für die paginierte Liste.

sort

object

Das Dashboard sortiert standardmäßig nach { created: 1 }.

filter

object

Optionales Filterobjekt, das für die Suche und Rollen-/Modulfilterung verwendet wird.

Alle Streams abrufen

Antwort

array of stream objects

array

Das Backend gibt ein einfaches Array von Stream-Einträgen zurück, kein Objekt-Wrapper.

Antwort: Alle Streams abrufen

JSON

[
  {
    "_id": "680600000000000000000001",
    "id": "680600000000000000000001",
    "name": "Main stage publisher",
    "role_name": "publisher",
    "host": "",
    "stream_id": "publisher/main-stage/srt-main",
    "entity_id": "680400000000000000000001",
    "entityModel": "ServerModel",
    "module_name": "MODULE_SRT_SERVERS",
    "stream_meta_data": {
      "codec_name": "h264",
      "fps": "30/1"
    },
    "audio_settings": {
      "streams": [
        {
          "id": 0,
          "name": "Track-0",
          "channel_layout": "stereo",
          "channels": [
            {
              "id": "FL",
              "name": "Left"
            },
            {
              "id": "FR",
              "name": "Right"
            }
          ]
        }
      ]
    },
    "created": "2026-03-24T08:45:00.000Z",
    "modified": "2026-03-24T08:45:00.000Z",
    "active": true,
    "success": true
  }
]

POST

/api/streams/getById

API-Token erforderlich

Lädt eine gespeicherte Stream-Ressource anhand ihrer ID.

Verwenden Sie die Methode vor einer Bearbeitung, wenn Sie die aktuelle Stream-Identität, die verknüpfte Transportressource oder die gespeicherten Audioeinstellungen benötigen.

Parameter im Request-Body

string

Kennung des Stream-Eintrags, die Sie laden möchten.

Stream nach ID abrufen

Antwort

stream object

object

Das Backend gibt den gespeicherten Stream-Eintrag mit seiner Transportverbindung und optionalen Metadaten zurück.

Antwort: Stream nach ID abrufen

JSON

{
  "_id": "680600000000000000000001",
  "id": "680600000000000000000001",
  "name": "Main stage publisher",
  "role_name": "publisher",
  "host": "",
  "stream_id": "publisher/main-stage/srt-main",
  "entity_id": "680400000000000000000001",
  "entityModel": "ServerModel",
  "module_name": "MODULE_SRT_SERVERS",
  "stream_meta_data": {
    "codec_name": "h264",
    "fps": "30/1"
  },
  "audio_settings": {
    "streams": [
      {
        "id": 0,
        "name": "Track-0",
        "channel_layout": "stereo",
        "channels": [
          {
            "id": "FL",
            "name": "Left"
          },
          {
            "id": "FR",
            "name": "Right"
          }
        ]
      }
    ]
  },
  "created": "2026-03-24T08:45:00.000Z",
  "modified": "2026-03-24T08:45:00.000Z",
  "active": true,
  "success": true
}

POST

/api/streams/update

API-Token erforderlich

Aktualisiert eine gespeicherte Stream-Ressource.

Benennen Sie damit einen Stream um, ändern Sie rollenbezogene Metadaten, ergänzen oder überarbeiten Sie Audioeinstellungen oder korrigieren Sie Stream-ID und Host-Zuordnung nach einer Live-Analyse.

Parameter im Request-Body

string

Bezeichner des zu aktualisierenden Stream-Eintrags.

name / role_name / stream_id / host

mixed

Aktualisierte Stream-Identitätsfelder.

audio_settings

object

Optionales Ersatz-Audiolayout oder gespeicherte Kanalbenennungsdaten.

active

boolean

Aktueller Laufzeitstatus nach der Aktualisierung.

Stream aktualisieren

curl --request POST \
  --url http://localhost/api/streams/update \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "680600000000000000000001",
  "name": "Main stage publisher",
  "role_name": "publisher",
  "stream_id": "publisher/main-stage/srt-main",
  "entity_id": "680400000000000000000001",
  "module_name": "MODULE_SRT_SERVERS",
  "audio_settings": {
    "streams": [
      {
        "id": 0,
        "name": "Program",
        "channel_layout": "stereo",
        "channels": [
          {
            "id": "FL",
            "name": "Left"
          },
          {
            "id": "FR",
            "name": "Right"
          }
        ]
      }
    ]
  },
  "active": true
}'

Antwort

updated stream object

object

Das Backend gibt den aktualisierten Stream-Eintrag zurück.

Antwort: Stream aktualisieren

JSON

{
  "_id": "680600000000000000000001",
  "id": "680600000000000000000001",
  "name": "Main stage publisher",
  "role_name": "publisher",
  "host": "",
  "stream_id": "publisher/main-stage/srt-main",
  "entity_id": "680400000000000000000001",
  "entityModel": "ServerModel",
  "module_name": "MODULE_SRT_SERVERS",
  "stream_meta_data": {
    "codec_name": "h264",
    "fps": "30/1"
  },
  "audio_settings": {
    "streams": [
      {
        "id": 0,
        "name": "Track-0",
        "channel_layout": "stereo",
        "channels": [
          {
            "id": "FL",
            "name": "Left"
          },
          {
            "id": "FR",
            "name": "Right"
          }
        ]
      }
    ]
  },
  "created": "2026-03-24T08:45:00.000Z",
  "modified": "2026-03-24T08:45:00.000Z",
  "active": true,
  "success": true
}

POST

/api/streams/setStreamInfo

API-Token erforderlich

DELETE

/api/streams/remove

API-Token erforderlich

POST

/api/streams/start

API-Token erforderlich

Startet den ausgewählten Stream.

Verwenden Sie die Methode, wenn eine gespeicherte Stream-Identität für einen Player oder einen nachgelagerten Workflow aktiviert werden 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

Bezeichner des zu startenden Stream-Eintrags.

Stream starten

Antwort

started stream object

object

Das Backend gibt den Stream-Eintrag zurück, nachdem die Startaktion akzeptiert wurde.

Antwort: Stream starten

JSON

{
  "_id": "680600000000000000000001",
  "id": "680600000000000000000001",
  "name": "Main stage publisher",
  "role_name": "publisher",
  "host": "",
  "stream_id": "publisher/main-stage/srt-main",
  "entity_id": "680400000000000000000001",
  "entityModel": "ServerModel",
  "module_name": "MODULE_SRT_SERVERS",
  "stream_meta_data": {
    "codec_name": "h264",
    "fps": "30/1"
  },
  "audio_settings": {
    "streams": [
      {
        "id": 0,
        "name": "Track-0",
        "channel_layout": "stereo",
        "channels": [
          {
            "id": "FL",
            "name": "Left"
          },
          {
            "id": "FR",
            "name": "Right"
          }
        ]
      }
    ]
  },
  "created": "2026-03-24T08:45:00.000Z",
  "modified": "2026-03-24T08:45:00.000Z",
  "active": true,
  "success": true
}

POST

/api/streams/stop

API-Token erforderlich

Stoppt den ausgewählten Stream.

Verwenden Sie die Methode, um den Stream offline zu nehmen, ohne seine gespeicherten Metadaten und seine Identität zu löschen.

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 zu stoppenden Stream-Eintrags.

Stream stoppen

Antwort

stopped stream object

object

Das Backend gibt den Stream-Eintrag zurück, nachdem die Stop-Aktion akzeptiert wurde.

Antwort: Stream stoppen

JSON

{
  "_id": "680600000000000000000001",
  "id": "680600000000000000000001",
  "name": "Main stage publisher",
  "role_name": "publisher",
  "host": "",
  "stream_id": "publisher/main-stage/srt-main",
  "entity_id": "680400000000000000000001",
  "entityModel": "ServerModel",
  "module_name": "MODULE_SRT_SERVERS",
  "stream_meta_data": {
    "codec_name": "h264",
    "fps": "30/1"
  },
  "audio_settings": {
    "streams": [
      {
        "id": 0,
        "name": "Track-0",
        "channel_layout": "stereo",
        "channels": [
          {
            "id": "FL",
            "name": "Left"
          },
          {
            "id": "FR",
            "name": "Right"
          }
        ]
      }
    ]
  },
  "created": "2026-03-24T08:45:00.000Z",
  "modified": "2026-03-24T08:45:00.000Z",
  "active": true,
  "success": true
}

POST

/api/streams/getStreamInfo

API-Token erforderlich

Analysiert einen Stream über seine Live-URL und gibt Codec-, Audio- und Timing-Details des tatsächlichen SRT-Upstreams zurück.

Verwenden Sie die Methode, wenn Sie das Live-Signal prüfen möchten, bevor Sie Stream-Informationen speichern oder den Stream an einen anderen Workflow weiterleiten.

Parameter im Request-Body

stream_url

string

Live-Eingabe-URL, die mit FFprobe geprüft werden soll.

Stream-Informationen abrufen

Antwort

streams[]

array

Stream-Deskriptoren im FFprobe-Stil für Video-, Audio- oder Datenspuren, die im Live-Eingang erkannt wurden.

streams[].codec_name / codec_type

mixed

Codec-Identität für jede entdeckte Spur.

streams[].width / height / avg_frame_rate

mixed

Repräsentative Videoeigenschaften, wenn die Eingabe eine Videospur enthält.

streams[].sample_rate / channels / channel_layout

mixed

Repräsentative Audioeigenschaften, wenn die Eingabe Audiospuren enthält.

format

object

FFprobe-Formatobjekt der obersten Ebene für die geprüfte URL.

Antwort: Stream-Informationen abrufen

JSON

{
  "streams": [
    {
      "index": 0,
      "codec_name": "h264",
      "codec_type": "video",
      "width": 1920,
      "height": 1080,
      "avg_frame_rate": "30/1",
      "pix_fmt": "yuv420p"
    },
    {
      "index": 1,
      "codec_name": "aac",
      "codec_type": "audio",
      "sample_rate": "48000",
      "channels": 2,
      "channel_layout": "stereo"
    }
  ],
  "format": {
    "filename": "srt://127.0.0.1:1936",
    "nb_streams": 2,
    "format_name": "mpegts",
    "start_time": "0.000000",
    "probe_score": 100
  }
}

Zurück zuRestreams Weiter zuAufzeichnungen