Mezcladores AV
La API de mezcladores AV es la referencia publicada de Callaba 8.8 para crear mezcladores guardados, preparar Preview, iniciar Program, llevar una escena al aire y consultar el estado de ejecución o de audio.
Elige este módulo cuandoUn flujo de mezclador AV de Callaba 8.8 ya está probado en la interfaz y el equipo necesita automatización delimitada para Preview, Program, salidas, grabación u observación.
Usa otro módulo cuandoUsa la guía de producción remota cuando el diseño de producción aún no esté probado; no uses métodos públicos como vía general de administración.
/api/av-mixers/createElige la operación adecuada
- Usa
createoupdatepara guardar la configuración del mezclador. Ninguna de estas rutas inicia Program. - Usa
updateStatepara preparar Preview y despuésstartcuando el mezclador esté habilitado y Preview tenga una capa de vídeo configurada. - Usa
takepara llevar Preview a Program conCUToFADE. - Usa
runtime, estadísticas, medidores, salida, grabación y métodos de diagnóstico para operar u observar el mezclador activo.
Acceso de propietario y público
Las rutas de propietario usan x-access-token. La mayoría de las modificaciones operativas de sesión única también necesitan x-av-mixer-session y x-av-mixer-control-epoch; las páginas de método identifican esos casos. Las operaciones para crear, actualizar, habilitar, deshabilitar, eliminar, iniciar y detener pueden utilizar la excepción de lease de gestión temporal documentada cuando no existe un lease de operador activo. No deduzcas un flujo de adquisición de lease del lado del cliente a partir de esta referencia: la API activa no publica /control/*.
Las rutas de lectura etiquetadas por separado como /api/av-mixers-public no usan la clave API de propietario; requieren visibilidad PUBLIC y un mezclador habilitado. Las operaciones públicas take y update también requieren el permiso público guardado pertinente. Un enlace público no es una credencial general de administración. La ruta de canje de invitación usa en cambio su token de invitación opaco como credencial.
Referencias relacionadas
Consulta Autorización para la autenticación de 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.
Alcance
Este módulo documenta las operaciones de mezcladores AV presentes en la referencia de API publicada. No documenta rutas de solo código fuente /control/* ni /studio/*.
Siguientes pasos
Elige un mezclador guardado, confirma su límite de acceso y empieza con una solicitud de alcance reducido. Mantén las credenciales devueltas de navegador, conferencia y publicación telefónica fuera del control de código fuente y de los registros.
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.
- Leer el mixer guardadoConfirma el mixer elegido, sus escenas, entradas, salidas y la configuración guardada de Preview.
POST /api/av-mixers/getById - 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 - Preparar PreviewActualiza el estado de Preview previsto sin tratar esa preparación como un take de Program.
POST /api/av-mixers/updateState - 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 - 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.
Crea primero el mezclador guardado. La creación solo almacena la configuración; no inicia Program.
Objetos de configuración
| Campo | Uso |
|---|---|
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_state | Estos 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.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Opcional.
Nombre legible del mezclador. Obligatorio.
Visibilidad de acceso guardada: PRIVATE o PUBLIC. Opcional.
Indica si el mezclador guardado está habilitado para operar. Opcional.
Definiciones de entradas que se almacenarán con el mezclador. Opcional.
Definiciones de escenas que se almacenarán con el mezclador. Opcional.
Definiciones de salidas que se almacenarán con el mezclador. Opcional.
Escena asignada actualmente a Program. Opcional.
Escena asignada actualmente a Preview. Opcional.
Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado. Opcional.
Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado. Opcional.
Objeto de estado guardado del mezclador de audio. Opcional.
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"
}'Identificador del mezclador.
Nombre legible del mezclador.
Visibilidad de acceso guardada: PRIVATE o PUBLIC.
Indica si el mezclador guardado está habilitado para operar.
Indica si el mezclador está activo en este momento.
Estado persistido del ciclo de vida del mezclador.
Identificador del motor asignado, cuando existe.
Escena asignada actualmente a Program.
Escena asignada actualmente a Preview.
Nombre del ajuste predefinido de diseño guardado.
Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado.
Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado.
Definiciones de entradas que se almacenarán con el mezclador.
Definiciones de escenas que se almacenarán con el mezclador.
Definiciones de salidas que se almacenarán con el mezclador.
Objeto de estado guardado del mezclador de audio.
Ajustes predefinidos de sincronización guardados.
Objeto del estado actual o guardado del motor, cuando se devuelve.
Objeto del estado actual o guardado de la grabación, cuando se devuelve.
Marca de tiempo de creación proporcionada por el servicio.
Marca de tiempo de la última modificación proporcionada por el servicio.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Lee un mezclador disponible para el propietario autenticado.
Correcto
Devuelve 201 con el objeto de mezclador. El ejemplo de respuesta mostrado es ilustrativo; usa solo los campos declarados en la tabla de respuesta.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
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>"
}'Identificador del mezclador.
Nombre legible del mezclador.
Visibilidad de acceso guardada: PRIVATE o PUBLIC.
Indica si el mezclador guardado está habilitado para operar.
Indica si el mezclador está activo en este momento.
Estado persistido del ciclo de vida del mezclador.
Identificador del motor asignado, cuando existe.
Escena asignada actualmente a Program.
Escena asignada actualmente a Preview.
Nombre del ajuste predefinido de diseño guardado.
Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado.
Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado.
Definiciones de entradas que se almacenarán con el mezclador.
Definiciones de escenas que se almacenarán con el mezclador.
Definiciones de salidas que se almacenarán con el mezclador.
Objeto de estado guardado del mezclador de audio.
Ajustes predefinidos de sincronización guardados.
Objeto del estado actual o guardado del motor, cuando se devuelve.
Objeto del estado actual o guardado de la grabación, cuando se devuelve.
Marca de tiempo de creación proporcionada por el servicio.
Marca de tiempo de la última modificación proporcionada por el servicio.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Enumera los registros de mezcladores disponibles para el propietario autenticado. Usa limit y skip para paginar.
Correcto
Devuelve 201 con el objeto de resultado documentado del endpoint. El ejemplo de respuesta mostrado es ilustrativo; usa solo los campos declarados en la tabla de respuesta.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Número máximo de registros de mezcladores que se devolverán. Opcional.
Número de registros que se omitirán antes de devolver resultados. Opcional.
Especificación de ordenación para la lista de mezcladores. Opcional.
Especificación de filtro para la lista de mezcladores. Opcional.
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"
}
]Devuelve el número de registros visibles para el propietario que coinciden con un filtro opcional.
Correcto
Devuelve 201 con el objeto de resultado documentado del endpoint. El ejemplo de respuesta mostrado es ilustrativo; usa solo los campos declarados en la tabla de respuesta.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Especificación de filtro para la lista de mezcladores. Opcional.
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": {}
}'Número de registros que coinciden con la solicitud.
{
"count": 1
}Actualiza la configuración persistida. Usa take, en lugar de esta ruta, para llevar la vista previa a Program.
Objetos de configuración
| Campo | Uso |
|---|---|
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. |
canvas_settings, performance_settings, audio_mixer_state | Estos 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.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Nombre legible del mezclador. Obligatorio.
Visibilidad de acceso guardada: PRIVATE o PUBLIC. Opcional.
Indica si el mezclador guardado está habilitado para operar. Opcional.
Definiciones de entradas que se almacenarán con el mezclador. Opcional.
Definiciones de escenas que se almacenarán con el mezclador. Opcional.
Definiciones de salidas que se almacenarán con el mezclador. Opcional.
Escena asignada actualmente a Program. Opcional.
Escena asignada actualmente a Preview. Opcional.
Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado. Opcional.
Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado. Opcional.
Objeto de estado guardado del mezclador de audio. Opcional.
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"
}'Identificador del mezclador.
Nombre legible del mezclador.
Visibilidad de acceso guardada: PRIVATE o PUBLIC.
Indica si el mezclador guardado está habilitado para operar.
Indica si el mezclador está activo en este momento.
Estado persistido del ciclo de vida del mezclador.
Identificador del motor asignado, cuando existe.
Escena asignada actualmente a Program.
Escena asignada actualmente a Preview.
Nombre del ajuste predefinido de diseño guardado.
Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado.
Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado.
Definiciones de entradas que se almacenarán con el mezclador.
Definiciones de escenas que se almacenarán con el mezclador.
Definiciones de salidas que se almacenarán con el mezclador.
Objeto de estado guardado del mezclador de audio.
Ajustes predefinidos de sincronización guardados.
Objeto del estado actual o guardado del motor, cuando se devuelve.
Objeto del estado actual o guardado de la grabación, cuando se devuelve.
Marca de tiempo de creación proporcionada por el servicio.
Marca de tiempo de la última modificación proporcionada por el servicio.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Activa un mezclador guardado para su funcionamiento.
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.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
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>"
}'Identificador del mezclador.
Nombre legible del mezclador.
Visibilidad de acceso guardada: PRIVATE o PUBLIC.
Indica si el mezclador guardado está habilitado para operar.
Indica si el mezclador está activo en este momento.
Estado persistido del ciclo de vida del mezclador.
Identificador del motor asignado, cuando existe.
Escena asignada actualmente a Program.
Escena asignada actualmente a Preview.
Nombre del ajuste predefinido de diseño guardado.
Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado.
Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado.
Definiciones de entradas que se almacenarán con el mezclador.
Definiciones de escenas que se almacenarán con el mezclador.
Definiciones de salidas que se almacenarán con el mezclador.
Objeto de estado guardado del mezclador de audio.
Ajustes predefinidos de sincronización guardados.
Objeto del estado actual o guardado del motor, cuando se devuelve.
Objeto del estado actual o guardado de la grabación, cuando se devuelve.
Marca de tiempo de creación proporcionada por el servicio.
Marca de tiempo de la última modificación proporcionada por el servicio.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Desactiva un mezclador guardado; el servicio detiene y libera los recursos multimedia que posee.
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.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
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>"
}'Identificador del mezclador.
Nombre legible del mezclador.
Visibilidad de acceso guardada: PRIVATE o PUBLIC.
Indica si el mezclador guardado está habilitado para operar.
Indica si el mezclador está activo en este momento.
Estado persistido del ciclo de vida del mezclador.
Identificador del motor asignado, cuando existe.
Escena asignada actualmente a Program.
Escena asignada actualmente a Preview.
Nombre del ajuste predefinido de diseño guardado.
Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado.
Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado.
Definiciones de entradas que se almacenarán con el mezclador.
Definiciones de escenas que se almacenarán con el mezclador.
Definiciones de salidas que se almacenarán con el mezclador.
Objeto de estado guardado del mezclador de audio.
Ajustes predefinidos de sincronización guardados.
Objeto del estado actual o guardado del motor, cuando se devuelve.
Objeto del estado actual o guardado de la grabación, cuando se devuelve.
Marca de tiempo de creación proporcionada por el servicio.
Marca de tiempo de la última modificación proporcionada por el servicio.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Elimina un mezclador por identificador después de que el servicio delimite la limpieza de sus recursos multimedia.
Correcto
Devuelve 201 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Aplica o conserva el estado focalizado proporcionado. Establecer preview_scene_id con prepare_engine prepara la vista previa; por sí solo no lleva Program.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Objetos de configuración
| Campo | Uso |
|---|---|
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. |
canvas_settings, performance_settings, audio_mixer_state | Estos 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.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Indica si se sincronizará el motor al aplicar este estado. Opcional.
Indica si se preparará el motor al aplicar este estado. Opcional.
Escena asignada actualmente a Program. Opcional.
Escena asignada actualmente a Preview. Opcional.
Definiciones de entradas que se almacenarán con el mezclador. Opcional.
Definiciones de escenas que se almacenarán con el mezclador. Opcional.
Definiciones de salidas que se almacenarán con el mezclador. Opcional.
Objeto de estado guardado del mezclador de audio. Opcional.
Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado. Opcional.
Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado. Opcional.
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
}'Identificador del mezclador.
Nombre legible del mezclador.
Visibilidad de acceso guardada: PRIVATE o PUBLIC.
Indica si el mezclador guardado está habilitado para operar.
Indica si el mezclador está activo en este momento.
Estado persistido del ciclo de vida del mezclador.
Identificador del motor asignado, cuando existe.
Escena asignada actualmente a Program.
Escena asignada actualmente a Preview.
Nombre del ajuste predefinido de diseño guardado.
Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado.
Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado.
Definiciones de entradas que se almacenarán con el mezclador.
Definiciones de escenas que se almacenarán con el mezclador.
Definiciones de salidas que se almacenarán con el mezclador.
Objeto de estado guardado del mezclador de audio.
Ajustes predefinidos de sincronización guardados.
Objeto del estado actual o guardado del motor, cuando se devuelve.
Objeto del estado actual o guardado de la grabación, cuando se devuelve.
Marca de tiempo de creación proporcionada por el servicio.
Marca de tiempo de la última modificación proporcionada por el servicio.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Inicia Program desde la vista previa configurada. El mezclador debe estar habilitado y la escena debe tener una capa de vídeo configurada.
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.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
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>"
}'Identificador del mezclador.
Nombre legible del mezclador.
Visibilidad de acceso guardada: PRIVATE o PUBLIC.
Indica si el mezclador guardado está habilitado para operar.
Indica si el mezclador está activo en este momento.
Estado persistido del ciclo de vida del mezclador.
Identificador del motor asignado, cuando existe.
Escena asignada actualmente a Program.
Escena asignada actualmente a Preview.
Nombre del ajuste predefinido de diseño guardado.
Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado.
Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado.
Definiciones de entradas que se almacenarán con el mezclador.
Definiciones de escenas que se almacenarán con el mezclador.
Definiciones de salidas que se almacenarán con el mezclador.
Objeto de estado guardado del mezclador de audio.
Ajustes predefinidos de sincronización guardados.
Objeto del estado actual o guardado del motor, cuando se devuelve.
Objeto del estado actual o guardado de la grabación, cuando se devuelve.
Marca de tiempo de creación proporcionada por el servicio.
Marca de tiempo de la última modificación proporcionada por el servicio.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Mueve la escena de vista previa preparada a Program. CUT es inmediato; FADE usa duration_ms.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Objetos de configuración
| Campo | Uso |
|---|---|
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. |
canvas_settings, performance_settings, audio_mixer_state | Estos 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.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Identificador de la escena de destino. Opcional.
Transición de Program: CUT cambia de inmediato; FADE usa duration_ms. Opcional.
Duración de la transición en milisegundos; debe ser cero o mayor. Opcional.
Escena asignada actualmente a Preview. Opcional.
Definiciones de escenas que se almacenarán con el mezclador. Opcional.
Definiciones de entradas que se almacenarán con el mezclador. Opcional.
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"
}'Identificador del mezclador.
Nombre legible del mezclador.
Visibilidad de acceso guardada: PRIVATE o PUBLIC.
Indica si el mezclador guardado está habilitado para operar.
Indica si el mezclador está activo en este momento.
Estado persistido del ciclo de vida del mezclador.
Identificador del motor asignado, cuando existe.
Escena asignada actualmente a Program.
Escena asignada actualmente a Preview.
Nombre del ajuste predefinido de diseño guardado.
Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado.
Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado.
Definiciones de entradas que se almacenarán con el mezclador.
Definiciones de escenas que se almacenarán con el mezclador.
Definiciones de salidas que se almacenarán con el mezclador.
Objeto de estado guardado del mezclador de audio.
Ajustes predefinidos de sincronización guardados.
Objeto del estado actual o guardado del motor, cuando se devuelve.
Objeto del estado actual o guardado de la grabación, cuando se devuelve.
Marca de tiempo de creación proporcionada por el servicio.
Marca de tiempo de la última modificación proporcionada por el servicio.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Detiene Program y finaliza los recursos de tiempo de ejecución, entrada, grabación y monitor que posee.
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.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
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>"
}'Identificador del mezclador.
Nombre legible del mezclador.
Visibilidad de acceso guardada: PRIVATE o PUBLIC.
Indica si el mezclador guardado está habilitado para operar.
Indica si el mezclador está activo en este momento.
Estado persistido del ciclo de vida del mezclador.
Identificador del motor asignado, cuando existe.
Escena asignada actualmente a Program.
Escena asignada actualmente a Preview.
Nombre del ajuste predefinido de diseño guardado.
Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado.
Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado.
Definiciones de entradas que se almacenarán con el mezclador.
Definiciones de escenas que se almacenarán con el mezclador.
Definiciones de salidas que se almacenarán con el mezclador.
Objeto de estado guardado del mezclador de audio.
Ajustes predefinidos de sincronización guardados.
Objeto del estado actual o guardado del motor, cuando se devuelve.
Objeto del estado actual o guardado de la grabación, cuando se devuelve.
Marca de tiempo de creación proporcionada por el servicio.
Marca de tiempo de la última modificación proporcionada por el servicio.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Controla una fuente de archivo en la vista previa preparada. Esta ruta no modifica Program.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Identificador de la escena de destino. Obligatorio.
Identificador de la fuente de destino. Obligatorio.
Posición de reproducción en milisegundos; debe ser cero o mayor. Opcional.
Indica si la fuente de archivo de Preview de destino está en pausa. Opcional.
Generación de control de Preview utilizada para rechazar controles obsoletos. Opcional.
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
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Solicita el análisis de fuentes publicado. La configuración de actualización exclusiva del panel no forma parte de este contrato de solicitud.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Enumera las salas, participantes y pistas de videollamada que se pueden seleccionar como entradas del mezclador.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Prepara o actualiza una entrada sin modificar Program.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
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.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Identificador de la entrada del mezclador de destino. Opcional.
Identificador de la fuente de destino. Opcional.
Identidad de participante que se asociará con una entrada. Opcional.
Nombre de la sala de videollamada que se asociará con una entrada. Opcional.
Indica si se reiniciará un trabajador de entrada ya preparado. Opcional.
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>"
}'Identificador del mezclador.
Nombre legible del mezclador.
Visibilidad de acceso guardada: PRIVATE o PUBLIC.
Indica si el mezclador guardado está habilitado para operar.
Indica si el mezclador está activo en este momento.
Estado persistido del ciclo de vida del mezclador.
Identificador del motor asignado, cuando existe.
Escena asignada actualmente a Program.
Escena asignada actualmente a Preview.
Nombre del ajuste predefinido de diseño guardado.
Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado.
Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado.
Definiciones de entradas que se almacenarán con el mezclador.
Definiciones de escenas que se almacenarán con el mezclador.
Definiciones de salidas que se almacenarán con el mezclador.
Objeto de estado guardado del mezclador de audio.
Ajustes predefinidos de sincronización guardados.
Objeto del estado actual o guardado del motor, cuando se devuelve.
Objeto del estado actual o guardado de la grabación, cuando se devuelve.
Marca de tiempo de creación proporcionada por el servicio.
Marca de tiempo de la última modificación proporcionada por el servicio.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Solicita información de temporización de una fuente o capa antes de realizar tareas de alineación.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Identificador de la capa de escena de destino. Opcional.
Identificador de la fuente de destino. Opcional.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Solicita un token de navegador de corta duración. No expongas nunca un token devuelto en ejemplos, control de código fuente ni registros.
Control de sesión única
Para un mezclador de sesión única, una solicitud de token distinta de subscribe_only: true requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Correcto
Devuelve 201 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Identificador opcional de participante para un token de navegador. Opcional.
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
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Solicita un token de corta duración para la conferencia de videollamada especificada. Trata las credenciales devueltas como secretos.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Correcto
Devuelve 201 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Identificador de la conferencia de videollamada. Obligatorio.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Crea una invitación de publicación desde teléfono para PREVIEW o LIBRARY. El token de invitación, la ruta del publicador y la URL de publicación son credenciales.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Correcto
Devuelve 201 con el objeto de sesión de publicación desde teléfono; trata los valores de invitación y publicación como secretos. El ejemplo de respuesta mostrado es ilustrativo; usa solo los campos declarados en la tabla de respuesta.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Identificador de operación de publicación desde teléfono proporcionado por quien llama o devuelto. Opcional.
Objetivo de control seleccionado por el endpoint. Opcional.
Identificador de la escena de destino. Opcional.
Indica si la sesión de publicación desde teléfono debe tomar su objetivo automáticamente. Opcional.
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
}'Es true cuando la operación se completó correctamente.
Identificador de operación de publicación desde teléfono proporcionado por quien llama o devuelto.
Token opaco de invitación para publicación desde teléfono. Trátelo como secreto.
Indica si la invitación de teléfono devuelta permanece persistente.
Ámbito de la sesión de publicación desde teléfono devuelta.
Ruta de publicación devuelta para la sesión de publicación desde teléfono.
Nombre visible asignado al participante de teléfono.
Identidad de participante que se asociará con una entrada.
Identificador de la entrada del mezclador de destino.
Objetivo de control seleccionado por el endpoint.
Identificador de la escena de destino.
Indica si la sesión de publicación desde teléfono debe tomar su objetivo automáticamente.
Objeto de mezclador asociado con la sesión de publicación desde teléfono.
URL de publicación devuelta por la sesión de publicación desde teléfono. Trátela como información sensible.
{
"success": true,
"operation_id": "<operation_id>",
"invite_token": "<one_time_invite_token>"
}Cancela la operación de publicación desde teléfono indicada. El servicio puede informar que la cancelación ya está en curso o ha finalizado.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Identificador de operación de publicación desde teléfono proporcionado por quien llama o devuelto. Obligatorio.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Lee los datos actuales de los medidores de audio.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Configura el enrutamiento de salida del monitor y la suspensión opcional del monitor.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Estructura de la ruta de audio
| Objeto | Campos |
|---|---|
routes[] | Cada ruta requiere channel_id y source_id; también puede incluir gain, muted, pan, delay_ms, y buffer_ms. |
master | Configuración de ganancia/silencio maestra cuando la admita el método seleccionado. |
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Identificador de la salida del mezclador de destino. Opcional.
Indica si la salida de monitor está suspendida. Opcional.
Indica si se aplicará la configuración de monitor a la salida seleccionada. Opcional.
Definiciones de rutas de audio. Cada ruta identifica un canal y una fuente. Opcional.
Objeto de configuración de audio maestro. Opcional.
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
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Aplica los valores de ruta de monitor y volumen maestro.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Estructura de la ruta de audio
| Objeto | Campos |
|---|---|
routes[] | Cada ruta requiere channel_id y source_id; también puede incluir gain, muted, pan, delay_ms, y buffer_ms. |
master | Configuración de ganancia/silencio maestra cuando la admita el método seleccionado. |
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Identificador de la salida del mezclador de destino. Opcional.
Indica si la salida de monitor está suspendida. Opcional.
Indica si se aplicará la configuración de monitor a la salida seleccionada. Opcional.
Definiciones de rutas de audio. Cada ruta identifica un canal y una fuente. Opcional.
Objeto de configuración de audio maestro. Opcional.
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
}
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Aplica el estado de mezclador de audio proporcionado al grafo de Program.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Objeto de estado guardado del mezclador de audio. Opcional.
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": {}
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Establece el estado de publicación de una salida sin reemplazar el resto de la configuración del mezclador.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Identificador de la salida del mezclador de destino. Obligatorio.
Indica si el mezclador guardado está habilitado para operar. Obligatorio.
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
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Inicia la grabación de Program o de la salida seleccionada.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Correcto
Devuelve 201 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Identificador de la salida del mezclador de destino. Opcional.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Detiene y finaliza la grabación de Program o de la salida seleccionada.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Correcto
Devuelve 201 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Identificador de la salida del mezclador de destino. Opcional.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Lee la información de tiempo de ejecución visible para el propietario.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Lee las estadísticas del mezclador visibles para el propietario.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Solicita el restablecimiento de una cámara; una etiqueta puede identificar el destino.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Etiqueta opcional para el restablecimiento de cámara. Opcional.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Solicita la activación de la fuente conectada a la entrada de mezclador indicada.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Identificador de la entrada del mezclador de destino. Obligatorio.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Indica al motor qué entradas existentes requieren actualmente sus fuentes. input_ids debe contener identificadores de entrada reales.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Lista no vacía de identificadores de entradas del mezclador que actualmente requieren sus fuentes. Obligatorio.
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>"
]
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Elimina el archivo indicado de un proyecto de mezclador.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Identificador del archivo de proyecto que se eliminará. Obligatorio.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Lee las entradas recientes del registro de audio.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador para consultar entradas del registro de audio. Obligatorio.
Número máximo de entradas recientes que se devolverán; debe ser al menos 1. Opcional.
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>'Es true cuando la operación se completó correctamente.
{
"success": true
}Lee las entradas recientes del registro de audio mediante una solicitud JSON.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Número máximo de entradas recientes del registro que se devolverán; debe ser al menos 1. Opcional.
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
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Lee las entradas recientes del registro de audio mediante el alias de registro de audio.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador para consultar entradas del registro de audio. Obligatorio.
Número máximo de entradas recientes que se devolverán; debe ser al menos 1. Opcional.
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>'Es true cuando la operación se completó correctamente.
{
"success": true
}Lee las entradas recientes del registro de audio mediante el alias de registro de audio.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
Número máximo de entradas recientes del registro que se devolverán; debe ser al menos 1. Opcional.
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
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Borra las entradas del registro de audio.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Borra las entradas del registro de audio mediante el alias de registro de audio.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Lee el resultado del registro de solicitudes del mezclador.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador. Obligatorio.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Registra un evento de cliente conciso autenticado por el propietario. detail está limitado a 256 caracteres.
Control de sesión única
Para un mezclador de sesión única, esta mutación del propietario requiere el arrendamiento de operador configurado: envía x-av-mixer-session y el actual x-av-mixer-control-epoch con autenticación de propietario. Un arrendamiento ausente o vencido puede devolver 423 AV_MIXER_VIEW_ONLY. La API publicada no expone los endpoints para reclamar el arrendamiento. Un mezclador persistido de varias sesiones no requiere cabeceras de arrendamiento del cliente.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Revisa Autorización antes de enviar solicitudes del propietario. Para las operaciones del ciclo de vida y las escenas del mezclador, continúa con el método relacionado de esta referencia de AV Mixer.
Identificador del mezclador asociado al evento del cliente. Obligatorio.
Nombre del evento del cliente. Obligatorio.
Detalle opcional del evento, limitado a 256 caracteres. Opcional.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Lee el estado filtrado por visibilidad de un mezclador PUBLIC.
Límite de acceso público
Esta ruta de lectura no tiene cabecera de clave de API del propietario. Requiere visibilidad PUBLIC y un mezclador habilitado; los permisos de control público guardados no condicionan esta lectura.
Correcto
Devuelve 200 con el objeto de mezclador. El ejemplo de respuesta mostrado es ilustrativo; usa solo los campos declarados en la tabla de respuesta.
Siguientes pasos
Verifica la visibilidad PUBLIC y el estado habilitado del mezclador antes de hacer esta solicitud de lectura pública.
Identificador del mezclador. Obligatorio.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers-public/getById' \
--header 'Content-Type: application/json' \
--data '{
"id": "<public_mixer_id>"
}'Identificador del mezclador.
Nombre legible del mezclador.
Visibilidad de acceso guardada: PRIVATE o PUBLIC.
Indica si el mezclador guardado está habilitado para operar.
Indica si el mezclador está activo en este momento.
Estado persistido del ciclo de vida del mezclador.
Identificador del motor asignado, cuando existe.
Escena asignada actualmente a Program.
Escena asignada actualmente a Preview.
Nombre del ajuste predefinido de diseño guardado.
Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado.
Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado.
Definiciones de entradas que se almacenarán con el mezclador.
Definiciones de escenas que se almacenarán con el mezclador.
Definiciones de salidas que se almacenarán con el mezclador.
Objeto de estado guardado del mezclador de audio.
Ajustes predefinidos de sincronización guardados.
Objeto del estado actual o guardado del motor, cuando se devuelve.
Objeto del estado actual o guardado de la grabación, cuando se devuelve.
Marca de tiempo de creación proporcionada por el servicio.
Marca de tiempo de la última modificación proporcionada por el servicio.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Canjea una invitación opaca de publicación desde teléfono. El token de invitación es la credencial de esta solicitud; no lo conserves en documentación ni registros. Esta ruta no utiliza una cabecera de clave de API del propietario.
Correcto
Devuelve 201 con el objeto de resultado documentado del extremo. OperationResult permanece abierto más allá de su indicador success documentado; no dependas de propiedades no declaradas. El ejemplo de respuesta es ilustrativo.
Siguientes pasos
Usa un token de invitación nuevo solo para su sesión prevista. Mantén las credenciales devueltas fuera de los registros y del control de código fuente.
Token opaco de invitación para publicación desde teléfono. Trátelo como secreto. Obligatorio.
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>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Lee la información de tiempo de ejecución filtrada por visibilidad de un mezclador PUBLIC.
Límite de acceso público
Esta ruta de lectura no tiene cabecera de clave de API del propietario. Requiere visibilidad PUBLIC y un mezclador habilitado; los permisos de control público guardados no condicionan esta lectura.
Correcto
Devuelve 200 con el objeto de resultado documentado del endpoint. OperationResult se mantiene intencionadamente abierto más allá de su indicador documentado success; no dependas de propiedades de respuesta no declaradas. El ejemplo de respuesta mostrado es ilustrativo.
Siguientes pasos
Verifica la visibilidad PUBLIC y el estado habilitado del mezclador antes de hacer esta solicitud de lectura pública.
Identificador del mezclador. Obligatorio.
curl --request POST \
--url 'https://your-callaba-server.example/api/av-mixers-public/runtime' \
--header 'Content-Type: application/json' \
--data '{
"id": "<public_mixer_id>"
}'Es true cuando la operación se completó correctamente.
{
"success": true
}Lleva la escena indicada solo cuando el permiso público guardado del mezclador permite cambiar escenas.
Límite de acceso público
Esta ruta no tiene cabecera de clave de API del propietario, pero no es administración abierta. Se evalúa según la visibilidad PUBLIC del mezclador, su estado habilitado y los permisos públicos guardados para la acción solicitada.
Correcto
Devuelve 200 con el objeto de mezclador actualizado. El ejemplo de respuesta mostrado es ilustrativo; usa solo los campos declarados en la tabla de respuesta.
Siguientes pasos
Verifica la visibilidad PUBLIC, el estado habilitado y el permiso guardado del mezclador para esta acción antes de hacer una solicitud pública.
Identificador del mezclador. Obligatorio.
Identificador de la escena de destino. Obligatorio.
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>"
}'Identificador del mezclador.
Nombre legible del mezclador.
Visibilidad de acceso guardada: PRIVATE o PUBLIC.
Indica si el mezclador guardado está habilitado para operar.
Indica si el mezclador está activo en este momento.
Estado persistido del ciclo de vida del mezclador.
Identificador del motor asignado, cuando existe.
Escena asignada actualmente a Program.
Escena asignada actualmente a Preview.
Nombre del ajuste predefinido de diseño guardado.
Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado.
Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado.
Definiciones de entradas que se almacenarán con el mezclador.
Definiciones de escenas que se almacenarán con el mezclador.
Definiciones de salidas que se almacenarán con el mezclador.
Objeto de estado guardado del mezclador de audio.
Ajustes predefinidos de sincronización guardados.
Objeto del estado actual o guardado del motor, cuando se devuelve.
Objeto del estado actual o guardado de la grabación, cuando se devuelve.
Marca de tiempo de creación proporcionada por el servicio.
Marca de tiempo de la última modificación proporcionada por el servicio.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}Cambia una propiedad de entrada, salida, audio o transición solo cuando el permiso público guardado permite esa categoría.
Límite de acceso público
Esta ruta no tiene cabecera de clave de API del propietario, pero no es administración abierta. Se evalúa según la visibilidad PUBLIC del mezclador, su estado habilitado y los permisos públicos guardados para la acción solicitada.
Correcto
Devuelve 200 con el objeto de mezclador actualizado. El ejemplo de respuesta mostrado es ilustrativo; usa solo los campos declarados en la tabla de respuesta.
Siguientes pasos
Verifica la visibilidad PUBLIC, el estado habilitado y el permiso guardado del mezclador para esta acción antes de hacer una solicitud pública.
Identificador del mezclador. Obligatorio.
Categoría de control público permitida por el conjunto de permisos guardado. Obligatorio.
Identificador de la escena de destino. Opcional.
Identificador de la capa de escena de destino. Opcional.
Identificador de la salida del mezclador de destino. Opcional.
Identificador del canal de audio de destino. Opcional.
Objetivo de control seleccionado por el endpoint. Opcional.
Visibilidad solicitada para la capa de entrada de destino. Opcional.
Opacidad solicitada para la capa de entrada de destino. Opcional.
Indica si el mezclador guardado está habilitado para operar. Opcional.
Estado de silenciamiento solicitado. Opcional.
Ganancia de audio solicitada. Opcional.
Transición de Program: CUT cambia de inmediato; FADE usa duration_ms. Opcional.
Duración de la transición en milisegundos; debe ser cero o mayor. Opcional.
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
}'Identificador del mezclador.
Nombre legible del mezclador.
Visibilidad de acceso guardada: PRIVATE o PUBLIC.
Indica si el mezclador guardado está habilitado para operar.
Indica si el mezclador está activo en este momento.
Estado persistido del ciclo de vida del mezclador.
Identificador del motor asignado, cuando existe.
Escena asignada actualmente a Program.
Escena asignada actualmente a Preview.
Nombre del ajuste predefinido de diseño guardado.
Objeto de configuración del lienzo; use solo los campos admitidos por el esquema publicado.
Objeto de configuración de rendimiento; use solo los campos admitidos por el esquema publicado.
Definiciones de entradas que se almacenarán con el mezclador.
Definiciones de escenas que se almacenarán con el mezclador.
Definiciones de salidas que se almacenarán con el mezclador.
Objeto de estado guardado del mezclador de audio.
Ajustes predefinidos de sincronización guardados.
Objeto del estado actual o guardado del motor, cuando se devuelve.
Objeto del estado actual o guardado de la grabación, cuando se devuelve.
Marca de tiempo de creación proporcionada por el servicio.
Marca de tiempo de la última modificación proporcionada por el servicio.
{
"id": "64f1c2e77393ab0012345678",
"name": "Studio mixer"
}