Callaba
Callaba-Startseite

AV-Mixer

Die AV-Mixer-API ist die veröffentlichte Callaba-8.8-Referenz zum Erstellen gespeicherter Mixer, Vorbereiten von Preview, Starten von Program, Übernehmen einer Szene und Lesen von Laufzeit- oder Audiozuständen.

Die richtige Operation wählen

  1. Verwenden Sie create oder update, um die Mixerkonfiguration zu speichern. Keine der beiden Routen startet Program.
  2. Verwenden Sie updateState, um Preview vorzubereiten, und anschließend start, wenn der Mixer aktiviert ist und Preview eine konfigurierte Videoebene hat.
  3. Verwenden Sie take, um Preview mit CUT oder FADE nach Program zu übernehmen.
  4. Verwenden Sie runtime, Statistik-, Pegel-, Ausgabe-, Aufzeichnungs- und Diagnosemethoden, um den laufenden Mixer zu betreiben oder zu beobachten.

Eigentümer- und öffentlicher Zugriff

Eigentümerrouten verwenden x-access-token. Die meisten betrieblichen Mutationen einer Einzelsitzung benötigen außerdem x-av-mixer-session und x-av-mixer-control-epoch; die Methodenseiten kennzeichnen diese Fälle. Create, update, enable, disable, remove, start und stop können die dokumentierte Ausnahme für eine temporäre Verwaltungslease verwenden, wenn keine Operator-Lease aktiv ist. Leiten Sie aus dieser Referenz keinen clientseitigen Claim-Flow ab: Die Live-API veröffentlicht weder /control/* noch /studio/*.

Die separat gekennzeichneten Leserouten /api/av-mixers-public verwenden nicht den Eigentümer-API-Schlüssel; sie benötigen Sichtbarkeit PUBLIC und einen aktivierten Mixer. Öffentliches take und update benötigen außerdem die entsprechende gespeicherte öffentliche Berechtigung. Ein öffentlicher Link ist keine allgemeine Verwaltungsberechtigung. Die Route zur Einlösung einer Einladung verwendet stattdessen ihr undurchsichtiges Einladungs-Token als Zugangsdaten.

Verwandte Referenzen

Lesen Sie Autorisierung zur Eigentümerauthentifizierung. Verwenden Sie Videoanrufe zum Zuweisen von Konferenzspuren und SRT-Server für Transportendpunkte. Antworten mit Telefon- und Browser-Token sind Zugangsdaten: Verwenden Sie Platzhalter in Anfragen und veröffentlichen Sie niemals zurückgegebene Werte.

47 Endpunkte
POST
/api/av-mixers/create
API-Token erforderlich

Erstellen Sie zuerst den gespeicherten Mixer. Die Erstellung speichert nur die Konfiguration; sie startet Program nicht.

Konfigurationsobjekte

FeldVerwendung
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_stateDiese 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.

Parameter im Request-Body
Optional
id
string
Direktlink kopieren

Kennung des Mixers. Optional.

Erforderlich
name
string
Direktlink kopieren

Für Menschen lesbarer Name des Mixers. Erforderlich.

Optional
visibility
string (PRIVATE | PUBLIC)
Direktlink kopieren

Gespeicherte Zugriffssichtbarkeit: PRIVATE oder PUBLIC. Optional.

enabled
boolean
Direktlink kopieren

Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist. Optional.

inputs
array
Direktlink kopieren

Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen. Optional.

scenes
array
Direktlink kopieren

Szenendefinitionen, die mit dem Mixer gespeichert werden sollen. Optional.

outputs
array
Direktlink kopieren

Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen. Optional.

active_scene_id
string
Direktlink kopieren

Szene, die derzeit Program zugewiesen ist. Optional.

preview_scene_id
string
Direktlink kopieren

Szene, die derzeit Preview zugewiesen ist. Optional.

canvas_settings
object
Direktlink kopieren

Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden. Optional.

performance_settings
object
Direktlink kopieren

Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden. Optional.

audio_mixer_state
object
Direktlink kopieren

Objekt mit dem gespeicherten Zustand des Audiomixers. Optional.

AV-Mixer erstellen
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"
}'
Antwort
Antwort
id
string
Direktlink kopieren

Kennung des Mixers.

name
string
Direktlink kopieren

Für Menschen lesbarer Name des Mixers.

visibility
string (PRIVATE | PUBLIC)
Direktlink kopieren

Gespeicherte Zugriffssichtbarkeit: PRIVATE oder PUBLIC.

enabled
boolean
Direktlink kopieren

Gibt an, ob der gespeicherte Mixer für den Betrieb aktiviert ist.

active
boolean
Direktlink kopieren

Gibt an, ob der Mixer derzeit aktiv ist.

status
string
Direktlink kopieren

Gespeicherter Lebenszyklusstatus des Mixers.

engine_id
string
Direktlink kopieren

Kennung der zugewiesenen Engine, sofern eine vorhanden ist.

active_scene_id
string
Direktlink kopieren

Szene, die derzeit Program zugewiesen ist.

preview_scene_id
string
Direktlink kopieren

Szene, die derzeit Preview zugewiesen ist.

layout_preset
string
Direktlink kopieren

Name der gespeicherten Layout-Voreinstellung.

canvas_settings
object
Direktlink kopieren

Konfigurationsobjekt für die Bildfläche; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.

performance_settings
object
Direktlink kopieren

Konfigurationsobjekt für die Leistung; verwenden Sie nur Felder, die vom veröffentlichten Schema unterstützt werden.

inputs
array
Direktlink kopieren

Eingangsdefinitionen, die mit dem Mixer gespeichert werden sollen.

scenes
array
Direktlink kopieren

Szenendefinitionen, die mit dem Mixer gespeichert werden sollen.

outputs
array
Direktlink kopieren

Ausgangsdefinitionen, die mit dem Mixer gespeichert werden sollen.

audio_mixer_state
object
Direktlink kopieren

Objekt mit dem gespeicherten Zustand des Audiomixers.

sync_presets
array
Direktlink kopieren

Gespeicherte Voreinstellungen für die Synchronisierung.

engine_state
object
Direktlink kopieren

Aktuelles oder gespeichertes Zustandsobjekt der Engine, sofern es zurückgegeben wird.

recording_state
object
Direktlink kopieren

Aktuelles oder gespeichertes Zustandsobjekt der Aufzeichnung, sofern es zurückgegeben wird.

created
string
Direktlink kopieren

Vom Dienst bereitgestellter Zeitstempel der Erstellung.

modified
string
Direktlink kopieren

Vom Dienst bereitgestellter Zeitstempel der letzten Änderung.

Antwort: AV-Mixer erstellen
{
  "id": "64f1c2e77393ab0012345678",
  "name": "Studio mixer"
}
POST
/api/av-mixers/getById
API-Token erforderlich
POST
/api/av-mixers/getAll
API-Token erforderlich
POST
/api/av-mixers/getCount
API-Token erforderlich
POST
/api/av-mixers/update
API-Token erforderlich
POST
/api/av-mixers/enable
API-Token erforderlich
POST
/api/av-mixers/disable
API-Token erforderlich
DELETE
/api/av-mixers/remove
API-Token erforderlich
POST
/api/av-mixers/updateState
API-Token erforderlich
POST
/api/av-mixers/start
API-Token erforderlich
POST
/api/av-mixers/take
API-Token erforderlich
POST
/api/av-mixers/stop
API-Token erforderlich
POST
/api/av-mixers/previewPlayback
API-Token erforderlich
POST
/api/av-mixers/scanSources
API-Token erforderlich
POST
/api/av-mixers/videoCalls
API-Token erforderlich
POST
/api/av-mixers/primeInput
API-Token erforderlich
POST
/api/av-mixers/detectSync
API-Token erforderlich
POST
/api/av-mixers/browserToken
API-Token erforderlich
POST
/api/av-mixers/videoCallToken
API-Token erforderlich
POST
/api/av-mixers/createPhonePublishSession
API-Token erforderlich
POST
/api/av-mixers/cancelPhonePublishSession
API-Token erforderlich
POST
/api/av-mixers/audioMeters
API-Token erforderlich
POST
/api/av-mixers/audioMonitor
API-Token erforderlich
POST
/api/av-mixers/audioMonitorVolumes
API-Token erforderlich
POST
/api/av-mixers/programAudio
API-Token erforderlich
POST
/api/av-mixers/outputs/publishState
API-Token erforderlich
POST
/api/av-mixers/recording/start
API-Token erforderlich
POST
/api/av-mixers/recording/stop
API-Token erforderlich
POST
/api/av-mixers/runtime
API-Token erforderlich
POST
/api/av-mixers/getStat
API-Token erforderlich
POST
/api/av-mixers/cameraReset
API-Token erforderlich
POST
/api/av-mixers/wakeSource
API-Token erforderlich
POST
/api/av-mixers/sourceDemand
API-Token erforderlich
POST
/api/av-mixers/projectFiles/remove
API-Token erforderlich
GET
/api/av-mixers/audioLogs
API-Token erforderlich
POST
/api/av-mixers/audioLogs
API-Token erforderlich
GET
/api/av-mixers/audio-controller/logs
API-Token erforderlich
POST
/api/av-mixers/audio-controller/logs
API-Token erforderlich
POST
/api/av-mixers/audioLogs/clear
API-Token erforderlich
POST
/api/av-mixers/audio-controller/logs/clear
API-Token erforderlich
POST
/api/av-mixers/requestLog
API-Token erforderlich
POST
/api/av-mixers/clientEvent
API-Token erforderlich
POST
/api/av-mixers-public/getById
Öffentlicher Endpunkt
POST
/api/av-mixers-public/redeemPhonePublishSession
Öffentlicher Endpunkt
POST
/api/av-mixers-public/runtime
Öffentlicher Endpunkt
POST
/api/av-mixers-public/take
Öffentlicher Endpunkt
POST
/api/av-mixers-public/update
Öffentlicher Endpunkt
Workflow-Beispiele und Hilfe
REST-Lösungsrezept

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.

  1. 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
  2. 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
  3. Preview vorbereitenAktualisieren Sie den vorgesehenen Preview-Zustand, ohne diese Vorbereitung als Program-Take zu behandeln.POST /api/av-mixers/updateState
  4. 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
  5. 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.

Ask AI