Grupos de reproductores web

Usa Grupos de reproductores web para ofrecer a los espectadores una sola página desde la que cambiar entre señales de idiomas autorizadas, ángulos de cámara o variantes de replay.

Qué hacePermitir que la audiencia cambie de señal

Elige este módulo cuandoVarios reproductores necesitan una página común para cambiar entre idiomas, ángulos o replays.

Usa otro módulo cuandoUsa Reproductores web para crear y validar primero cada endpoint de reproducción.

1Elige los reproductores2Define el acceso común3Publica una página

POST /api/vod-group/create

Filtrar endpoints8 endpoints

Antes de empezar

Todos los métodos de gestión requieren un x-access-token válido. Crea y prueba cada reproductor web antes de añadir sus identificadores a un grupo.

Qué puedes hacer

create y update definen los miembros, la selección predeterminada, el acceso, el branding y los ajustes del evento.
getAll, getCount y getById consultan los grupos.
start y stop controlan la disponibilidad del grupo.
remove elimina el grupo, pero conserva sus reproductores web.

Flujo de ejemplo

Crea y valida un reproductor web para cada señal de idioma.
Crea un grupo que contenga los identificadores de esos reproductores.
Selecciona el idioma principal como predeterminado.
Aplica los ajustes compartidos de acceso y evento.
Inicia el grupo y publica su URL para espectadores o su embed.

Casos de uso habituales

Ofrecer señales paralelas de distintos idiomas o comentaristas en una página de evento.
Publicar un conjunto seleccionado de variantes de replay o episodios.
Aplicar una política restringida o pay-per-view a varios reproductores.

Límites y resolución de problemas

El grupo depende de recursos válidos y reproducibles. Eliminar o detener uno de sus miembros puede dejar una opción no disponible hasta que el grupo se actualice. Prueba la selección predeterminada, el flujo de acceso y cada reproductor antes de publicar.

Siguientes pasos

Abre Reproductores web para preparar cada fuente y añade después el grupo probado mediante embed o enlace a la experiencia del espectador.

Receta de solución REST

Crear una experiencia de pago por visión

Prepara primero los reproductores, agrupa las señales aprobadas en una página y aplica al grupo los ajustes de pago y acceso.

Crear el reproductorPrepara cada señal en directo o grabada que podrán comprar los espectadores.POST /api/vod/create
Crear el grupo de pagoAsocia los reproductores y configura pay_per_view_settings, acceso, marca y datos del evento.POST /api/vod-group/create
Abrir la experienciaInicia el grupo solo cuando pasen las pruebas de compra y reproducción.POST /api/vod-group/start

Configurar el pago no completa la prueba comercial. Valida compra, autorización, soporte y reproducción con un cliente de prueba antes del evento.

Ver el producto de pago por visión

POST

/api/vod-group/create

Requiere token de API

Agrupa varios reproductores en una sola experiencia con cambio de señal, branding, presentación y política de acceso comunes.

Úsalo para idiomas, ángulos o comentarios, especialmente si la contraseña o el pay-per-view deben aplicarse a todo el grupo. Los ejemplos incluyen solicitudes vMix Script para publicación desde producción.

Grupo con selector de idioma

Utiliza esta configuración cuando varios reproductores web paralelos representen distintos idiomas o comentarios y uno deba quedar seleccionado de forma predeterminada.

Grupo con selector de idioma

curl --request POST \
  --url http://localhost/api/vod-group/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Main event language selector",
  "type": "LANGUAGE_LIST",
  "players": [
    {
      "id": "PLAYER_ID_ENGLISH",
      "name": "English",
      "selected": true
    },
    {
      "id": "PLAYER_ID_SPANISH",
      "name": "Spanish",
      "selected": false
    }
  ],
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED",
    "credentials": []
  },
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED"
  },
  "support_email": "[email protected]",
  "eventDateStatus": "EVENTS_DATE_DISABLED",
  "active": true
}'

Grupo de archivos para playlist

Utiliza esta configuración cuando la experiencia agrupada del navegador deba alternar entre contenidos bajo demanda o reproductores preparados a partir de archivos.

Grupo de archivos para playlist

curl --request POST \
  --url http://localhost/api/vod-group/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "On-demand episode selector",
  "type": "FILES_LIST",
  "players": [
    {
      "id": "PLAYER_ID_EPISODE_1",
      "name": "Episode 1",
      "selected": true
    },
    {
      "id": "PLAYER_ID_EPISODE_2",
      "name": "Episode 2",
      "selected": false
    }
  ],
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED",
    "credentials": []
  },
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED"
  },
  "eventDateStatus": "EVENTS_DATE_DISABLED",
  "active": true
}'

Grupo de evento protegido con contraseña

Utiliza esta configuración cuando la reproducción agrupada deba permanecer privada mediante una contraseña compartida para invitados.

Grupo de evento protegido con contraseña

curl --request POST \
  --url http://localhost/api/vod-group/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Private webinar playback group",
  "type": "LANGUAGE_LIST",
  "players": [
    {
      "id": "PLAYER_ID_PRIVATE_MAIN",
      "name": "Main stream",
      "selected": true
    }
  ],
  "authorization": {
    "authorization_type": "VOD_USE_PASSWORD",
    "credentials": [
      {
        "name": "Guest",
        "password": "guest-password"
      }
    ]
  },
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED"
  },
  "support_email": "[email protected]",
  "eventDateStatus": "EVENTS_DATE_DISABLED",
  "active": true
}'

Grupo de evento con pay-per-view

Utiliza esta configuración cuando una página de evento personalizada deba reunir uno o varios reproductores con acceso mediante PayPal y metadatos de fecha y hora del evento.

Grupo de evento con pay-per-view

curl --request POST \
  --url http://localhost/api/vod-group/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Paid event player group",
  "type": "LANGUAGE_LIST",
  "players": [
    {
      "id": "PLAYER_ID_MAIN_STAGE",
      "name": "Main stage",
      "selected": true
    }
  ],
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED",
    "credentials": []
  },
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_PAYPAL",
    "amount": 19,
    "client_id": "PAYPAL_CLIENT_ID"
  },
  "support_email": "[email protected]",
  "event_date": "2026-04-01T18:00:00.000Z",
  "timeZone": "Europe/Istanbul",
  "eventDateStatus": "EVENTS_SET_DATE",
  "active": true
}'

Parámetros del cuerpo de la solicitud

Identidad

name

string

Etiqueta del panel: Nombre del grupo.

Nombre descriptivo de la experiencia de reproducción agrupada.

type

string

Etiqueta del panel: Tipo.

Entre los valores utilizados por el producto están LANGUAGE_LIST y FILES_LIST.

Reproductores

players[]

array

Lista de reproductores vinculados. Cada elemento incluye id, el name que se mostrará y el indicador selected que define la opción predeterminada.

Acceso

authorization

object

Bloque opcional de autorización de espectadores. Entre los modos del producto están VOD_PASSWORD_DISABLED, VOD_USE_PASSWORD y los flujos con correo electrónico y contraseña.

Monetización

pay_per_view_settings

object

Bloque opcional de pago por visión. Además del modo deshabilitado predeterminado, el panel permite utilizar PayPal.

Presentación

cover_path / logo_path / useCustomLogo / useCustomBackground

mixed

Campos opcionales de marca para la página de reproducción agrupada.

support_email

string

Contacto de soporte opcional que se muestra en la página del reproductor de tipo evento.

event_date / timeZone / eventDateStatus

mixed

Metadatos opcionales de fecha y hora del evento guardados en el grupo.

Runtime

active

boolean

Etiqueta del panel: Habilitar después de crear.

Define si el grupo debe quedar activo inmediatamente después de crearlo.

Crear grupo de reproductores web

curl --request POST \
  --url http://localhost/api/vod-group/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Main event language selector",
  "type": "LANGUAGE_LIST",
  "players": [
    {
      "id": "PLAYER_ID_ENGLISH",
      "name": "English",
      "selected": true
    },
    {
      "id": "PLAYER_ID_SPANISH",
      "name": "Spanish",
      "selected": false
    }
  ],
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED",
    "credentials": []
  },
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED"
  },
  "support_email": "[email protected]",
  "eventDateStatus": "EVENTS_DATE_DISABLED",
  "active": true
}'

Respuesta

Identidad

_id / id / name / type

mixed

Identificadores y campos principales de identidad del grupo.

Reproductores

players[]

array

Reproductores guardados en el grupo, incluido el estado de selección predeterminado.

Acceso

authorization / users

mixed

Estado de autorización y usuarios de visualización vinculados al grupo.

Monetización

pay_per_view_settings

object

Configuración de pago por visión guardada para el grupo.

Presentación

cover_path / logo_path / support_email / event_date / timeZone / eventDateStatus

mixed

Datos de marca y metadatos del evento que devuelve el objeto del grupo.

Runtime

active / created / modified

mixed

Indicador del estado de ejecución actual y marcas de tiempo gestionadas por el backend.

Resultado de la operación

success

boolean

El modelo expone success: true como un campo virtual en respuestas exitosas.

Respuesta: Crear grupo de reproductores web

JSON

{
  "_id": "6a1144aa22bb33cc44dd55ee",
  "id": "6a1144aa22bb33cc44dd55ee",
  "name": "Main event language selector",
  "type": "LANGUAGE_LIST",
  "players": [
    {
      "id": "6a1144aa22bb33cc44dd5601",
      "name": "English",
      "selected": true
    },
    {
      "id": "6a1144aa22bb33cc44dd5602",
      "name": "Spanish",
      "selected": false
    }
  ],
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED"
  },
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED"
  },
  "cover_path": "",
  "logo_path": "",
  "useCustomLogo": "VOD_DISABLE_LOGO",
  "useCustomBackground": "VOD_DISABLE_BACKGROUND",
  "support_email": "[email protected]",
  "event_date": "2026-04-01T18:00:00.000Z",
  "timeZone": "Europe/Istanbul",
  "eventDateStatus": "EVENTS_DATE_DISABLED",
  "active": true,
  "created": "2026-03-24T18:00:00.000Z",
  "modified": "2026-03-24T18:00:00.000Z",
  "success": true
}

POST

/api/vod-group/getCount

Requiere token de API

POST

/api/vod-group/getAll

Requiere token de API

Lista los grupos de reproductores visibles para el usuario actual con la paginación y ordenación habituales.

Úsalo para inventarios administrativos y paneles de publicación.

Parámetros del cuerpo de la solicitud

limit

integer

Tamaño de página opcional para la consulta de la lista.

skip

integer

Desplazamiento opcional para recorrer el listado paginado.

sort

object

Descriptor de ordenación opcional. El estado del panel utiliza { created: 1 } de forma predeterminada.

filter

object

Objeto de filtro opcional enviado a la consulta de backend.

Listar grupos de reproductores web

Respuesta

array of web player group objects

array

El backend devuelve directamente una lista de objetos de grupo, sin envolverla en otro objeto.

Respuesta: Listar grupos de reproductores web

JSON

[
  {
    "_id": "6a1144aa22bb33cc44dd55ee",
    "id": "6a1144aa22bb33cc44dd55ee",
    "name": "Main event language selector",
    "type": "LANGUAGE_LIST",
    "players": [
      {
        "id": "6a1144aa22bb33cc44dd5601",
        "name": "English",
        "selected": true
      },
      {
        "id": "6a1144aa22bb33cc44dd5602",
        "name": "Spanish",
        "selected": false
      }
    ],
    "authorization": {
      "authorization_type": "VOD_PASSWORD_DISABLED"
    },
    "pay_per_view_settings": {
      "type": "PAY_PER_VIEW_DISABLED"
    },
    "cover_path": "",
    "logo_path": "",
    "useCustomLogo": "VOD_DISABLE_LOGO",
    "useCustomBackground": "VOD_DISABLE_BACKGROUND",
    "support_email": "support@example.com",
    "event_date": "2026-04-01T18:00:00.000Z",
    "timeZone": "Europe/Istanbul",
    "eventDateStatus": "EVENTS_DATE_DISABLED",
    "active": true,
    "created": "2026-03-24T18:00:00.000Z",
    "modified": "2026-03-24T18:00:00.000Z",
    "success": true
  }
]

[
  {
    "_id": "6a1144aa22bb33cc44dd55ee",
    "id": "6a1144aa22bb33cc44dd55ee",
    "name": "Main event language selector",
    "type": "LANGUAGE_LIST",
    "players": [
      {
        "id": "6a1144aa22bb33cc44dd5601",
        "name": "English",
        "selected": true
      },
      {
        "id": "6a1144aa22bb33cc44dd5602",
        "name": "Spanish",
        "selected": false
      }
    ],
    "authorization": {
      "authorization_type": "VOD_PASSWORD_DISABLED"
    },
    "pay_per_view_settings": {
      "type": "PAY_PER_VIEW_DISABLED"
    },
    "cover_path": "",
    "logo_path": "",
    "useCustomLogo": "VOD_DISABLE_LOGO",
    "useCustomBackground": "VOD_DISABLE_BACKGROUND",
    "support_email": "[email protected]",
    "event_date": "2026-04-01T18:00:00.000Z",
    "timeZone": "Europe/Istanbul",
    "eventDateStatus": "EVENTS_DATE_DISABLED",
    "active": true,
    "created": "2026-03-24T18:00:00.000Z",
    "modified": "2026-03-24T18:00:00.000Z",
    "success": true
  }
]

POST

/api/vod-group/getById

Requiere token de API

Obtén un grupo completo para revisarlo, comprobar su política o editarlo.

La respuesta incluye los reproductores relacionados y los usuarios asociados a reproducción protegida.

Parámetros del cuerpo de la solicitud

string

Identificador del grupo de reproductores web que desea cargar.

Obtener grupo de reproductores web por ID

Respuesta

web player group object

object

El backend devuelve el objeto del grupo con los reproductores vinculados y los usuarios asociados.

Respuesta: Obtener grupo de reproductores web por ID

JSON

{
  "_id": "6a1144aa22bb33cc44dd55ee",
  "id": "6a1144aa22bb33cc44dd55ee",
  "name": "Main event language selector",
  "type": "LANGUAGE_LIST",
  "players": [
    {
      "id": "6a1144aa22bb33cc44dd5601",
      "name": "English",
      "selected": true
    },
    {
      "id": "6a1144aa22bb33cc44dd5602",
      "name": "Spanish",
      "selected": false
    }
  ],
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED"
  },
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED"
  },
  "cover_path": "",
  "logo_path": "",
  "useCustomLogo": "VOD_DISABLE_LOGO",
  "useCustomBackground": "VOD_DISABLE_BACKGROUND",
  "support_email": "[email protected]",
  "event_date": "2026-04-01T18:00:00.000Z",
  "timeZone": "Europe/Istanbul",
  "eventDateStatus": "EVENTS_DATE_DISABLED",
  "active": true,
  "created": "2026-03-24T18:00:00.000Z",
  "modified": "2026-03-24T18:00:00.000Z",
  "success": true
}

POST

/api/vod-group/update

Requiere token de API

Actualiza reproductores, branding, presentación del evento o acceso sin volver a crear el punto de entrada público.

El contrato replica el de create y conserva el mismo ID de grupo.

Parámetros del cuerpo de la solicitud

string

Identificador del grupo de reproductores web que se desea actualizar.

group payload fields

mixed

El contrato de actualización reproduce el de create y reutiliza los mismos campos de configuración del grupo.

Actualizar grupo de reproductores web

curl --request POST \
  --url http://localhost/api/vod-group/update \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "WEB_PLAYER_GROUP_ID",
  "name": "Main event language selector updated",
  "type": "LANGUAGE_LIST",
  "players": [
    {
      "id": "PLAYER_ID_ENGLISH",
      "name": "English",
      "selected": true
    },
    {
      "id": "PLAYER_ID_SPANISH",
      "name": "Spanish",
      "selected": false
    }
  ],
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED",
    "credentials": []
  },
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED"
  },
  "support_email": "[email protected]",
  "eventDateStatus": "EVENTS_DATE_DISABLED",
  "active": true
}'

Respuesta

updated web player group object

object

El backend devuelve el objeto del grupo actualizado.

Respuesta: Actualizar grupo de reproductores web

JSON

{
  "_id": "6a1144aa22bb33cc44dd55ee",
  "id": "6a1144aa22bb33cc44dd55ee",
  "name": "Main event language selector updated",
  "type": "LANGUAGE_LIST",
  "players": [
    {
      "id": "6a1144aa22bb33cc44dd5601",
      "name": "English",
      "selected": true
    },
    {
      "id": "6a1144aa22bb33cc44dd5602",
      "name": "Spanish",
      "selected": false
    }
  ],
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED"
  },
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED"
  },
  "cover_path": "",
  "logo_path": "",
  "useCustomLogo": "VOD_DISABLE_LOGO",
  "useCustomBackground": "VOD_DISABLE_BACKGROUND",
  "support_email": "[email protected]",
  "event_date": "2026-04-01T18:00:00.000Z",
  "timeZone": "Europe/Istanbul",
  "eventDateStatus": "EVENTS_DATE_DISABLED",
  "active": true,
  "created": "2026-03-24T18:00:00.000Z",
  "modified": "2026-03-24T18:30:00.000Z",
  "success": true
}

POST

/api/vod-group/start

Requiere token de API

Publica un grupo preparado al comenzar el evento sin cambiar la configuración de sus reproductores.

Activa la experiencia y su política de acceso, por lo que funciona bien con botones de operador o vMix Script.

Parámetros del cuerpo de la solicitud

string

Identificador del grupo de reproductores web que se desea iniciar.

Iniciar grupo de reproductores web

Respuesta

started web player group object

object

El backend marca el grupo como activo y devuelve el objeto actualizado.

Respuesta: Iniciar grupo de reproductores web

JSON

{
  "_id": "6a1144aa22bb33cc44dd55ee",
  "id": "6a1144aa22bb33cc44dd55ee",
  "name": "Main event language selector",
  "type": "LANGUAGE_LIST",
  "players": [
    {
      "id": "6a1144aa22bb33cc44dd5601",
      "name": "English",
      "selected": true
    },
    {
      "id": "6a1144aa22bb33cc44dd5602",
      "name": "Spanish",
      "selected": false
    }
  ],
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED"
  },
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED"
  },
  "cover_path": "",
  "logo_path": "",
  "useCustomLogo": "VOD_DISABLE_LOGO",
  "useCustomBackground": "VOD_DISABLE_BACKGROUND",
  "support_email": "[email protected]",
  "event_date": "2026-04-01T18:00:00.000Z",
  "timeZone": "Europe/Istanbul",
  "eventDateStatus": "EVENTS_DATE_DISABLED",
  "active": true,
  "created": "2026-03-24T18:00:00.000Z",
  "modified": "2026-03-24T18:35:00.000Z",
  "success": true
}

POST

/api/vod-group/stop

Requiere token de API

Pone offline la experiencia agrupada, pero conserva el mapeo de reproductores y la política para reutilizarlos.

Es la operación complementaria de start cuando termina un evento o debe pausarse el acceso.

Parámetros del cuerpo de la solicitud

string

Identificador del grupo de reproductores web que se desea detener.

Detener grupo de reproductores web

Respuesta

stopped web player group object

object

El backend marca el grupo como inactivo y devuelve el objeto actualizado.

Respuesta: Detener grupo de reproductores web

JSON

{
  "_id": "6a1144aa22bb33cc44dd55ee",
  "id": "6a1144aa22bb33cc44dd55ee",
  "name": "Main event language selector",
  "type": "LANGUAGE_LIST",
  "players": [
    {
      "id": "6a1144aa22bb33cc44dd5601",
      "name": "English",
      "selected": true
    },
    {
      "id": "6a1144aa22bb33cc44dd5602",
      "name": "Spanish",
      "selected": false
    }
  ],
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED"
  },
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED"
  },
  "cover_path": "",
  "logo_path": "",
  "useCustomLogo": "VOD_DISABLE_LOGO",
  "useCustomBackground": "VOD_DISABLE_BACKGROUND",
  "support_email": "[email protected]",
  "event_date": "2026-04-01T18:00:00.000Z",
  "timeZone": "Europe/Istanbul",
  "eventDateStatus": "EVENTS_DATE_DISABLED",
  "active": false,
  "created": "2026-03-24T18:00:00.000Z",
  "modified": "2026-03-24T18:40:00.000Z",
  "success": true
}

DELETE

/api/vod-group/remove

Requiere token de API

Retira un punto de entrada agrupado que ya no debe publicarse.

También elimina los usuarios de espectadores vinculados al grupo; ejecútalo solo cuando la experiencia y su política de acceso ya no sean necesarias.

Parámetros de consulta

string

Identificador del grupo de reproductores web que se desea eliminar.

Eliminar grupo de reproductores web

Respuesta

removed web player group object

object

El backend elimina el grupo y devuelve el objeto previamente cargado.

Respuesta: Eliminar grupo de reproductores web

JSON

{
  "_id": "6a1144aa22bb33cc44dd55ee",
  "id": "6a1144aa22bb33cc44dd55ee",
  "name": "Main event language selector",
  "type": "LANGUAGE_LIST",
  "players": [
    {
      "id": "6a1144aa22bb33cc44dd5601",
      "name": "English",
      "selected": true
    },
    {
      "id": "6a1144aa22bb33cc44dd5602",
      "name": "Spanish",
      "selected": false
    }
  ],
  "authorization": {
    "authorization_type": "VOD_PASSWORD_DISABLED"
  },
  "pay_per_view_settings": {
    "type": "PAY_PER_VIEW_DISABLED"
  },
  "cover_path": "",
  "logo_path": "",
  "useCustomLogo": "VOD_DISABLE_LOGO",
  "useCustomBackground": "VOD_DISABLE_BACKGROUND",
  "support_email": "[email protected]",
  "event_date": "2026-04-01T18:00:00.000Z",
  "timeZone": "Europe/Istanbul",
  "eventDateStatus": "EVENTS_DATE_DISABLED",
  "active": true,
  "created": "2026-03-24T18:00:00.000Z",
  "modified": "2026-03-24T18:00:00.000Z",
  "success": true
}

AnteriorReproductores web SiguienteVideollamadas