AV-Mixer
Die AV-Mixer-API ist die veröffentlichte Callaba-8.8-Referenz zum Erstellen gespeicherter Mixer, zum Vorbereiten von Preview, zum Starten von Program, zum Übernehmen einer Szene und zum Abrufen von Laufzeit- oder Audiozustand.
Geeignet, wennEin Callaba-8.8-AV-Mixer-Workflow ist bereits in der Oberfläche erprobt und ein Entwickler benötigt eine klar begrenzte Automatisierung für Preview, Program, Ausgaben, Aufzeichnung oder Beobachtung.
Anderes Modul verwenden, wennVerwenden Sie die Anleitung zur Remote-Produktion, wenn das Produktionsdesign noch nicht erprobt ist; öffentliche Methoden sind kein allgemeiner Administrationspfad.
/api/av-mixers/createDie passende Operation wählen
- Mit
createoderupdatespeichern Sie die Mixerkonfiguration. Keine dieser Routen startet Program. - Mit
updateStatebereiten Sie Preview vor; anschließend startetstartProgram, wenn der Mixer aktiviert ist und Preview eine konfigurierte Videoebene hat. - Mit
takeübernehmen Sie Preview mitCUToderFADEnach Program. - Mit
runtimesowie Statistik-, Meter-, Ausgabe-, Aufzeichnungs- und Diagnosemethoden bedienen oder beobachten Sie den laufenden Mixer.
Owner- und öffentlicher Zugriff
Owner-Routen verwenden x-access-token. Die meisten operativen Änderungen an Einzelsitzungs-Mixern benötigen zusätzlich x-av-mixer-session und x-av-mixer-control-epoch; die Methodenseiten nennen diese Fälle. Für Erstellen, Aktualisieren, Aktivieren, Deaktivieren, Entfernen, Starten und Stoppen gilt die dokumentierte temporäre Management-Lease-Ausnahme, solange keine Operator-Lease aktiv ist. Leiten Sie aus dieser Referenz keinen clientseitigen Ablauf zum Erwerb einer Lease ab: Die aktive API veröffentlicht /control/* nicht.
Die separat gekennzeichneten Lese-Routen unter /api/av-mixers-public verwenden keinen Owner-API-Key; sie erfordern PUBLIC-Sichtbarkeit und einen aktivierten Mixer. Öffentliche Aufrufe von take und update benötigen außerdem die passende gespeicherte öffentliche Berechtigung. Ein öffentlicher Link ist keine allgemeine Administrationsberechtigung. Die Route zum Einlösen einer Einladung verwendet stattdessen den undurchsichtigen Einladungstoken als Zugangsnachweis.
Verwandte Referenzen
Informationen zur Owner-Authentifizierung finden Sie unter Autorisierung. Nutzen Sie Videokonferenzen zum Zuweisen von Konferenzspuren und SRT-Server für Transportendpunkte. Die Antworten für Telefon- und Browsertoken sind Zugangsdaten: Verwenden Sie in Anfragen Platzhalter und veröffentlichen Sie niemals zurückgegebene Werte.
Geltungsbereich
Dieses Modul dokumentiert die AV-Mixer-Operationen der veröffentlichten API-Referenz. Routen aus dem Quellcode unter /control/* oder /studio/* sind nicht Teil dieser Dokumentation.
Nächste Schritte
Wählen Sie einen gespeicherten Mixer, prüfen Sie seine Zugriffsgrenze und beginnen Sie mit einer eng abgegrenzten Anfrage. Browser-, Konferenz- und Telefon-Publish-Zugangsdaten gehören nicht in Versionsverwaltung oder Logs.
Einen konfigurierten Mixer prüfen, bevor ein Take automatisiert wird
Lesen Sie zuerst den gespeicherten Mixer und seine Laufzeit, bereiten Sie Preview gezielt vor und führen Sie einen Take erst aus, wenn Program gestartet und die konfigurierte Control-Session verfügbar ist.
- Gespeicherten Mixer lesenPrüfen Sie den gewählten Mixer, seine Szenen, Eingänge, Ausgänge und die gespeicherte Preview-Konfiguration.
POST /api/av-mixers/getById - Aktuelle Laufzeit prüfenNutzen Sie den Laufzeitstatus, um vor einer Änderung des vorbereiteten Zustands zu sehen, ob Program bereits läuft.
POST /api/av-mixers/runtime - Preview vorbereitenAktualisieren Sie den vorgesehenen Preview-Zustand, ohne diese Vorbereitung als Program-Take zu behandeln.
POST /api/av-mixers/updateState - Vorbereitete Szene übernehmenSenden Sie den Take nur, wenn Preview eine konfigurierte Videoebene hat, Program gestartet ist und die erforderliche Control-Session vorliegt.
POST /api/av-mixers/take - Ergebnis prüfenLesen Sie die Laufzeit erneut und prüfen Sie den resultierenden Zustand im Operator-Workflow vor der nächsten automatisierten Aktion.
POST /api/av-mixers/runtime
Dies ist eine Prüf- und Vorbereitungsequenz, kein Rezept für die Live-Ausführung. Ein Take benötigt eine konfigurierte Preview-Videoebene, ein gestartetes Program und bei einem Single-Session-Mixer die passenden Control-Session-Header.
Erstellen Sie zuerst den gespeicherten Mixer. Die Erstellung speichert nur die Konfiguration; sie startet Program nicht.
Konfigurationsobjekte
| Feld | Verwendung |
|---|---|
inputs[] | Jeder Eingang benötigt name und type. Verweisen Sie auf vorhandene Eingangs- und Quellkennungen; quellspezifische Einstellungen bilden kein geschlossenes portables Schema. |
scenes[] | Jede Szene benötigt id und name. Ihre layers[] verwenden id, name, source_id, visible und opacity (eine Zahl von 0 bis 1) aus dem veröffentlichten Schema. |
outputs[] | Ausgabeobjekte verwenden id, name, type, enabled und endpunktspezifische settings. |
canvas_settings, performance_settings, audio_mixer_state | Diese Objekte bleiben über ihre veröffentlichten Eigenschaften hinaus offen. Verwenden Sie nur Eigenschaften, die vom Anfrageschema unterstützt werden; übernehmen Sie Dashboard-Vorbelegungen nicht als Serverstandardwerte. |
Erfolg
Gibt 201 mit dem aktualisierten Mixer-Objekt zurück. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung; verlassen Sie sich ausschließlich auf die in der Antworttabelle deklarierten Felder.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Optional.
Für Menschen lesbarer Name des Mixers. Erforderlich.
Gespeicherte Zugriffssichtbarkeit: PRIVATE oder PUBLIC. Optional.
Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist. Optional.
Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen. Optional.
Szenendefinitionen, die mit dem Mixer gespeichert werden sollen. Optional.
Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen. Optional.
Szene, die derzeit Program zugewiesen ist. Optional.
Szene, die derzeit Preview zugewiesen ist. Optional.
Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden. Optional.
Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden. Optional.
Objekt mit dem gespeicherten Zustand des Audiomixers. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/create' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"name": "Example mixer",
"visibility": "PRIVATE"
}'Kennung des Mixers.
Für Menschen lesbarer Name des Mixers.
Gespeicherte Zugriffssichtbarkeit: PRIVATE oder PUBLIC.
Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist.
Gibt an, ob der Mixer derzeit aktiv ist.
Gespeicherter Lebenszyklusstatus des Mixers.
Kennung der zugewiesenen Engine, sofern eine vorhanden ist.
Szene, die derzeit Program zugewiesen ist.
Szene, die derzeit Preview zugewiesen ist.
Name der gespeicherten Layout-Voreinstellung.
Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Szenendefinitionen, die mit dem Mixer gespeichert werden sollen.
Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Objekt mit dem gespeicherten Zustand des Audiomixers.
Gespeicherte Voreinstellungen für die Synchronisierung.
Aktuelles oder gespeichertes Zustandsobjekt der Engine, sofern es zurückgegeben wird.
Aktuelles oder gespeichertes Zustandsobjekt der Aufzeichnung, sofern es zurückgegeben wird.
Vom Dienst bereitgestellter Zeitstempel der Erstellung.
Vom Dienst bereitgestellter Zeitstempel der letzten Änderung.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Lesen Sie einen Mixer, der dem authentifizierten Eigentümer zur Verfügung steht.
Erfolg
Gibt 201 mit dem Mixer-Objekt zurück. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung; verlassen Sie sich ausschließlich auf die in der Antworttabelle deklarierten Felder.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/getById' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"id": "<mixer_id>"
}'Kennung des Mixers.
Für Menschen lesbarer Name des Mixers.
Gespeicherte Zugriffssichtbarkeit: PRIVATE oder PUBLIC.
Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist.
Gibt an, ob der Mixer derzeit aktiv ist.
Gespeicherter Lebenszyklusstatus des Mixers.
Kennung der zugewiesenen Engine, sofern eine vorhanden ist.
Szene, die derzeit Program zugewiesen ist.
Szene, die derzeit Preview zugewiesen ist.
Name der gespeicherten Layout-Voreinstellung.
Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Szenendefinitionen, die mit dem Mixer gespeichert werden sollen.
Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Objekt mit dem gespeicherten Zustand des Audiomixers.
Gespeicherte Voreinstellungen für die Synchronisierung.
Aktuelles oder gespeichertes Zustandsobjekt der Engine, sofern es zurückgegeben wird.
Aktuelles oder gespeichertes Zustandsobjekt der Aufzeichnung, sofern es zurückgegeben wird.
Vom Dienst bereitgestellter Zeitstempel der Erstellung.
Vom Dienst bereitgestellter Zeitstempel der letzten Änderung.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Listen Sie Mixer-Datensätze auf, die dem authentifizierten Eigentümer zur Verfügung stehen. Verwenden Sie limit und skip für die Seitennummerierung.
Erfolg
Gibt 201 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung; verlassen Sie sich ausschließlich auf die in der Antworttabelle deklarierten Felder.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Maximale Anzahl zurückzugebender Mixer-Datensätze. Optional.
Anzahl der Datensätze, die vor der Rückgabe übersprungen werden. Optional.
Sortierspezifikation für die Mixerliste. Optional.
Filterspezifikation für die Mixerliste. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/getAll' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"limit": 10,
"skip": 0,
"sort": {},
"filter": {}
}'[
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}
]Geben Sie die Anzahl der für den Eigentümer sichtbaren Datensätze zurück, die einem optionalen Filter entsprechen.
Erfolg
Gibt 201 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung; verlassen Sie sich ausschließlich auf die in der Antworttabelle deklarierten Felder.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Filterspezifikation für die Mixerliste. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/getCount' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"filter": {}
}'Anzahl der Datensätze, die der Anfrage entsprechen.
{
"count": 1
}Aktualisieren Sie die gespeicherte Konfiguration. Verwenden Sie take statt dieser Route, um Preview nach Program zu übernehmen.
Konfigurationsobjekte
| Feld | Verwendung |
|---|---|
inputs[] | Jeder Eingang benötigt name und type. Verweisen Sie auf vorhandene Eingangs- und Quellkennungen; quellspezifische Einstellungen bilden kein geschlossenes portables Schema. |
scenes[] | Jede Szene benötigt id und name. Ihre layers[] verwenden id, name, source_id, visible und opacity (eine Zahl von 0 bis 1) aus dem veröffentlichten Schema. |
outputs[] | Ausgabeobjekte verwenden id, name, type, enabled und endpunktspezifische settings. |
canvas_settings, performance_settings, audio_mixer_state | Diese Objekte bleiben über ihre veröffentlichten Eigenschaften hinaus offen. Verwenden Sie nur Eigenschaften, die vom Anfrageschema unterstützt werden; übernehmen Sie Dashboard-Vorbelegungen nicht als Serverstandardwerte. |
Erfolg
Gibt 201 mit dem aktualisierten Mixer-Objekt zurück. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung; verlassen Sie sich ausschließlich auf die in der Antworttabelle deklarierten Felder.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Für Menschen lesbarer Name des Mixers. Erforderlich.
Gespeicherte Zugriffssichtbarkeit: PRIVATE oder PUBLIC. Optional.
Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist. Optional.
Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen. Optional.
Szenendefinitionen, die mit dem Mixer gespeichert werden sollen. Optional.
Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen. Optional.
Szene, die derzeit Program zugewiesen ist. Optional.
Szene, die derzeit Preview zugewiesen ist. Optional.
Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden. Optional.
Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden. Optional.
Objekt mit dem gespeicherten Zustand des Audiomixers. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/update' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"id": "<mixer_id>",
"name": "Renamed mixer"
}'Kennung des Mixers.
Für Menschen lesbarer Name des Mixers.
Gespeicherte Zugriffssichtbarkeit: PRIVATE oder PUBLIC.
Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist.
Gibt an, ob der Mixer derzeit aktiv ist.
Gespeicherter Lebenszyklusstatus des Mixers.
Kennung der zugewiesenen Engine, sofern eine vorhanden ist.
Szene, die derzeit Program zugewiesen ist.
Szene, die derzeit Preview zugewiesen ist.
Name der gespeicherten Layout-Voreinstellung.
Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Szenendefinitionen, die mit dem Mixer gespeichert werden sollen.
Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Objekt mit dem gespeicherten Zustand des Audiomixers.
Gespeicherte Voreinstellungen für die Synchronisierung.
Aktuelles oder gespeichertes Zustandsobjekt der Engine, sofern es zurückgegeben wird.
Aktuelles oder gespeichertes Zustandsobjekt der Aufzeichnung, sofern es zurückgegeben wird.
Vom Dienst bereitgestellter Zeitstempel der Erstellung.
Vom Dienst bereitgestellter Zeitstempel der letzten Änderung.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Aktivieren Sie einen gespeicherten Mixer für den Betrieb.
Erfolg
Gibt 201 mit dem aktualisierten Mixer-Objekt zurück. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung; verlassen Sie sich ausschließlich auf die in der Antworttabelle deklarierten Felder.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/enable' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"id": "<mixer_id>"
}'Kennung des Mixers.
Für Menschen lesbarer Name des Mixers.
Gespeicherte Zugriffssichtbarkeit: PRIVATE oder PUBLIC.
Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist.
Gibt an, ob der Mixer derzeit aktiv ist.
Gespeicherter Lebenszyklusstatus des Mixers.
Kennung der zugewiesenen Engine, sofern eine vorhanden ist.
Szene, die derzeit Program zugewiesen ist.
Szene, die derzeit Preview zugewiesen ist.
Name der gespeicherten Layout-Voreinstellung.
Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Szenendefinitionen, die mit dem Mixer gespeichert werden sollen.
Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Objekt mit dem gespeicherten Zustand des Audiomixers.
Gespeicherte Voreinstellungen für die Synchronisierung.
Aktuelles oder gespeichertes Zustandsobjekt der Engine, sofern es zurückgegeben wird.
Aktuelles oder gespeichertes Zustandsobjekt der Aufzeichnung, sofern es zurückgegeben wird.
Vom Dienst bereitgestellter Zeitstempel der Erstellung.
Vom Dienst bereitgestellter Zeitstempel der letzten Änderung.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Deaktivieren Sie einen gespeicherten Mixer; der Dienst hält die zugehörigen Medienressourcen an und gibt sie frei.
Erfolg
Gibt 201 mit dem aktualisierten Mixer-Objekt zurück. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung; verlassen Sie sich ausschließlich auf die in der Antworttabelle deklarierten Felder.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/disable' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"id": "<mixer_id>"
}'Kennung des Mixers.
Für Menschen lesbarer Name des Mixers.
Gespeicherte Zugriffssichtbarkeit: PRIVATE oder PUBLIC.
Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist.
Gibt an, ob der Mixer derzeit aktiv ist.
Gespeicherter Lebenszyklusstatus des Mixers.
Kennung der zugewiesenen Engine, sofern eine vorhanden ist.
Szene, die derzeit Program zugewiesen ist.
Szene, die derzeit Preview zugewiesen ist.
Name der gespeicherten Layout-Voreinstellung.
Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Szenendefinitionen, die mit dem Mixer gespeichert werden sollen.
Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Objekt mit dem gespeicherten Zustand des Audiomixers.
Gespeicherte Voreinstellungen für die Synchronisierung.
Aktuelles oder gespeichertes Zustandsobjekt der Engine, sofern es zurückgegeben wird.
Aktuelles oder gespeichertes Zustandsobjekt der Aufzeichnung, sofern es zurückgegeben wird.
Vom Dienst bereitgestellter Zeitstempel der Erstellung.
Vom Dienst bereitgestellter Zeitstempel der letzten Änderung.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Entfernen Sie einen Mixer anhand seiner Kennung, nachdem der Dienst seine Medienbereinigung abgesichert hat.
Erfolg
Gibt 201 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
curl --request DELETE \
--url 'https://your-callaba-server.example/api/av-mixers/remove' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"id": "<mixer_id>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Übernehmen oder speichern Sie den bereitgestellten fokussierten Zustand. Das Setzen von preview_scene_id mit prepare_engine bereitet Preview vor; es übernimmt Program nicht selbst.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Konfigurationsobjekte
| Feld | Verwendung |
|---|---|
inputs[] | Jeder Eingang benötigt name und type. Verweisen Sie auf vorhandene Eingangs- und Quellkennungen; quellspezifische Einstellungen bilden kein geschlossenes portables Schema. |
scenes[] | Jede Szene benötigt id und name. Ihre layers[] verwenden id, name, source_id, visible und opacity (eine Zahl von 0 bis 1) aus dem veröffentlichten Schema. |
outputs[] | Ausgabeobjekte verwenden id, name, type, enabled und endpunktspezifische settings. |
canvas_settings, performance_settings, audio_mixer_state | Diese Objekte bleiben über ihre veröffentlichten Eigenschaften hinaus offen. Verwenden Sie nur Eigenschaften, die vom Anfrageschema unterstützt werden; übernehmen Sie Dashboard-Vorbelegungen nicht als Serverstandardwerte. |
Erfolg
Gibt 201 mit dem aktualisierten Mixer-Objekt zurück. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung; verlassen Sie sich ausschließlich auf die in der Antworttabelle deklarierten Felder.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Gibt an, ob die Engine beim Anwenden dieses Zustands synchronisiert werden soll. Optional.
Gibt an, ob die Engine beim Anwenden dieses Zustands vorbereitet werden soll. Optional.
Szene, die derzeit Program zugewiesen ist. Optional.
Szene, die derzeit Preview zugewiesen ist. Optional.
Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen. Optional.
Szenendefinitionen, die mit dem Mixer gespeichert werden sollen. Optional.
Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen. Optional.
Objekt mit dem gespeicherten Zustand des Audiomixers. Optional.
Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden. Optional.
Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/updateState' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"preview_scene_id": "<scene_id>",
"prepare_engine": true
}'Kennung des Mixers.
Für Menschen lesbarer Name des Mixers.
Gespeicherte Zugriffssichtbarkeit: PRIVATE oder PUBLIC.
Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist.
Gibt an, ob der Mixer derzeit aktiv ist.
Gespeicherter Lebenszyklusstatus des Mixers.
Kennung der zugewiesenen Engine, sofern eine vorhanden ist.
Szene, die derzeit Program zugewiesen ist.
Szene, die derzeit Preview zugewiesen ist.
Name der gespeicherten Layout-Voreinstellung.
Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Szenendefinitionen, die mit dem Mixer gespeichert werden sollen.
Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Objekt mit dem gespeicherten Zustand des Audiomixers.
Gespeicherte Voreinstellungen für die Synchronisierung.
Aktuelles oder gespeichertes Zustandsobjekt der Engine, sofern es zurückgegeben wird.
Aktuelles oder gespeichertes Zustandsobjekt der Aufzeichnung, sofern es zurückgegeben wird.
Vom Dienst bereitgestellter Zeitstempel der Erstellung.
Vom Dienst bereitgestellter Zeitstempel der letzten Änderung.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Starten Sie Program aus der konfigurierten Preview. Der Mixer muss aktiviert sein, und die Szene muss eine konfigurierte Videoebene haben.
Erfolg
Gibt 201 mit dem aktualisierten Mixer-Objekt zurück. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung; verlassen Sie sich ausschließlich auf die in der Antworttabelle deklarierten Felder.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/start' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"id": "<mixer_id>"
}'Kennung des Mixers.
Für Menschen lesbarer Name des Mixers.
Gespeicherte Zugriffssichtbarkeit: PRIVATE oder PUBLIC.
Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist.
Gibt an, ob der Mixer derzeit aktiv ist.
Gespeicherter Lebenszyklusstatus des Mixers.
Kennung der zugewiesenen Engine, sofern eine vorhanden ist.
Szene, die derzeit Program zugewiesen ist.
Szene, die derzeit Preview zugewiesen ist.
Name der gespeicherten Layout-Voreinstellung.
Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Szenendefinitionen, die mit dem Mixer gespeichert werden sollen.
Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Objekt mit dem gespeicherten Zustand des Audiomixers.
Gespeicherte Voreinstellungen für die Synchronisierung.
Aktuelles oder gespeichertes Zustandsobjekt der Engine, sofern es zurückgegeben wird.
Aktuelles oder gespeichertes Zustandsobjekt der Aufzeichnung, sofern es zurückgegeben wird.
Vom Dienst bereitgestellter Zeitstempel der Erstellung.
Vom Dienst bereitgestellter Zeitstempel der letzten Änderung.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Übernehmen Sie die vorbereitete Preview-Szene nach Program. CUT erfolgt sofort; FADE verwendet duration_ms.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Konfigurationsobjekte
| Feld | Verwendung |
|---|---|
inputs[] | Jeder Eingang benötigt name und type. Verweisen Sie auf vorhandene Eingangs- und Quellkennungen; quellspezifische Einstellungen bilden kein geschlossenes portables Schema. |
scenes[] | Jede Szene benötigt id und name. Ihre layers[] verwenden id, name, source_id, visible und opacity (eine Zahl von 0 bis 1) aus dem veröffentlichten Schema. |
outputs[] | Ausgabeobjekte verwenden id, name, type, enabled und endpunktspezifische settings. |
canvas_settings, performance_settings, audio_mixer_state | Diese Objekte bleiben über ihre veröffentlichten Eigenschaften hinaus offen. Verwenden Sie nur Eigenschaften, die vom Anfrageschema unterstützt werden; übernehmen Sie Dashboard-Vorbelegungen nicht als Serverstandardwerte. |
Erfolg
Gibt 201 mit dem aktualisierten Mixer-Objekt zurück. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung; verlassen Sie sich ausschließlich auf die in der Antworttabelle deklarierten Felder.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Kennung der anzusprechenden Szene. Optional.
Program-Übergang: CUT wechselt sofort; FADE verwendet duration_ms. Optional.
Dauer des Übergangs in Millisekunden; muss null oder größer sein. Optional.
Szene, die derzeit Preview zugewiesen ist. Optional.
Szenendefinitionen, die mit dem Mixer gespeichert werden sollen. Optional.
Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/take' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"scene_id": "<preview_scene_id>",
"transition": "CUT"
}'Kennung des Mixers.
Für Menschen lesbarer Name des Mixers.
Gespeicherte Zugriffssichtbarkeit: PRIVATE oder PUBLIC.
Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist.
Gibt an, ob der Mixer derzeit aktiv ist.
Gespeicherter Lebenszyklusstatus des Mixers.
Kennung der zugewiesenen Engine, sofern eine vorhanden ist.
Szene, die derzeit Program zugewiesen ist.
Szene, die derzeit Preview zugewiesen ist.
Name der gespeicherten Layout-Voreinstellung.
Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Szenendefinitionen, die mit dem Mixer gespeichert werden sollen.
Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Objekt mit dem gespeicherten Zustand des Audiomixers.
Gespeicherte Voreinstellungen für die Synchronisierung.
Aktuelles oder gespeichertes Zustandsobjekt der Engine, sofern es zurückgegeben wird.
Aktuelles oder gespeichertes Zustandsobjekt der Aufzeichnung, sofern es zurückgegeben wird.
Vom Dienst bereitgestellter Zeitstempel der Erstellung.
Vom Dienst bereitgestellter Zeitstempel der letzten Änderung.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Stoppen Sie Program und finalisieren Sie die zugehörigen Laufzeit-, Ingress-, Aufzeichnungs- und Monitorressourcen.
Erfolg
Gibt 201 mit dem aktualisierten Mixer-Objekt zurück. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung; verlassen Sie sich ausschließlich auf die in der Antworttabelle deklarierten Felder.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/stop' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"id": "<mixer_id>"
}'Kennung des Mixers.
Für Menschen lesbarer Name des Mixers.
Gespeicherte Zugriffssichtbarkeit: PRIVATE oder PUBLIC.
Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist.
Gibt an, ob der Mixer derzeit aktiv ist.
Gespeicherter Lebenszyklusstatus des Mixers.
Kennung der zugewiesenen Engine, sofern eine vorhanden ist.
Szene, die derzeit Program zugewiesen ist.
Szene, die derzeit Preview zugewiesen ist.
Name der gespeicherten Layout-Voreinstellung.
Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Szenendefinitionen, die mit dem Mixer gespeichert werden sollen.
Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Objekt mit dem gespeicherten Zustand des Audiomixers.
Gespeicherte Voreinstellungen für die Synchronisierung.
Aktuelles oder gespeichertes Zustandsobjekt der Engine, sofern es zurückgegeben wird.
Aktuelles oder gespeichertes Zustandsobjekt der Aufzeichnung, sofern es zurückgegeben wird.
Vom Dienst bereitgestellter Zeitstempel der Erstellung.
Vom Dienst bereitgestellter Zeitstempel der letzten Änderung.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Steuern Sie eine Dateiquelle in der vorbereiteten Preview. Diese Route verändert Program nicht.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Kennung der anzusprechenden Szene. Erforderlich.
Kennung der anzusprechenden Quelle. Erforderlich.
Wiedergabeposition in Millisekunden; muss null oder größer sein. Optional.
Gibt an, ob die angesprochene Preview-Dateiquelle angehalten ist. Optional.
Generation der Preview-Steuerung, die verwendet wird, um veraltete Steuerungen zurückzuweisen. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/previewPlayback' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"scene_id": "<scene_id>",
"source_id": "<source_id>",
"paused": true
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Fordern Sie den veröffentlichten Quellen-Scan an. Einstellungen zur reinen Dashboard-Aktualisierung gehören nicht zu diesem Anfragevertrag.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/scanSources' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"id": "<mixer_id>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Listen Sie Videokonferenzräume, Teilnehmende und Spuren auf, die als Mixer-Eingänge ausgewählt werden können.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/videoCalls' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"id": "<mixer_id>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Bereiten Sie einen Eingang vor oder aktualisieren Sie ihn, ohne Program zu verändern.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 201 mit dem aktualisierten Mixer-Objekt zurück. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung; verlassen Sie sich ausschließlich auf die in der Antworttabelle deklarierten Felder.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Kennung der anzusprechenden Mixereingabe. Optional.
Kennung der anzusprechenden Quelle. Optional.
Teilnehmeridentität, die einer Eingabe zugeordnet werden soll. Optional.
Name des Videoanrufraums, der einer Eingabe zugeordnet werden soll. Optional.
Gibt an, ob ein bereits vorbereiteter Eingabe-Worker neu gestartet werden soll. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/primeInput' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"input_id": "<input_id>"
}'Kennung des Mixers.
Für Menschen lesbarer Name des Mixers.
Gespeicherte Zugriffssichtbarkeit: PRIVATE oder PUBLIC.
Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist.
Gibt an, ob der Mixer derzeit aktiv ist.
Gespeicherter Lebenszyklusstatus des Mixers.
Kennung der zugewiesenen Engine, sofern eine vorhanden ist.
Szene, die derzeit Program zugewiesen ist.
Szene, die derzeit Preview zugewiesen ist.
Name der gespeicherten Layout-Voreinstellung.
Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Szenendefinitionen, die mit dem Mixer gespeichert werden sollen.
Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Objekt mit dem gespeicherten Zustand des Audiomixers.
Gespeicherte Voreinstellungen für die Synchronisierung.
Aktuelles oder gespeichertes Zustandsobjekt der Engine, sofern es zurückgegeben wird.
Aktuelles oder gespeichertes Zustandsobjekt der Aufzeichnung, sofern es zurückgegeben wird.
Vom Dienst bereitgestellter Zeitstempel der Erstellung.
Vom Dienst bereitgestellter Zeitstempel der letzten Änderung.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Fordern Sie vor Ausrichtungsarbeiten Zeitinformationen für eine Quelle oder Ebene an.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Kennung der anzusprechenden Szenenebene. Optional.
Kennung der anzusprechenden Quelle. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/detectSync' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"source_id": "<source_id>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Fordern Sie ein kurzlebiges Browser-Token an. Geben Sie ein zurückgegebenes Token niemals in Beispielen, der Versionsverwaltung oder Protokollen preis.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt eine Token-Anfrage außer subscribe_only: true die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 201 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Optionale Teilnehmerkennung für ein Browser-Token. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/browserToken' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"subscribe_only": true
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Fordern Sie ein kurzlebiges Token für die angegebene Videokonferenz an. Behandeln Sie zurückgegebene Zugangsdaten als Geheimnisse.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 201 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Kennung der Videoanrufkonferenz. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/videoCallToken' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"conference_id": "<conference_id>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Erstellen Sie eine Einladung zur Telefonveröffentlichung für PREVIEW oder LIBRARY. Das Einladungs-Token, der Publisher-Pfad und die Veröffentlichungs-URL sind Zugangsdaten.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 201 mit dem Sitzungsobjekt für die Telefonveröffentlichung zurück; behandeln Sie Einladungs- und Veröffentlichungswerte als Geheimnisse. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung; verlassen Sie sich ausschließlich auf die in der Antworttabelle deklarierten Felder.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Vom Aufrufer bereitgestellte oder zurückgegebene Vorgangskennung für die Telefonveröffentlichung. Optional.
Vom Endpunkt ausgewähltes Steuerungsziel. Optional.
Kennung der anzusprechenden Szene. Optional.
Gibt an, ob die Sitzung für die Telefonveröffentlichung ihr Ziel automatisch übernehmen soll. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/createPhonePublishSession' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"target": "PREVIEW",
"scene_id": "<scene_id>",
"auto_take": false
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
Vom Aufrufer bereitgestellte oder zurückgegebene Vorgangskennung für die Telefonveröffentlichung.
Undurchsichtiges Einladungstoken für die Telefonveröffentlichung. Behandeln Sie es als Geheimnis.
Gibt an, ob die zurückgegebene Telefoneinladung dauerhaft gültig bleibt.
Geltungsbereich der zurückgegebenen Sitzung für die Telefonveröffentlichung.
Für die Sitzung zur Telefonveröffentlichung zurückgegebener Publisher-Pfad.
Anzeigename, der dem Telefonteilnehmer zugewiesen wird.
Teilnehmeridentität, die einer Eingabe zugeordnet werden soll.
Kennung der anzusprechenden Mixereingabe.
Vom Endpunkt ausgewähltes Steuerungsziel.
Kennung der anzusprechenden Szene.
Gibt an, ob die Sitzung für die Telefonveröffentlichung ihr Ziel automatisch übernehmen soll.
Mixerobjekt, das der Sitzung für die Telefonveröffentlichung zugeordnet ist.
Für die Sitzung zur Telefonveröffentlichung zurückgegebene Veröffentlichungs-URL. Behandeln Sie sie als vertraulich.
{
"success": true,
"operation_id": "<operation_id>",
"invite_token": "<one_time_invite_token>"
}Brechen Sie den benannten Vorgang zur Telefonveröffentlichung ab. Der Dienst kann melden, dass der Abbruch bereits läuft oder abgeschlossen ist.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Vom Aufrufer bereitgestellte oder zurückgegebene Vorgangskennung für die Telefonveröffentlichung. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/cancelPhonePublishSession' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"operation_id": "<operation_id>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Lesen Sie die aktuellen Daten der Audiopegelmesser.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/audioMeters' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"id": "<mixer_id>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Konfigurieren Sie die Routing-Ausgabe des Monitors und die optionale Aussetzung des Monitors.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Struktur der Audio-Routen
| Objekt | Felds |
|---|---|
routes[] | Jede Route benötigt channel_id und source_id; sie kann außerdem gain, muted, pan, delay_ms und buffer_ms enthalten. |
master | Master-Einstellungen für Verstärkung/Stummschaltung, sofern die ausgewählte Methode sie unterstützt. |
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Kennung des anzusprechenden Mixerausgangs. Optional.
Gibt an, ob die Monitorausgabe angehalten ist. Optional.
Gibt an, ob die Monitorkonfiguration auf den ausgewählten Ausgang angewendet werden soll. Optional.
Definitionen von Audiorouten. Jede Route bezeichnet einen Kanal und eine Quelle. Optional.
Objekt mit den Master-Audioeinstellungen. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/audioMonitor' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"suspended": true
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Übernehmen Sie Werte für Monitor-Routen und die Gesamtlautstärke.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Struktur der Audio-Routen
| Objekt | Felds |
|---|---|
routes[] | Jede Route benötigt channel_id und source_id; sie kann außerdem gain, muted, pan, delay_ms und buffer_ms enthalten. |
master | Master-Einstellungen für Verstärkung/Stummschaltung, sofern die ausgewählte Methode sie unterstützt. |
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Kennung des anzusprechenden Mixerausgangs. Optional.
Gibt an, ob die Monitorausgabe angehalten ist. Optional.
Gibt an, ob die Monitorkonfiguration auf den ausgewählten Ausgang angewendet werden soll. Optional.
Definitionen von Audiorouten. Jede Route bezeichnet einen Kanal und eine Quelle. Optional.
Objekt mit den Master-Audioeinstellungen. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/audioMonitorVolumes' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"master": {
"muted": true
}
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Übernehmen Sie den bereitgestellten Audio-Mixer-Zustand in den Program-Graphen.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Objekt mit dem gespeicherten Zustand des Audiomixers. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/programAudio' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"audio_mixer_state": {}
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Setzen Sie den Veröffentlichungszustand einer Ausgabe, ohne den Rest der Mixer-Konfiguration zu ersetzen.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Kennung des anzusprechenden Mixerausgangs. Erforderlich.
Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/outputs/publishState' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"output_id": "<output_id>",
"enabled": true
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Starten Sie die Aufzeichnung von Program oder der ausgewählten Ausgabe.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 201 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Kennung des anzusprechenden Mixerausgangs. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/recording/start' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"output_id": "<output_id>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Stoppen und finalisieren Sie die Aufzeichnung von Program oder der ausgewählten Ausgabe.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 201 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Kennung des anzusprechenden Mixerausgangs. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/recording/stop' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"output_id": "<output_id>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Lesen Sie die für den Eigentümer sichtbaren Laufzeitinformationen.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/runtime' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"id": "<mixer_id>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Lesen Sie für den Eigentümer sichtbare Mixer-Statistiken.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/getStat' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"id": "<mixer_id>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Fordern Sie ein Zurücksetzen der Kamera an; eine Bezeichnung kann das Ziel identifizieren.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Optionale Beschriftung für das Zurücksetzen der Kamera. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/cameraReset' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"label": "<camera_label>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Fordern Sie das Aufwecken der Quelle an, die am benannten Mixer-Eingang angeschlossen ist.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Kennung der anzusprechenden Mixereingabe. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/wakeSource' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"input_id": "<input_id>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Teilen Sie der Engine mit, welche vorhandenen Eingänge derzeit ihre Quellen anfordern. input_ids muss tatsächliche Eingangskennungen enthalten.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Nicht leere Liste von Mixer-Eingabekennungen, deren Quellen derzeit benötigt werden. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/sourceDemand' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"input_ids": [
"<input_id>"
]
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Entfernen Sie die angegebene Datei aus einem Mixer-Projekt.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Kennung der zu entfernenden Projektdatei. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/projectFiles/remove' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>",
"file_id": "<file_id>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Lesen Sie aktuelle Audio-Protokolleinträge.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Maximale Anzahl zuletzt erstellter Einträge, die zurückgegeben werden. Mindestwert: 1. Optional.
curl --request GET \
--url 'https://your-callaba-server.example/api/av-mixers/audioLogs?id=%3Cmixer_id%3E&tail=100' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Lesen Sie aktuelle Audio-Protokolleinträge mit einer JSON-Anfrage.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Maximale Anzahl zuletzt erstellter Einträge, die zurückgegeben werden. Mindestwert: 1. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/audioLogs' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"id": "<mixer_id>",
"tail": 20
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Lesen Sie aktuelle Audio-Protokolleinträge über den Audio-Log-Alias.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Maximale Anzahl zuletzt erstellter Einträge, die zurückgegeben werden. Mindestwert: 1. Optional.
curl --request GET \
--url 'https://your-callaba-server.example/api/av-mixers/audio-controller/logs?id=%3Cmixer_id%3E&tail=100' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Lesen Sie aktuelle Audio-Protokolleinträge über den Audio-Log-Alias.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
Maximale Anzahl zuletzt erstellter Einträge, die zurückgegeben werden. Mindestwert: 1. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/audio-controller/logs' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"id": "<mixer_id>",
"tail": 20
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Löschen Sie Audio-Protokolleinträge.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/audioLogs/clear' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Löschen Sie Audio-Protokolleinträge über den Audio-Log-Alias.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/audio-controller/logs/clear' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"id": "<mixer_id>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Lesen Sie das Ergebnis des Mixer-Anfrageprotokolls.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Kennung des Mixers. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/requestLog' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--data '{
"id": "<mixer_id>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Zeichnen Sie ein kompaktes, eigentümerauthentifiziertes Client-Ereignis auf. detail ist auf 256 Zeichen begrenzt.
Steuerung einer Einzelsitzung
Bei einem Einzelsitzungs-Mixer benötigt diese Eigentümermutation die konfigurierte Operator-Lease: Senden Sie x-av-mixer-session und das aktuelle x-av-mixer-control-epoch zusammen mit der Eigentümerauthentifizierung. Eine fehlende oder abgelaufene Lease kann 423 AV_MIXER_VIEW_ONLY zurückgeben. Die veröffentlichte API stellt die Endpunkte zum Beanspruchen der Lease nicht bereit. Ein gespeicherter Mehrsitzungs-Mixer benötigt keine Client-Lease-Header.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie Autorisierung, bevor Sie Eigentümeranfragen senden. Für den Mixer-Lebenszyklus und Szenenoperationen fahren Sie mit der zugehörigen Methode in dieser AV-Mixer-Referenz fort.
Mixerkennung, die dem Client-Ereignis zugeordnet ist. Erforderlich.
Name des Client-Ereignisses. Erforderlich.
Optionales Ereignisdetail, begrenzt auf 256 Zeichen. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers/clientEvent' \
--header 'Content-Type: application/json' \
--header 'x-access-token: <your_api_token>' \
--header 'x-av-mixer-session: <operator_session>' \
--header 'x-av-mixer-control-epoch: <control_epoch>' \
--data '{
"mixer_id": "<mixer_id>",
"event": "<event_name>",
"detail": "<brief_detail>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Lesen Sie den nach Sichtbarkeit gefilterten Zustand eines PUBLIC-Mixers.
Grenze des öffentlichen Zugriffs
Dieser Lesepfad hat keinen API-Key-Header des Eigentümers. Er setzt PUBLIC-Sichtbarkeit und einen aktivierten Mixer voraus; gespeicherte Berechtigungen zur öffentlichen Steuerung begrenzen diesen Lesezugriff nicht.
Erfolg
Gibt 200 mit dem Mixer-Objekt zurück. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung; verlassen Sie sich ausschließlich auf die in der Antworttabelle deklarierten Felder.
Nächste Schritte
Prüfen Sie die PUBLIC-Sichtbarkeit und den Aktivierungszustand des Mixers, bevor Sie diese öffentliche Leseanfrage ausführen.
Kennung des Mixers. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers-public/getById' \
--header 'Content-Type: application/json' \
--data '{
"id": "<public_mixer_id>"
}'Kennung des Mixers.
Für Menschen lesbarer Name des Mixers.
Gespeicherte Zugriffssichtbarkeit: PRIVATE oder PUBLIC.
Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist.
Gibt an, ob der Mixer derzeit aktiv ist.
Gespeicherter Lebenszyklusstatus des Mixers.
Kennung der zugewiesenen Engine, sofern eine vorhanden ist.
Szene, die derzeit Program zugewiesen ist.
Szene, die derzeit Preview zugewiesen ist.
Name der gespeicherten Layout-Voreinstellung.
Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Szenendefinitionen, die mit dem Mixer gespeichert werden sollen.
Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Objekt mit dem gespeicherten Zustand des Audiomixers.
Gespeicherte Voreinstellungen für die Synchronisierung.
Aktuelles oder gespeichertes Zustandsobjekt der Engine, sofern es zurückgegeben wird.
Aktuelles oder gespeichertes Zustandsobjekt der Aufzeichnung, sofern es zurückgegeben wird.
Vom Dienst bereitgestellter Zeitstempel der Erstellung.
Vom Dienst bereitgestellter Zeitstempel der letzten Änderung.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Lösen Sie eine undurchsichtige Einladung zur Telefonveröffentlichung ein. Das Einladungs-Token ist die Berechtigung für diese Anfrage; bewahren Sie es nicht in Dokumentation oder Protokollen auf. Diese Route verwendet keinen API-Key-Header des Eigentümers.
Erfolg
Gibt 201 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Verwenden Sie ein frisches Einladungs-Token nur für die vorgesehene Sitzung zur Telefonveröffentlichung. Halten Sie zurückgegebene Verbindungsdaten aus Protokollen und der Versionsverwaltung heraus.
Undurchsichtiges Einladungstoken für die Telefonveröffentlichung. Behandeln Sie es als Geheimnis. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers-public/redeemPhonePublishSession' \
--header 'Content-Type: application/json' \
--data '{
"invite_token": "<phone_publish_invite_token>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Lesen Sie nach Sichtbarkeit gefilterte Laufzeitinformationen für einen PUBLIC-Mixer.
Grenze des öffentlichen Zugriffs
Dieser Lesepfad hat keinen API-Key-Header des Eigentümers. Er setzt PUBLIC-Sichtbarkeit und einen aktivierten Mixer voraus; gespeicherte Berechtigungen zur öffentlichen Steuerung begrenzen diesen Lesezugriff nicht.
Erfolg
Gibt 200 mit dem dokumentierten Ergebnisobjekt des Endpunkts zurück. OperationResult ist absichtlich über das dokumentierte Flag success hinaus offen; verlassen Sie sich nicht auf nicht deklarierte Antwort-Eigenschaften. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung.
Nächste Schritte
Prüfen Sie die PUBLIC-Sichtbarkeit und den Aktivierungszustand des Mixers, bevor Sie diese öffentliche Leseanfrage ausführen.
Kennung des Mixers. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers-public/runtime' \
--header 'Content-Type: application/json' \
--data '{
"id": "<public_mixer_id>"
}'True, wenn der Vorgang erfolgreich abgeschlossen wurde.
{
"success": true
}Übernehmen Sie die benannte Szene nur, wenn die gespeicherte öffentliche Berechtigung des Mixers das Umschalten von Szenen erlaubt.
Grenze des öffentlichen Zugriffs
Dieser Pfad hat keinen API-Key-Header des Eigentümers, ist jedoch keine offene Administration. Er wird anhand der PUBLIC-Sichtbarkeit des Mixers, seines Aktivierungszustands und der gespeicherten öffentlichen Berechtigungen für die angeforderte Aktion geprüft.
Erfolg
Gibt 200 mit dem aktualisierten Mixer-Objekt zurück. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung; verlassen Sie sich ausschließlich auf die in der Antworttabelle deklarierten Felder.
Nächste Schritte
Prüfen Sie die PUBLIC-Sichtbarkeit, den Aktivierungszustand und die gespeicherte Berechtigung für diese Aktion, bevor Sie eine öffentliche Anfrage ausführen.
Kennung des Mixers. Erforderlich.
Kennung der anzusprechenden Szene. Erforderlich.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers-public/take' \
--header 'Content-Type: application/json' \
--data '{
"id": "<public_mixer_id>",
"scene_id": "<scene_id>"
}'Kennung des Mixers.
Für Menschen lesbarer Name des Mixers.
Gespeicherte Zugriffssichtbarkeit: PRIVATE oder PUBLIC.
Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist.
Gibt an, ob der Mixer derzeit aktiv ist.
Gespeicherter Lebenszyklusstatus des Mixers.
Kennung der zugewiesenen Engine, sofern eine vorhanden ist.
Szene, die derzeit Program zugewiesen ist.
Szene, die derzeit Preview zugewiesen ist.
Name der gespeicherten Layout-Voreinstellung.
Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Szenendefinitionen, die mit dem Mixer gespeichert werden sollen.
Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Objekt mit dem gespeicherten Zustand des Audiomixers.
Gespeicherte Voreinstellungen für die Synchronisierung.
Aktuelles oder gespeichertes Zustandsobjekt der Engine, sofern es zurückgegeben wird.
Aktuelles oder gespeichertes Zustandsobjekt der Aufzeichnung, sofern es zurückgegeben wird.
Vom Dienst bereitgestellter Zeitstempel der Erstellung.
Vom Dienst bereitgestellter Zeitstempel der letzten Änderung.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Ändern Sie eine Eigenschaft von Eingang, Ausgabe, Audio oder Übergang nur, wenn die gespeicherte öffentliche Berechtigung diese Kategorie erlaubt.
Grenze des öffentlichen Zugriffs
Dieser Pfad hat keinen API-Key-Header des Eigentümers, ist jedoch keine offene Administration. Er wird anhand der PUBLIC-Sichtbarkeit des Mixers, seines Aktivierungszustands und der gespeicherten öffentlichen Berechtigungen für die angeforderte Aktion geprüft.
Erfolg
Gibt 200 mit dem aktualisierten Mixer-Objekt zurück. Das angezeigte Antwortbeispiel dient nur der Veranschaulichung; verlassen Sie sich ausschließlich auf die in der Antworttabelle deklarierten Felder.
Nächste Schritte
Prüfen Sie die PUBLIC-Sichtbarkeit, den Aktivierungszustand und die gespeicherte Berechtigung für diese Aktion, bevor Sie eine öffentliche Anfrage ausführen.
Kennung des Mixers. Erforderlich.
Kategorie der öffentlichen Steuerung, die durch den gespeicherten Berechtigungssatz zugelassen ist. Erforderlich.
Kennung der anzusprechenden Szene. Optional.
Kennung der anzusprechenden Szenenebene. Optional.
Kennung des anzusprechenden Mixerausgangs. Optional.
Kennung des anzusprechenden Audiokanals. Optional.
Vom Endpunkt ausgewähltes Steuerungsziel. Optional.
Angeforderte Sichtbarkeit für die angesprochene Eingabeebene. Optional.
Angeforderte Deckkraft für die angesprochene Eingabeebene. Optional.
Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist. Optional.
Angeforderter Stummschaltzustand. Optional.
Angeforderte Audioverstärkung. Optional.
Program-Übergang: CUT wechselt sofort; FADE verwendet duration_ms. Optional.
Dauer des Übergangs in Millisekunden; muss null oder größer sein. Optional.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers-public/update' \
--header 'Content-Type: application/json' \
--data '{
"id": "<public_mixer_id>",
"category": "inputs",
"scene_id": "<scene_id>",
"layer_id": "<layer_id>",
"visible": true
}'Kennung des Mixers.
Für Menschen lesbarer Name des Mixers.
Gespeicherte Zugriffssichtbarkeit: PRIVATE oder PUBLIC.
Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist.
Gibt an, ob der Mixer derzeit aktiv ist.
Gespeicherter Lebenszyklusstatus des Mixers.
Kennung der zugewiesenen Engine, sofern eine vorhanden ist.
Szene, die derzeit Program zugewiesen ist.
Szene, die derzeit Preview zugewiesen ist.
Name der gespeicherten Layout-Voreinstellung.
Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.
Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Szenendefinitionen, die mit dem Mixer gespeichert werden sollen.
Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen.
Objekt mit dem gespeicherten Zustand des Audiomixers.
Gespeicherte Voreinstellungen für die Synchronisierung.
Aktuelles oder gespeichertes Zustandsobjekt der Engine, sofern es zurückgegeben wird.
Aktuelles oder gespeichertes Zustandsobjekt der Aufzeichnung, sofern es zurückgegeben wird.
Vom Dienst bereitgestellter Zeitstempel der Erstellung.
Vom Dienst bereitgestellter Zeitstempel der letzten Änderung.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}