Callaba
Inicio de Callaba

Mezcladores AV

La API de mezcladores AV es la referencia publicada de Callaba 8.8 para crear mezcladores guardados, preparar Preview, iniciar Program, poner una escena al aire y consultar el estado de ejecución o audio.

Elige la operación adecuada

  1. Usa create o update para guardar la configuración del mezclador. Ninguna de estas rutas inicia Program.
  2. Usa updateState para preparar Preview y después start cuando el mezclador esté habilitado y Preview tenga una capa de vídeo configurada.
  3. Usa take para llevar Preview a Program con CUT o FADE.
  4. Usa runtime, estadísticas, medidores, salida, grabación y métodos de diagnóstico para operar u observar el mezclador en ejecución.

Propietario y acceso público

Las rutas de propietario usan x-access-token. La mayoría de las mutaciones operativas de una sesión también requieren x-av-mixer-session y x-av-mixer-control-epoch; las páginas de método identifican esos casos. Crear, actualizar, habilitar, deshabilitar, eliminar, iniciar y detener pueden usar la excepción documentada de lease de gestión temporal cuando no hay un lease de operador activo. No deduzcas un flujo de adquisición del lado del cliente de esta referencia: la API activa no publica /control/* ni /studio/*.

Las rutas de lectura /api/av-mixers-public, etiquetadas por separado, no usan la clave API de propietario; requieren visibilidad PUBLIC y un mezclador habilitado. Los métodos públicos take y update también requieren el permiso público guardado pertinente. Un enlace público no es una credencial administrativa general. La ruta de canje de invitación usa su token de invitación opaco como credencial.

Referencias relacionadas

Consulta Autorización para la autenticación del propietario. Usa Videollamadas al asignar pistas de conferencia y Servidores SRT para endpoints de transporte. Las respuestas de token de teléfono y navegador son credenciales: usa marcadores de posición en las solicitudes y nunca publiques valores devueltos.

47 endpoints
POST
/api/av-mixers/create
Requiere token de API

Crea primero el mezclador guardado. La creación solo almacena la configuración; no inicia Program.

Objetos de configuración

CampoUso
inputs[]Cada entrada requiere name y type. Haz referencia a identificadores de entrada y fuente existentes; la configuración específica de la fuente no es un esquema portátil cerrado.
scenes[]Cada escena requiere id y name. Sus layers[] usan id, name, source_id, visible y opacity (un número de 0 a 1) del esquema publicado.
outputs[]Los objetos de salida usan id, name, type, enabled y settings específicos del endpoint.
canvas_settings, performance_settings, audio_mixer_stateEstos objetos permanecen abiertos más allá de sus propiedades publicadas. Usa solo propiedades admitidas por el esquema de solicitud; no copies los valores preconfigurados del panel como valores predeterminados del servidor.

Correcto

Devuelve 201 con el objeto de mezclador actualizado. El ejemplo de respuesta mostrado es ilustrativo; usa solo los campos declarados en la tabla de respuesta.

Parámetros del cuerpo de la solicitud
Opcional
id
string
Copiar enlace directo

Identificador del mezclador. Opcional.

Obligatorio
name
string
Copiar enlace directo

Nombre legible del mezclador. Obligatorio.

Opcional
visibility
string (PRIVATE | PUBLIC)
Copiar enlace directo

Visibilidad de acceso guardada: PRIVATE o PUBLIC. Opcional.

enabled
boolean
Copiar enlace directo

Indica si el mezclador guardado está habilitado para operar. Opcional.

inputs
array
Copiar enlace directo

Definiciones de entradas que se almacenarán con el mezclador. Opcional.

scenes
array
Copiar enlace directo

Definiciones de escenas que se almacenarán con el mezclador. Opcional.

outputs
array
Copiar enlace directo

Definiciones de salidas que se almacenarán con el mezclador. Opcional.

active_scene_id
string
Copiar enlace directo

Escena asignada actualmente a Program. Opcional.

preview_scene_id
string
Copiar enlace directo

Escena asignada actualmente a Preview. Opcional.

canvas_settings
object
Copiar enlace directo

Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado. Opcional.

performance_settings
object
Copiar enlace directo

Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado. Opcional.

audio_mixer_state
object
Copiar enlace directo

Objeto de estado guardado del mezclador de audio. Opcional.

Crear un mezclador AV
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"
}'
Respuesta
Respuesta
id
string
Copiar enlace directo

Identificador del mezclador.

name
string
Copiar enlace directo

Nombre legible del mezclador.

visibility
string (PRIVATE | PUBLIC)
Copiar enlace directo

Visibilidad de acceso guardada: PRIVATE o PUBLIC.

enabled
boolean
Copiar enlace directo

Indica si el mezclador guardado está habilitado para operar.

active
boolean
Copiar enlace directo

Indica si el mezclador está activo en este momento.

status
string
Copiar enlace directo

Estado persistido del ciclo de vida del mezclador.

engine_id
string
Copiar enlace directo

Identificador del motor asignado, cuando existe.

active_scene_id
string
Copiar enlace directo

Escena asignada actualmente a Program.

preview_scene_id
string
Copiar enlace directo

Escena asignada actualmente a Preview.

layout_preset
string
Copiar enlace directo

Nombre del ajuste predefinido de diseño guardado.

canvas_settings
object
Copiar enlace directo

Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado.

performance_settings
object
Copiar enlace directo

Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado.

inputs
array
Copiar enlace directo

Definiciones de entradas que se almacenarán con el mezclador.

scenes
array
Copiar enlace directo

Definiciones de escenas que se almacenarán con el mezclador.

outputs
array
Copiar enlace directo

Definiciones de salidas que se almacenarán con el mezclador.

audio_mixer_state
object
Copiar enlace directo

Objeto de estado guardado del mezclador de audio.

sync_presets
array
Copiar enlace directo

Ajustes predefinidos de sincronización guardados.

engine_state
object
Copiar enlace directo

Objeto del estado actual o guardado del motor, cuando se devuelve.

recording_state
object
Copiar enlace directo

Objeto del estado actual o guardado de la grabación, cuando se devuelve.

created
string
Copiar enlace directo

Marca de tiempo de creación proporcionada por el servicio.

modified
string
Copiar enlace directo

Marca de tiempo de la última modificación proporcionada por el servicio.

Respuesta: Crear un mezclador AV
{
  "id": "64f1c2e77393ab0012345678",
  "name": "Studio mixer"
}
POST
/api/av-mixers/getById
Requiere token de API
POST
/api/av-mixers/getAll
Requiere token de API
POST
/api/av-mixers/getCount
Requiere token de API
POST
/api/av-mixers/update
Requiere token de API
POST
/api/av-mixers/enable
Requiere token de API
POST
/api/av-mixers/disable
Requiere token de API
DELETE
/api/av-mixers/remove
Requiere token de API
POST
/api/av-mixers/updateState
Requiere token de API
POST
/api/av-mixers/start
Requiere token de API
POST
/api/av-mixers/take
Requiere token de API
POST
/api/av-mixers/stop
Requiere token de API
POST
/api/av-mixers/previewPlayback
Requiere token de API
POST
/api/av-mixers/scanSources
Requiere token de API
POST
/api/av-mixers/videoCalls
Requiere token de API
POST
/api/av-mixers/primeInput
Requiere token de API
POST
/api/av-mixers/detectSync
Requiere token de API
POST
/api/av-mixers/browserToken
Requiere token de API
POST
/api/av-mixers/videoCallToken
Requiere token de API
POST
/api/av-mixers/createPhonePublishSession
Requiere token de API
POST
/api/av-mixers/cancelPhonePublishSession
Requiere token de API
POST
/api/av-mixers/audioMeters
Requiere token de API
POST
/api/av-mixers/audioMonitor
Requiere token de API
POST
/api/av-mixers/audioMonitorVolumes
Requiere token de API
POST
/api/av-mixers/programAudio
Requiere token de API
POST
/api/av-mixers/outputs/publishState
Requiere token de API
POST
/api/av-mixers/recording/start
Requiere token de API
POST
/api/av-mixers/recording/stop
Requiere token de API
POST
/api/av-mixers/runtime
Requiere token de API
POST
/api/av-mixers/getStat
Requiere token de API
POST
/api/av-mixers/cameraReset
Requiere token de API
POST
/api/av-mixers/wakeSource
Requiere token de API
POST
/api/av-mixers/sourceDemand
Requiere token de API
POST
/api/av-mixers/projectFiles/remove
Requiere token de API
GET
/api/av-mixers/audioLogs
Requiere token de API
POST
/api/av-mixers/audioLogs
Requiere token de API
GET
/api/av-mixers/audio-controller/logs
Requiere token de API
POST
/api/av-mixers/audio-controller/logs
Requiere token de API
POST
/api/av-mixers/audioLogs/clear
Requiere token de API
POST
/api/av-mixers/audio-controller/logs/clear
Requiere token de API
POST
/api/av-mixers/requestLog
Requiere token de API
POST
/api/av-mixers/clientEvent
Requiere token de API
POST
/api/av-mixers-public/getById
Endpoint público
POST
/api/av-mixers-public/redeemPhonePublishSession
Endpoint público
POST
/api/av-mixers-public/runtime
Endpoint público
POST
/api/av-mixers-public/take
Endpoint público
POST
/api/av-mixers-public/update
Endpoint público
Ejemplos de flujos de trabajo y ayuda
Receta de solución REST

Inspeccionar un mixer configurado antes de automatizar un take

Lee primero el mixer guardado y su tiempo de ejecución, prepara Preview de forma deliberada y ejecuta un take solo cuando Program esté iniciado y la sesión de control configurada esté disponible.

  1. Leer el mixer guardadoConfirma el mixer elegido, sus escenas, entradas, salidas y la configuración guardada de Preview.POST /api/av-mixers/getById
  2. Comprobar el tiempo de ejecución actualUsa el estado de ejecución para comprobar si Program ya está en marcha antes de cambiar el estado preparado.POST /api/av-mixers/runtime
  3. Preparar PreviewActualiza el estado de Preview previsto sin tratar esa preparación como un take de Program.POST /api/av-mixers/updateState
  4. Tomar la escena preparadaEnvía el take solo cuando Preview tenga una capa de vídeo configurada, Program esté iniciado y se mantenga la sesión de control requerida.POST /api/av-mixers/take
  5. Inspeccionar el resultadoLee de nuevo el tiempo de ejecución y verifica el estado resultante en el flujo de operador antes de la siguiente acción automatizada.POST /api/av-mixers/runtime

Esta es una secuencia de inspección y preparación, no una receta de ejecución en directo. Un take necesita una capa de vídeo configurada en Preview, Program iniciado y, en un mixer de sesión única, las cabeceras de sesión de control aplicables.

Ask AI