Streams

Usa Streams para crear conexiones con nombre de emisores y receptores en endpoints SRT o RTMP. Cada registro proporciona a las aplicaciones una identidad de conexión estable y ajustes multimedia reutilizables.

Qué haceCrear una conexión multimedia con nombre

Elige este módulo cuandoCada emisor o receptor necesita su propia identidad dentro de un servidor SRT o RTMP existente.

Usa otro módulo cuandoUsa Servidores SRT o Servidores RTMP para crear el endpoint de ingesta.

1Elige emisor o receptor2Define el endpoint3Usa la conexión

POST /api/streams/create

Filtrar endpoints10 endpoints

Antes de empezar

Todos los métodos requieren un x-access-token válido. Crea primero el servidor SRT o RTMP relacionado y mantén coherentes los identificadores del servidor y del stream.

Qué puedes hacer

create, update, getAll, getCount y getById gestionan los registros de conexión.
start y stop controlan las acciones compatibles del ciclo de vida del stream.
getStreamInfo consulta la información de conexión.
setStreamInfo aplica la información de stream compatible.
remove elimina un registro de stream.

Flujo de ejemplo

Crea un registro de emisor para el servidor SRT o RTMP previsto.
Asigna el rol, el stream_id, los datos del host y los ajustes de audio necesarios.
Entrega al emisor los datos de conexión generados.
Usa getStreamInfo durante la configuración y la resolución de problemas.

Casos de uso habituales

Asignar una conexión dedicada a cada equipo de cámaras remoto.
Separar las identidades de emisor y receptor en un servidor de ingesta compartido.
Guardar ajustes de canales de audio para señales de contribución repetibles.

Límites y resolución de problemas

Los identificadores de stream duplicados o incoherentes pueden impedir la conexión prevista. Un registro de stream depende de su servidor principal y no puede corregir un emisor inaccesible. No expongas credenciales ni datos de conexión sin restricciones fuera del participante previsto.

Siguientes pasos

Conecta el emisor o receptor y consulta después las estadísticas de ejecución del servidor SRT o RTMP principal.

Receta de solución REST

Registrar y operar una fuente reutilizable

Crea una vez la identidad y conexión, inicia la fuente cuando sea necesario y consulta su información para automatización downstream.

Crear el streamGuarda la identidad y el contrato de conexión revisados.POST /api/streams/create
Iniciar la fuenteIníciala antes de conectar módulos downstream.POST /api/streams/start
Consultar informaciónUsa los metadatos actuales en tu flujo de control.POST /api/streams/getStreamInfo

Una respuesta de creación correcta confirma la configuración, no el estado del medio. Inicia el recurso y comprueba sus estadísticas antes de enviar tráfico de producción.

POST

/api/streams/create

Requiere token de API

Crea una identidad de stream gestionada sobre un transporte SRT o RTMP. Guarda nombre, rol de emisor o receptor, stream ID, host opcional, recurso relacionado y metadatos de audio.

Hay un ejemplo de vMix Script para crear el stream desde un flujo de operador.

Ejemplos de solicitud

Elige una plantilla de emisor SRT, receptor SRT, emisor RTMP o stream con layout de audio guardado.

Casos de uso habituales

Asignar nombres a varios emisores que comparten un listener SRT.
Mantener una identidad estable de receptor para tráfico enrutado o PULL.
Guardar nombres de canales, layouts o el significado de las pistas junto con el stream.

Stream emisor SRT

Utiliza esta configuración cuando un servicio de escucha SRT aloje un flujo de un publicador que los operadores deban gestionar como un objeto independiente.

Stream emisor SRT

Stream receptor SRT

Utiliza esta configuración cuando un flujo del receptor o un retorno deba conservar su propia identidad y, opcionalmente, quedar vinculado a un host.

Stream receptor SRT

Stream emisor RTMP

Utiliza esta configuración cuando la entidad de transporte asociada sea un servidor RTMP en lugar de un servicio de escucha SRT.

Stream emisor RTMP

Stream con layout de audio guardado

Utiliza esta configuración para guardar la distribución y los nombres de los canales junto con el registro del flujo después de analizarlo.

Stream con layout de audio guardado

curl --request POST \
  --url http://localhost/api/streams/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Commentary audio stream",
  "role_name": "publisher",
  "stream_id": "publisher/commentary/audio-main",
  "entity_id": "680400000000000000000001",
  "module_name": "MODULE_SRT_SERVERS",
  "audio_settings": {
    "streams": [
      {
        "id": 0,
        "name": "Commentary",
        "channel_layout": "mono",
        "channels": [
          {
            "id": "FC",
            "name": "Commentary"
          }
        ]
      }
    ]
  },
  "active": true
}'

Parámetros del cuerpo de la solicitud

Identidad

name

string

Etiqueta del panel: Nombre.

Nombre descriptivo del registro de flujo guardado.

role_name

string

Etiqueta del panel: Rol.

Entre los valores habituales del producto están publisher, receiver, pusher y puller.

stream_id

string

Identificador estable del flujo, guardado en relación con la entidad de transporte asociada.

host

string

Vinculación opcional a un host para mantener la identidad del flujo asociada a un par remoto concreto.

Enlace de transporte

entity_id

string

Identificador de la entidad de transporte asociada, por ejemplo, un servidor SRT o RTMP.

module_name

string

Familia del módulo asociada al registro del flujo. En la práctica, suele ser MODULE_SRT_SERVERS o MODULE_RTMP_SERVERS.

Metadatos

audio_settings

object

Distribución de audio opcional con nombres para las pistas y los canales.

Runtime

active

boolean

Etiqueta del panel: Habilitar después de crear.

Define si el registro del flujo debe quedar activo inmediatamente después de crearlo.

Crear stream

Respuesta

Identidad

_id / id / name / role_name / stream_id / host

mixed

Identificadores y campos de identidad guardados para el flujo.

Enlace de transporte

entity_id / entityModel / module_name

mixed

Referencia al objeto de transporte que contiene o sirve el flujo.

Metadatos

stream_meta_data / audio_settings

mixed

Resultado guardado del análisis, información del códec y metadatos opcionales de asignación de canales.

Runtime

active / created / modified

mixed

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

Resultado de la operación

success

boolean

Las respuestas correctas del modelo de flujo incluyen success: true como campo virtual.

Respuesta: Crear stream

JSON

{
  "_id": "680600000000000000000001",
  "id": "680600000000000000000001",
  "name": "Main stage publisher",
  "role_name": "publisher",
  "host": "",
  "stream_id": "publisher/main-stage/srt-main",
  "entity_id": "680400000000000000000001",
  "entityModel": "ServerModel",
  "module_name": "MODULE_SRT_SERVERS",
  "stream_meta_data": {
    "codec_name": "h264",
    "fps": "30/1"
  },
  "audio_settings": {
    "streams": [
      {
        "id": 0,
        "name": "Track-0",
        "channel_layout": "stereo",
        "channels": [
          {
            "id": "FL",
            "name": "Left"
          },
          {
            "id": "FR",
            "name": "Right"
          }
        ]
      }
    ]
  },
  "created": "2026-03-24T08:45:00.000Z",
  "modified": "2026-03-24T08:45:00.000Z",
  "active": true,
  "success": true
}

POST

/api/streams/getCount

Requiere token de API

POST

/api/streams/getAll

Requiere token de API

Lista los streams visibles para la cuenta autenticada.

Úsalo para consultar en una sola vista las identidades activas de flujos SRT y RTMP y distinguir con rapidez emisores y receptores.

Parámetros del cuerpo de la solicitud

limit

integer

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

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 para buscar y filtrar por rol o módulo.

Listar streams

Respuesta

array of stream objects

array

El backend devuelve directamente una lista de registros de flujo, sin envolverla en otro objeto.

Respuesta: Listar streams

JSON

[
  {
    "_id": "680600000000000000000001",
    "id": "680600000000000000000001",
    "name": "Main stage publisher",
    "role_name": "publisher",
    "host": "",
    "stream_id": "publisher/main-stage/srt-main",
    "entity_id": "680400000000000000000001",
    "entityModel": "ServerModel",
    "module_name": "MODULE_SRT_SERVERS",
    "stream_meta_data": {
      "codec_name": "h264",
      "fps": "30/1"
    },
    "audio_settings": {
      "streams": [
        {
          "id": 0,
          "name": "Track-0",
          "channel_layout": "stereo",
          "channels": [
            {
              "id": "FL",
              "name": "Left"
            },
            {
              "id": "FR",
              "name": "Right"
            }
          ]
        }
      ]
    },
    "created": "2026-03-24T08:45:00.000Z",
    "modified": "2026-03-24T08:45:00.000Z",
    "active": true,
    "success": true
  }
]

POST

/api/streams/getById

Requiere token de API

Obtén un stream guardado mediante su ID.

Úsalo antes de editar para consultar exactamente la identidad, el transporte relacionado y los ajustes de audio guardados.

Parámetros del cuerpo de la solicitud

string

Identificador del registro de flujo que se desea cargar.

Obtener stream por ID

Respuesta

stream object

object

El backend devuelve el registro de flujo guardado, su vínculo con el transporte y todos los metadatos almacenados.

Respuesta: Obtener stream por ID

JSON

{
  "_id": "680600000000000000000001",
  "id": "680600000000000000000001",
  "name": "Main stage publisher",
  "role_name": "publisher",
  "host": "",
  "stream_id": "publisher/main-stage/srt-main",
  "entity_id": "680400000000000000000001",
  "entityModel": "ServerModel",
  "module_name": "MODULE_SRT_SERVERS",
  "stream_meta_data": {
    "codec_name": "h264",
    "fps": "30/1"
  },
  "audio_settings": {
    "streams": [
      {
        "id": 0,
        "name": "Track-0",
        "channel_layout": "stereo",
        "channels": [
          {
            "id": "FL",
            "name": "Left"
          },
          {
            "id": "FR",
            "name": "Right"
          }
        ]
      }
    ]
  },
  "created": "2026-03-24T08:45:00.000Z",
  "modified": "2026-03-24T08:45:00.000Z",
  "active": true,
  "success": true
}

POST

/api/streams/update

Requiere token de API

Actualiza un stream guardado.

Permite cambiar el nombre, los metadatos del rol, los ajustes de audio o la combinación de stream ID y host después de inspeccionar la señal.

Parámetros del cuerpo de la solicitud

string

Identificador del registro de flujo que se desea actualizar.

name / role_name / stream_id / host

mixed

Campos de identidad de flujo actualizados.

audio_settings

object

Distribución de audio opcional para sustituir la existente, o datos guardados con los nombres de los canales.

active

boolean

Indicador que muestra si el flujo queda habilitado después de la actualización.

Actualizar stream

curl --request POST \
  --url http://localhost/api/streams/update \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "680600000000000000000001",
  "name": "Main stage publisher",
  "role_name": "publisher",
  "stream_id": "publisher/main-stage/srt-main",
  "entity_id": "680400000000000000000001",
  "module_name": "MODULE_SRT_SERVERS",
  "audio_settings": {
    "streams": [
      {
        "id": 0,
        "name": "Program",
        "channel_layout": "stereo",
        "channels": [
          {
            "id": "FL",
            "name": "Left"
          },
          {
            "id": "FR",
            "name": "Right"
          }
        ]
      }
    ]
  },
  "active": true
}'

Respuesta

updated stream object

object

El backend devuelve el registro de flujo actualizado.

Respuesta: Actualizar stream

JSON

{
  "_id": "680600000000000000000001",
  "id": "680600000000000000000001",
  "name": "Main stage publisher",
  "role_name": "publisher",
  "host": "",
  "stream_id": "publisher/main-stage/srt-main",
  "entity_id": "680400000000000000000001",
  "entityModel": "ServerModel",
  "module_name": "MODULE_SRT_SERVERS",
  "stream_meta_data": {
    "codec_name": "h264",
    "fps": "30/1"
  },
  "audio_settings": {
    "streams": [
      {
        "id": 0,
        "name": "Track-0",
        "channel_layout": "stereo",
        "channels": [
          {
            "id": "FL",
            "name": "Left"
          },
          {
            "id": "FR",
            "name": "Right"
          }
        ]
      }
    ]
  },
  "created": "2026-03-24T08:45:00.000Z",
  "modified": "2026-03-24T08:45:00.000Z",
  "active": true,
  "success": true
}

POST

/api/streams/setStreamInfo

Requiere token de API

DELETE

/api/streams/remove

Requiere token de API

POST

/api/streams/start

Requiere token de API

Inicia el stream seleccionado.

Úsalo cuando una identidad guardada deba activarse para un reproductor o proceso downstream.

Los ejemplos incluyen una pestaña vMix Script para flujos controlados por operadores.

Parámetros del cuerpo de la solicitud

string

Identificador del registro de flujo que se desea iniciar.

Iniciar stream

Respuesta

started stream object

object

El backend devuelve el registro del flujo después de aceptar la operación de inicio.

Respuesta: Iniciar stream

JSON

{
  "_id": "680600000000000000000001",
  "id": "680600000000000000000001",
  "name": "Main stage publisher",
  "role_name": "publisher",
  "host": "",
  "stream_id": "publisher/main-stage/srt-main",
  "entity_id": "680400000000000000000001",
  "entityModel": "ServerModel",
  "module_name": "MODULE_SRT_SERVERS",
  "stream_meta_data": {
    "codec_name": "h264",
    "fps": "30/1"
  },
  "audio_settings": {
    "streams": [
      {
        "id": 0,
        "name": "Track-0",
        "channel_layout": "stereo",
        "channels": [
          {
            "id": "FL",
            "name": "Left"
          },
          {
            "id": "FR",
            "name": "Right"
          }
        ]
      }
    ]
  },
  "created": "2026-03-24T08:45:00.000Z",
  "modified": "2026-03-24T08:45:00.000Z",
  "active": true,
  "success": true
}

POST

/api/streams/stop

Requiere token de API

Detiene el stream seleccionado.

Pone offline el flujo sin eliminar su identidad ni los metadatos guardados.

Los ejemplos incluyen una pestaña vMix Script para flujos controlados por operadores.

Parámetros del cuerpo de la solicitud

string

Identificador del registro de flujo que se desea detener.

Detener stream

Respuesta

stopped stream object

object

El backend devuelve el registro del flujo después de aceptar la operación de detención.

Respuesta: Detener stream

JSON

{
  "_id": "680600000000000000000001",
  "id": "680600000000000000000001",
  "name": "Main stage publisher",
  "role_name": "publisher",
  "host": "",
  "stream_id": "publisher/main-stage/srt-main",
  "entity_id": "680400000000000000000001",
  "entityModel": "ServerModel",
  "module_name": "MODULE_SRT_SERVERS",
  "stream_meta_data": {
    "codec_name": "h264",
    "fps": "30/1"
  },
  "audio_settings": {
    "streams": [
      {
        "id": 0,
        "name": "Track-0",
        "channel_layout": "stereo",
        "channels": [
          {
            "id": "FL",
            "name": "Left"
          },
          {
            "id": "FR",
            "name": "Right"
          }
        ]
      }
    ]
  },
  "created": "2026-03-24T08:45:00.000Z",
  "modified": "2026-03-24T08:45:00.000Z",
  "active": true,
  "success": true
}

POST

/api/streams/getStreamInfo

Requiere token de API

Inspecciona una URL en directo y devuelve codec, audio y datos temporales de la señal upstream real.

Úsalo para obtener datos objetivos antes de guardarlos en el stream o enviarlos a otro proceso.

Parámetros del cuerpo de la solicitud

stream_url

string

URL de la entrada en directo que se desea analizar con FFprobe.

Obtener información del stream

Respuesta

streams[]

array

Descriptores de flujo de estilo FFprobe para pistas de vídeo, audio o datos descubiertas en la entrada en vivo.

streams[].codec_name / codec_type

mixed

Identidad del códec de cada pista detectada.

streams[].width / height / avg_frame_rate

mixed

Propiedades representativas del vídeo cuando la entrada contiene una pista de vídeo.

streams[].sample_rate / channels / channel_layout

mixed

Propiedades de audio representativas cuando la entrada incluye pistas de audio.

format

object

Objeto de formato FFprobe de alto nivel para la URL inspeccionada.

Respuesta: Obtener información del stream

JSON

{
  "streams": [
    {
      "index": 0,
      "codec_name": "h264",
      "codec_type": "video",
      "width": 1920,
      "height": 1080,
      "avg_frame_rate": "30/1",
      "pix_fmt": "yuv420p"
    },
    {
      "index": 1,
      "codec_name": "aac",
      "codec_type": "audio",
      "sample_rate": "48000",
      "channels": 2,
      "channel_layout": "stereo"
    }
  ],
  "format": {
    "filename": "srt://127.0.0.1:1936",
    "nb_streams": 2,
    "format_name": "mpegts",
    "start_time": "0.000000",
    "probe_score": 100
  }
}

AnteriorRetransmisiones SiguienteGrabaciones