Multiview

Multiview reúne varias entradas SRT, RTMP o NDI en un multiviewer para el navegador. Supervisa en una sola pantalla las señales principal, de respaldo, de programa y de retorno.

Qué haceCrear un Multiview para operadores

Elige este módulo cuandoLos operadores necesitan una sola pared en el navegador para varias señales SRT, RTMP o NDI.

Usa otro módulo cuandoUsa Reproductores web para la audiencia; Multiview es la superficie de supervisión de operadores.

1Añade entradas2Organiza el layout3Abre Multiview

POST /api/multiview/create

Filtrar endpoints12 endpoints

Antes de empezar

Usa x-access-token para configurar, iniciar y detener Multiview y para crear sesiones autenticadas de espectadores. Si visibility es PUBLIC, cualquier persona que conozca el ID puede usar los métodos públicos de visualización, estadísticas y acceso; comparte el ID únicamente con la audiencia prevista.

Qué puedes hacer

create guarda Multiview, el layout, la visibilidad y las entradas iniciales; se admite una lista de entradas vacía.
update aplica la lista completa de entradas y el layout deseados.
getAll, getCount y getById consultan las vistas guardadas.
start y stop controlan el proceso de supervisión.
join devuelve los datos de sesión del navegador para un espectador autorizado.
remove elimina Multiview.

Flujo de ejemplo

Crea un Multiview privado con el layout necesario; al principio la lista de entradas puede estar vacía.
Actualízalo con el conjunto completo de entradas SRT, RTMP o NDI.
Inicia Multiview y llama al método autenticado join.
Abre la sesión de visualización devuelta y comprueba el estado en directo de cada entrada.
En las actualizaciones posteriores, envía siempre la lista completa; las entradas omitidas se desvinculan.

Casos de uso habituales

Supervisar las señales principal y de respaldo en una sala de control.
Dar a un productor remoto una vista única de cámaras, salida de programa y señales de retorno.
Comparar salidas regionales o por idioma antes de distribuirlas.

Límites y resolución de problemas

Corrige nombres, IDs de entrada, visibilidad o datos de participantes que falten o no sean válidos antes de repetir la solicitud. Multiview puede seguir disponible aunque una entrada esté offline; comprueba por separado el estado en directo de cada entrada.

Siguientes pasos

Conecta las señales previstas, valida la experiencia de acceso y habilita el acceso público solo cuando Multiview deba compartirse.

POST

/api/multiview/create

Requiere token de API

Crea un Multiview y, salvo que active sea false, inicia sus entradas y la conferencia. El usuario se obtiene del token de API; no envíes user_id.

Siguiente llamada: usa getById para consultar las entradas guardadas y después join para emitir un token de operador.

Los errores de validación devuelven { success: false, status, code, message, details } con estado 400.

Parámetros del cuerpo de la solicitud

Identidad

name

string

Nombre obligatorio que se muestra a los operadores, de 1–120 caracteres.

Layout

layout_id

string

Identificador opcional de la disposición. Callaba Engine usa 4-tiles de forma predeterminada.

overlay_settings

object

Configuración opcional de superposición que se guarda con el muro de vídeo.

Entradas

inputs

array

Definiciones opcionales de las entradas. Los tipos de fuente admitidos en ejecución incluyen variantes SRT, RTMP y NDI; usa una matriz vacía si quieres crear el muro de vídeo antes de conectar las señales.

Acceso

visibility

string

Valor opcional: PRIVATE o PUBLIC. El valor predeterminado es PRIVATE.

Runtime

active

boolean

Estado inicial de ejecución opcional. Se considera activo salvo que se establezca explícitamente en false.

Crear Multiview

Respuesta

Identidad

string

Identificador estable del recurso de multiview.

name

string

Nombre que se muestra al operador.

Layout

layout_id

string

Disposición de mosaicos seleccionada, por ejemplo 4-tiles.

inputs

array

Entradas de vídeo normalizadas y sus vinculaciones en ejecución.

Acceso

visibility

string

PRIVATE o PUBLIC.

Runtime

conference_id

string

Conferencia que proporciona la vista utilizada por el operador.

active

boolean

Indica si la instancia de multiview debe estar activa.

Respuesta: Crear Multiview

JSON

{
  "_id": "6b0011223344556677889900",
  "id": "6b0011223344556677889900",
  "name": "Master control multiview",
  "conference_id": "6b1011223344556677889900",
  "layout_id": "4-tiles",
  "visibility": "PRIVATE",
  "overlay_settings": {},
  "inputs": [
    {
      "id": "camera-a",
      "name": "Camera A",
      "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
      "source_id": "6b2011223344556677889900",
      "participant_name": "Camera A",
      "resolution": "1920x1080",
      "video_codec": "libx264",
      "video_bitrate": 1350,
      "tile_index": 0,
      "muted": false,
      "hidden": false,
      "volume": 1
    }
  ],
  "active": true,
  "created": "2026-06-25T10:00:00.000Z",
  "modified": "2026-06-25T10:00:01.000Z",
  "success": true
}

POST

/api/multiview/update

Requiere token de API

Actualiza el estado completo de un Multiview. Callaba aplica la nueva lista de entradas y desvincula las que ya no aparecen; consulta el objeto actual antes de sustituir una lista no vacía.

El ámbito del usuario se obtiene del token. Los IDs desconocidos y los campos de entrada no válidos devuelven el objeto de error 400 habitual.

Parámetros del cuerpo de la solicitud

Recurso

string

Identificador del recurso de multiview.

Identidad

name

string

Nuevo nombre obligatorio del recurso.

Layout

layout_id

string

Nuevo identificador de la disposición.

overlay_settings

object

Nueva configuración de superposición.

Entradas

inputs

array

Lista completa de entradas deseadas. El servicio elimina los restreams en ejecución que ya no aparecen en la nueva lista.

Acceso

visibility

string

PRIVATE o PUBLIC.

Runtime

active

boolean

Nuevo estado activo del recurso.

Actualizar Multiview

curl --request POST \
  --url http://localhost/api/multiview/update \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "MULTIVIEW_ID",
  "name": "Master control multiview",
  "layout_id": "4-tiles",
  "visibility": "PRIVATE",
  "overlay_settings": {},
  "inputs": [
    {
      "id": "camera-a",
      "name": "Camera A",
      "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
      "source_id": "SRT_SERVER_ID",
      "participant_name": "Camera A",
      "resolution": "1920x1080",
      "video_codec": "libx264",
      "video_bitrate": 1350,
      "tile_index": 0
    }
  ],
  "active": true
}'

Respuesta

Identidad

string

Identificador estable del recurso de multiview.

name

string

Nombre que se muestra al operador.

Layout

layout_id

string

Disposición de mosaicos seleccionada, por ejemplo 4-tiles.

inputs

array

Entradas de vídeo normalizadas y sus vinculaciones en ejecución.

Acceso

visibility

string

PRIVATE o PUBLIC.

Runtime

conference_id

string

Conferencia que proporciona la vista utilizada por el operador.

active

boolean

Indica si la instancia de multiview debe estar activa.

Respuesta: Actualizar Multiview

JSON

{
  "_id": "6b0011223344556677889900",
  "id": "6b0011223344556677889900",
  "name": "Master control multiview",
  "conference_id": "6b1011223344556677889900",
  "layout_id": "4-tiles",
  "visibility": "PRIVATE",
  "overlay_settings": {},
  "inputs": [
    {
      "id": "camera-a",
      "name": "Camera A",
      "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
      "source_id": "6b2011223344556677889900",
      "participant_name": "Camera A",
      "resolution": "1920x1080",
      "video_codec": "libx264",
      "video_bitrate": 1350,
      "tile_index": 0,
      "muted": false,
      "hidden": false,
      "volume": 1
    }
  ],
  "active": true,
  "created": "2026-06-25T10:00:00.000Z",
  "modified": "2026-06-25T10:00:01.000Z",
  "success": true
}

POST

/api/multiview/getCount

Requiere token de API

POST

/api/multiview/getAll

Requiere token de API

Lista los Multiview del usuario autenticado con paginación, ordenación y filtros opcionales. La respuesta es una matriz sin objeto contenedor.

Usa getById antes de actualizar o abrir una sesión en un recurso concreto.

Parámetros del cuerpo de la solicitud

Paginación

limit

number

Número máximo opcional de filas que se devolverán.

skip

number

Número opcional de filas que se omitirán.

Ordenación

sort

object

Objeto de ordenación opcional; de forma predeterminada se ordena por fecha de creación ascendente.

Filtros

filter

object

Filtro opcional que siempre se combina con el ámbito del usuario autenticado.

Listar vistas Multiview

Respuesta

Resultado

[]

array

Matriz de recursos de multiview.

Identidad

string

Identificador estable del recurso de multiview.

name

string

Nombre que se muestra al operador.

Layout

layout_id

string

Disposición de mosaicos seleccionada, por ejemplo 4-tiles.

inputs

array

Entradas de vídeo normalizadas y sus vinculaciones en ejecución.

Acceso

visibility

string

PRIVATE o PUBLIC.

Runtime

conference_id

string

Conferencia que proporciona la vista utilizada por el operador.

active

boolean

Indica si la instancia de multiview debe estar activa.

Respuesta: Listar vistas Multiview

JSON

[
  {
    "_id": "6b0011223344556677889900",
    "id": "6b0011223344556677889900",
    "name": "Master control multiview",
    "conference_id": "6b1011223344556677889900",
    "layout_id": "4-tiles",
    "visibility": "PRIVATE",
    "overlay_settings": {},
    "inputs": [
      {
        "id": "camera-a",
        "name": "Camera A",
        "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
        "source_id": "6b2011223344556677889900",
        "participant_name": "Camera A",
        "resolution": "1920x1080",
        "video_codec": "libx264",
        "video_bitrate": 1350,
        "tile_index": 0,
        "muted": false,
        "hidden": false,
        "volume": 1
      }
    ],
    "active": true,
    "created": "2026-06-25T10:00:00.000Z",
    "modified": "2026-06-25T10:00:01.000Z",
    "success": true
  }
]

POST

/api/multiview/getById

Requiere token de API

Obtiene un Multiview que pertenece al usuario autenticado. Es la comprobación recomendada antes de actualizar, iniciar, detener o abrir una sesión.

Un ID desconocido o ajeno devuelve el objeto de error 400 habitual de Engine.

Parámetros del cuerpo de la solicitud

Recurso

string

Identificador del recurso de multiview.

Obtener Multiview por ID

Respuesta

Identidad

string

Identificador estable del recurso de multiview.

name

string

Nombre que se muestra al operador.

Layout

layout_id

string

Disposición de mosaicos seleccionada, por ejemplo 4-tiles.

inputs

array

Entradas de vídeo normalizadas y sus vinculaciones en ejecución.

Acceso

visibility

string

PRIVATE o PUBLIC.

Runtime

conference_id

string

Conferencia que proporciona la vista utilizada por el operador.

active

boolean

Indica si la instancia de multiview debe estar activa.

Respuesta: Obtener Multiview por ID

JSON

{
  "_id": "6b0011223344556677889900",
  "id": "6b0011223344556677889900",
  "name": "Master control multiview",
  "conference_id": "6b1011223344556677889900",
  "layout_id": "4-tiles",
  "visibility": "PRIVATE",
  "overlay_settings": {},
  "inputs": [
    {
      "id": "camera-a",
      "name": "Camera A",
      "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
      "source_id": "6b2011223344556677889900",
      "participant_name": "Camera A",
      "resolution": "1920x1080",
      "video_codec": "libx264",
      "video_bitrate": 1350,
      "tile_index": 0,
      "muted": false,
      "hidden": false,
      "volume": 1
    }
  ],
  "active": true,
  "created": "2026-06-25T10:00:00.000Z",
  "modified": "2026-06-25T10:00:01.000Z",
  "success": true
}

POST

/api/multiview/start

Requiere token de API

POST

/api/multiview/stop

Requiere token de API

POST

/api/multiview/join

Requiere token de API

Emite un token de participante para un operador de un Multiview que pertenece al usuario autenticado. Si Multiview aún no está listo, Callaba lo inicia antes de crear el token.

No guardes participant_token en logs ni en almacenamiento persistente del navegador: es una credencial temporal.

Parámetros del cuerpo de la solicitud

Recurso

string

Identificador del recurso de multiview.

Participante

participant_name

string

Nombre visible obligatorio del participante.

participant_id

string

Identificador estable opcional del participante. Si se omite, Callaba Engine lo genera automáticamente.

Acceder a Multiview como operador autenticado

Respuesta

Resultado de acceso

participant_token

string

Token de participante de LiveKit para la conferencia de multiview.

LKRoomName

string

Nombre de la sala en ejecución.

participant_id

string

Identidad final asignada al participante.

multiview

object

Recurso de multiview actual.

Respuesta: Acceder a Multiview como operador autenticado

JSON

{
  "success": true,
  "multiview": {
    "_id": "6b0011223344556677889900",
    "id": "6b0011223344556677889900",
    "name": "Master control multiview",
    "conference_id": "6b1011223344556677889900",
    "layout_id": "4-tiles",
    "visibility": "PRIVATE",
    "overlay_settings": {},
    "inputs": [
      {
        "id": "camera-a",
        "name": "Camera A",
        "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
        "source_id": "6b2011223344556677889900",
        "participant_name": "Camera A",
        "resolution": "1920x1080",
        "video_codec": "libx264",
        "video_bitrate": 1350,
        "tile_index": 0,
        "muted": false,
        "hidden": false,
        "volume": 1
      }
    ],
    "active": true,
    "created": "2026-06-25T10:00:00.000Z",
    "modified": "2026-06-25T10:00:01.000Z",
    "success": true
  },
  "conference_id": "6b1011223344556677889900",
  "LKRoomName": "master-control-6b101122",
  "participant_token": "<livekit_participant_token>",
  "participant_id": "operator-01",
  "allow_webinar_mode": true,
  "allow_chat": false,
  "allow_share_screen": false
}

{
  "success": true,
  "multiview": {
    "_id": "6b0011223344556677889900",
    "id": "6b0011223344556677889900",
    "name": "Master control multiview",
    "conference_id": "6b1011223344556677889900",
    "layout_id": "4-tiles",
    "visibility": "PRIVATE",
    "overlay_settings": {},
    "inputs": [
      {
        "id": "camera-a",
        "name": "Camera A",
        "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
        "source_id": "6b2011223344556677889900",
        "participant_name": "Camera A",
        "resolution": "1920x1080",
        "video_codec": "libx264",
        "video_bitrate": 1350,
        "tile_index": 0,
        "muted": false,
        "hidden": false,
        "volume": 1
      }
    ],
    "active": true,
    "created": "2026-06-25T10:00:00.000Z",
    "modified": "2026-06-25T10:00:01.000Z",
    "success": true
  },
  "conference_id": "6b1011223344556677889900",
  "LKRoomName": "master-control-6b101122",
  "participant_token": "<livekit_participant_token>",
  "participant_id": "operator-01",
  "allow_webinar_mode": true,
  "allow_chat": false,
  "allow_share_screen": false
}

POST

/api/multiview-public/getById

Endpoint público

Obtiene un Multiview sin token de API únicamente cuando su visibilidad es PUBLIC. Usa esta ruta para una superficie creada expresamente para compartir, no para operaciones de administración.

Un ID desconocido o privado devuelve el objeto de error 400 habitual.

Parámetros del cuerpo de la solicitud

Recurso

string

Identificador del recurso de multiview.

Obtener Multiview público por ID

Respuesta

Identidad

string

Identificador estable del recurso de multiview.

name

string

Nombre que se muestra al operador.

Layout

layout_id

string

Disposición de mosaicos seleccionada, por ejemplo 4-tiles.

inputs

array

Entradas de vídeo normalizadas y sus vinculaciones en ejecución.

Acceso

visibility

string

PRIVATE o PUBLIC.

Runtime

conference_id

string

Conferencia que proporciona la vista utilizada por el operador.

active

boolean

Indica si la instancia de multiview debe estar activa.

Respuesta: Obtener Multiview público por ID

JSON

{
  "_id": "6b0011223344556677889900",
  "id": "6b0011223344556677889900",
  "name": "Master control multiview",
  "conference_id": "6b1011223344556677889900",
  "layout_id": "4-tiles",
  "visibility": "PUBLIC",
  "overlay_settings": {},
  "inputs": [
    {
      "id": "camera-a",
      "name": "Camera A",
      "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
      "source_id": "6b2011223344556677889900",
      "participant_name": "Camera A",
      "resolution": "1920x1080",
      "video_codec": "libx264",
      "video_bitrate": 1350,
      "tile_index": 0,
      "muted": false,
      "hidden": false,
      "volume": 1
    }
  ],
  "active": true,
  "created": "2026-06-25T10:00:00.000Z",
  "modified": "2026-06-25T10:00:01.000Z",
  "success": true
}

POST

/api/multiview-public/getStat

Endpoint público

POST

/api/multiview-public/join

Endpoint público

Accede a un Multiview público sin token de API. Callaba puede iniciar Multiview antes de emitir el token de participante.

Aplica rate limiting en el edge, comparte solo IDs destinados a ser públicos y trata el token devuelto como una credencial temporal.

Casos de uso habituales

Abrir una pared de producción pública desde un enlace compartido con los operadores.
Insertar un Multiview público en una sede supervisada o en la página de un evento.

Parámetros del cuerpo de la solicitud

Recurso

string

Identificador del recurso de multiview.

Participante

participant_name

string

Nombre visible obligatorio del invitado.

participant_id

string

Identificador estable opcional del participante.

Acceder a un Multiview público

Respuesta

Resultado de acceso

participant_token

string

Token de LiveKit para la conferencia pública de multiview.

LKRoomName

string

Nombre de la sala en ejecución.

participant_id

string

Identidad final asignada al participante.

Respuesta: Acceder a un Multiview público

JSON

{
  "success": true,
  "multiview": {
    "_id": "6b0011223344556677889900",
    "id": "6b0011223344556677889900",
    "name": "Master control multiview",
    "conference_id": "6b1011223344556677889900",
    "layout_id": "4-tiles",
    "visibility": "PUBLIC",
    "overlay_settings": {},
    "inputs": [
      {
        "id": "camera-a",
        "name": "Camera A",
        "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
        "source_id": "6b2011223344556677889900",
        "participant_name": "Camera A",
        "resolution": "1920x1080",
        "video_codec": "libx264",
        "video_bitrate": 1350,
        "tile_index": 0,
        "muted": false,
        "hidden": false,
        "volume": 1
      }
    ],
    "active": true,
    "created": "2026-06-25T10:00:00.000Z",
    "modified": "2026-06-25T10:00:01.000Z",
    "success": true
  },
  "conference_id": "6b1011223344556677889900",
  "LKRoomName": "master-control-6b101122",
  "participant_token": "<livekit_participant_token>",
  "participant_id": "operator-01",
  "allow_webinar_mode": true,
  "allow_chat": false,
  "allow_share_screen": false
}

{
  "success": true,
  "multiview": {
    "_id": "6b0011223344556677889900",
    "id": "6b0011223344556677889900",
    "name": "Master control multiview",
    "conference_id": "6b1011223344556677889900",
    "layout_id": "4-tiles",
    "visibility": "PUBLIC",
    "overlay_settings": {},
    "inputs": [
      {
        "id": "camera-a",
        "name": "Camera A",
        "source_kind": "INPUT_TYPE_SRT_SOFTWARE",
        "source_id": "6b2011223344556677889900",
        "participant_name": "Camera A",
        "resolution": "1920x1080",
        "video_codec": "libx264",
        "video_bitrate": 1350,
        "tile_index": 0,
        "muted": false,
        "hidden": false,
        "volume": 1
      }
    ],
    "active": true,
    "created": "2026-06-25T10:00:00.000Z",
    "modified": "2026-06-25T10:00:01.000Z",
    "success": true
  },
  "conference_id": "6b1011223344556677889900",
  "LKRoomName": "master-control-6b101122",
  "participant_token": "<livekit_participant_token>",
  "participant_id": "operator-01",
  "allow_webinar_mode": true,
  "allow_chat": false,
  "allow_share_screen": false
}

DELETE

/api/multiview/remove

Requiere token de API

AnteriorConfiguración NDI SiguienteRetransmisiones