Puntos de conexión de video de rDWS
23 min
URL base para estos endpoints: https://ws.bsn.cloud/rest/v1/
_________________________________________________________________________
GET /video-mode/
Recupera el modo de video actualmente activo en el reproductor
Ejemplo de solicitud
GET /rest/v1/video-mode/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+jsonCuerpo de la respuesta
- ancho int: El ancho de la pantalla
- altura int: La altura de la pantalla
- marcos int: La velocidad de fotogramas
- escanear string: El método de escaneo de la señal de video, que puede ser progresivo ("p") o entrelazado ("i")
- nombre string: El nombre completo del modo de video (se puede encontrar una lista completa de modos en esta página)
- isAutoMode bool: Una marca que indica si el modo de video se configuró usando el modo automático
- modo mode{ }: Un objeto Mode que proporciona información adicional sobre la salida de video. Este objeto puede contener las siguientes propiedades:
- preferido bool: Una marca que indica si el modo de video es el modo preferido
- sobrescaneo bool: Una marca que indica si la salida de video está usando una configuración de overscan o no
- modeName string: El nombre completo del modo de video (se puede encontrar una lista completa de modos en esta página)
- entrelazado bool: Una marca que indica si la salida de video es entrelazada (verdadero) o progresiva (falso)
- ancho int: El ancho de la salida de video
- altura int: La altura de la salida de video
- graphicsPlaneWidth int: El ancho del plano gráfico
- graphicsPlaneHeight int: La altura del plano gráfico
- frecuencia int: La velocidad de fotogramas de la salida de video
- dropFrame bool: Una marca que indica si el código de tiempo de video utiliza drop frames
- colorSpace string: El espacio de color de la señal de video ("rgb", "yuv420" o "yuv422")
- colorDepth string: La profundidad de color de la señal de video ("8bit", "10bit" o "12bit")
Ejemplo de respuesta
{
"route": "/v1/video-mode",
"method": "GET",
"data": {
"result": {
"isAutoMode": false,
"name": "640x480x60p",
"width": "640",
"height": "480",
"frames": "60",
"scan": "p",
"mode": {
"colorDepth": "8bit",
"colorSpace": "rgb",
"dropFrame": false,
"frequency": 60,
"graphicsPlaneHeight": 480,
"graphicsPlaneWidth": 640,
"height": 480,
"interlaced": false,
"modeName": "640x480x60p",
"overscan": false,
"preferred": false,
"width": 640
}
}
}
}GET /video/{:connector}/output/{:device}/
Recupera información sobre la salida de video especificada
Segmentos
- conector: El valor actual siempre es hdmi
- dispositivo: Este valor en las URL /video/ actualmente es 0 para reproductores Series 5 con una sola salida y todos los reproductores Series 4 y anteriores. El valor puede ser 0-3 para el XC4055, que tiene múltiples salidas, y 0 o 1 para el XC2055 y XT2145.
Ejemplo de solicitud
GET /rest/v1/video/hdmi/output/0/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+jsonCuerpo de la respuesta
Los siguientes campos estarán presentes en la respuesta:
- modoActivo: Información sobre el modo de video activo en el reproductor
- adjunto bool: Indica si la salida HDMI® está conectada o no
- bestMode string: El mejor modo de video para el reproductor. El conector HDMI debe estar conectado porque obtiene detalles del resultado EDID.
- configuredMode: El modo de video configurado en el reproductor. Esto puede ser diferente de activeMode.
- edid string: Devuelve la cadena EDID leída de la pantalla conectada al reproductor. Si el ahorro de energía está activado, se devolverán ceros
- edid_identity: Analiza la cadena anterior en un formato JSON para mejorar la legibilidad. Requiere una salida HDMI conectada al reproductor y una pantalla.
- modos: Lista de todos los modos de video disponibles en el reproductor.
- powerSaveStatus bool: Indica el estado de ahorro de energía de la pantalla conectada al reproductor.
- resoluciones resolutions[ ]: Un arreglo de información sobre los gráficos, la salida y la resolución de video. Devuelve valores de resultado para altura y anchura.
- estado:
- audioBitsPerSample int: El número de bits por muestra de audio
- cantidadDeCanalesDeAudio int: El número de canales de audio en la salida
- audioFormat string: El formato de la salida de audio. Un valor "PCM" indica que el reproductor está enviando salida decodificada.
- audioSampleRate int: La frecuencia de muestreo de audio (en hercios)
- eotf string: La función de transferencia electroóptica (EOTF) actual utilizada por la pantalla. Los siguientes son valores posibles:
- "HDR (GAMMA)"
- "SDR (GAMMA)"
- "SMPTE 2084 (PQ)"
- "Future (BBC/NHK)"
- "unspecified"
- salidaImpulsada bool: Indica si el dispositivo de pantalla está encendido (es decir, RX con alimentación)
- outputPresent bool: Indica si la salida HDMI está conectada a un dispositivo de pantalla o no.
- inestable bool: Indica si la señal de la pantalla es inestable o estable
Ejemplo de respuesta
GET /video/{:connector}/output/{:device}/edid/
Devuelve la información EDID de un monitor/televisor compatible conectado a la salida de video
Segmentos
- conector: El valor actual siempre es hdmi
- dispositivo: Actualmente, este valor en las URL /video/ es 0 para reproductores Series 5 de una sola salida y todos los reproductores Series 4 y anteriores. El valor puede ser 0-3 para el XC4055, que tiene múltiples salidas, y 0 o 1 para el XC2055 y XT2145.
Ejemplo de solicitud
GET /rest/v1/video/hdmi/output/0/edid/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+jsonCuerpo de la respuesta
- resultado string: El resultado de cadena EDID
Ejemplo de respuesta
{
"route": "/v1/video/hdmi/output/0/edid",
"method": "GET",
"data": {
"result": "00ffffffffffff004c2d0d050100000030120103801009780aee91a3544c99260f5054bdef80714f8111214081809500950fb3000101023a801871382d40582c4500a05a0000001e662150b051001b3040703600a05a0000001e000000fd00184b1a5117000a202020202020000000fc0053414d53554e470a2020202020016b020322f1469004050320222309070783010000e2000fe305030167030c001000b82d011d007251d01e206e285500a05a0000001e011d8018711c1620582c2500a05a0000009e8c0ad08a20e02d10103e9600a05a00000018000000000000000000000000000000000000000000000000000000000000000000000000000000ef00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
}
}GET /video/{:connector}/output/{:device}/power-save/
Recupera el estado de alimentación del monitor conectado al reproductor (según se informa mediante EDID)
Segmentos
- conector: El valor actual siempre es hdmi
- dispositivo: Actualmente, este valor en las URL /video/ es 0 para reproductores Series 5 de una sola salida y todos los reproductores Series 4 y anteriores. El valor puede ser 0-3 para el XC4055, que tiene múltiples salidas, y 0 o 1 para el XC2055 y XT2145.
Ejemplo de solicitud
GET /rest/v1/video/hdmi/output/0/power-save/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+jsonCuerpo de la respuesta
- is_connected bool: Indica si el monitor está conectado a la salida HDMI en el reproductor
- is_powered bool: Indica si el monitor está encendido (por ejemplo, RX con alimentación)
- habilitado bool: Indica si el modo de ahorro de energía ha sido habilitado en la salida HDMI/VGA
Ejemplo de respuesta
{
"route": "/v1/video/hdmi/output/0/power-save/",
"method": "GET",
"data": {
"result": {
"is_connected": true,
"is_powered": true,
"enabled": false
}
}
}PUT /video/{:connector}/output/{:device}/power-save/
Habilita o deshabilita el modo de ahorro de energía en el monitor conectado al reproductor (a través de HDMI, VGA o Component)
Segmentos
- conector: El valor actual siempre es hdmi
- dispositivo: Este valor en las URL /video/ es actualmente 0 para reproductores Series 5 de salida única y todos los reproductores Series 4 y anteriores. El valor puede ser 0-3 para el XC4055, que tiene múltiples salidas, y 0 o 1 para el XC2055 y XT2145.
Parámetros del cuerpo de la solicitud
- habilitado bool: Si el ahorro de energía está habilitado o no
Ejemplo de solicitud
PUT /rest/v1/video/hdmi/output/0/power-save/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Content-Type: application/json
Content-Length: 51Este es el cuerpo de solicitud de ejemplo:
{
"data": {
"enabled": true
}
}Cuerpo de la respuesta
El servidor devolverá un mensaje de éxito o error
Ejemplo de respuesta
{
"data": {
"result": true
},
"route": "/v1/video/hdmi/output/0/power-save",
"method": "PUT"
}GET /video/{:connector}/output/{:device}/modes/
Recupera todos los modos de video disponibles en la salida de video especificada
Segmentos
- conector: El valor actual siempre es hdmi
- dispositivo: Este valor en las URL /video/ es actualmente 0 para reproductores Series 5 de salida única y todos los reproductores Series 4 y anteriores. El valor puede ser 0-3 para el XC4055, que tiene múltiples salidas, y 0 o 1 para el XC2055 y XT2145.
Ejemplo de solicitud
GET /rest/v1/video/hdmi/output/0/modes/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+jsonCuerpo de la respuesta
Devuelve una matriz de objetos de modo de video, cada uno de los cuales contiene los siguientes parámetros:
- modeName string: El modo (por ejemplo, "1920x1080x60p")
- colorDepth string: La profundidad de color de la señal de video
- colorSpace string: El espacio de color de la señal de video ("rgb", "yuv420" o "yuv422")
- dropFrame bool: Indica si el código de tiempo del video usa drop frame o no
- frecuencia int: La frecuencia de cuadros de la salida de video
- ancho int: El ancho de la salida de video
- altura int: La altura de la salida de video
- graphicsPlaneWidth int: El ancho del plano gráfico
- graphicsPlaneHeight int: La altura del plano gráfico
- entrelazado bool: Indica si la salida de video es entrelazada o no
- sobrescaneo bool: Indica si la salida de video está usando una configuración de overscan o no
- preferido bool: Indica si el video es el modo preferido
Ejemplo de respuesta
GET /video/{:connector}/output/{:device}/mode/
Recupera el modo de video actual en la salida de video especificada
Segmentos
- conector: El valor actual siempre es hdmi
- dispositivo: Este valor en las URL de /video/ es actualmente 0 para reproductores Series 5 de una sola salida y todos los reproductores Series 4 y anteriores. El valor puede ser 0-3 para el XC4055, que tiene múltiples salidas, y 0 o 1 para el XC2055 y XT2145.
Parámetros de cadena de consulta
Cada uno de estos parámetros entrega un valor de modo diferente:
- mejor int optional: Si se establece en 1, esto devuelve el mejor modo
- activo int optional: Si se establece en 1, esto devuelve el modo activo
- configurado int optional: Si se establece en 1, esto devuelve el modo configurado
Ejemplos de solicitud
GET /rest/v1/video/hdmi/output/0/mode/?best=1&destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+jsonCuerpo de la respuesta
- isAutoMode bool: Si el modo está configurado en “auto”
- nombre string: El nombre del modo de video. Igual que mode.modeName a continuación.
- ancho string: El valor de ancho del modo de video.
- altura string: El valor de altura del modo de video.
- marcos string: El valor de la frecuencia de cuadros del modo de video.
- escanear string: El valor del carácter de escaneo del modo de video.
- modo object: El modo de video configurado actualmente en la salida de video con los siguientes parámetros -
- modeName string: El modo (por ejemplo, “1920x1080x60p”)
- colorDepth string: La profundidad de color de la señal de video
- colorSpace string: El espacio de color de la señal de video ("rgb", "yuv420" o "yuv422")
- dropFrame bool: Si el código de tiempo de video usa drop frame o no
- frecuencia int: La frecuencia de cuadros de la salida de video
- ancho int: El ancho de la salida de video
- altura int: La altura de la salida de video
- graphicsPlaneWidth int: El ancho del plano gráfico
- graphicsPlaneHeight int: La altura del plano gráfico
- entrelazado bool: Si la salida de video es entrelazada o no
- sobrescaneo bool: Si la salida de video está usando una configuración de overscan o no
- preferido bool: Si el video es el modo preferido o no
Ejemplo de respuesta
{
"route": "/v1/video/hdmi/output/0/mode/",
"method": "GET",
"data": {
"result": {
"isAutoMode": false,
"name": "1920x1080x60p",
"width": "1920",
"height": "1080",
"frames": "60",
"scan": "p",
"mode": {
"colorDepth": "8bit",
"colorSpace": "rgb",
"dropFrame": false,
"frequency": 60,
"graphicsPlaneHeight": 1080,
"graphicsPlaneWidth": 1920,
"height": 1080,
"interlaced": false,
"modeName": "1920x1080x60p",
"overscan": true,
"preferred": false,
"width": 1920
}
}
}
}PUT /video/{:connector}/output/{:device}/mode/
Cambia el modo de video en el reproductor
Segmentos
- conector: El valor actual siempre es hdmi
- dispositivo: Actualmente, este valor en las URL /video/ es 0 para reproductores Series 5 de una sola salida y todos los reproductores Series 4 y anteriores. El valor puede ser 0-3 para el XC4055, que tiene múltiples salidas, y 0 o 1 para el XC2055 y XT2145.
Parámetros del cuerpo de la solicitud
Un objeto de modo de video que contiene los siguientes valores:
- modeName string required: El modo (por ejemplo, "1920x1080x60p")
- colorDepth string optional: La profundidad de color de la señal de video
- colorSpace string optional: El espacio de color de la señal de video ("rgb", "yuv420" o "yuv422")
- dropFrame bool: Si el código de tiempo del video utiliza drop frame o no
- frecuencia int optional: La frecuencia de cuadros de la salida de video
- ancho int optional: El ancho de la salida de video
- altura int optional: La altura de la salida de video
- graphicsPlaneWidth int optional: El ancho del plano gráfico
- graphicsPlaneHeight int optional: La altura del plano gráfico
- entrelazado bool optional: Si la salida de video es entrelazada o no
- sobrescaneo bool optional: Si la salida de video está utilizando una configuración de overscan o no
- preferido bool optional: Si el video es el modo preferido o no
Ejemplo de solicitud
PUT /rest/v1/video/hdmi/output/0/mode/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Content-Type: application/json
Content-Length: 95Este es el cuerpo de la solicitud de ejemplo:
{
"data": {
"name": {
"modeName": "640x480x60p"
}
}
}Cuerpo de la respuesta
El servidor devolverá un mensaje de éxito o error. Una respuesta correcta casi siempre provocará un reinicio, lo cual se indicará en la respuesta.
- resultado object: El objeto de respuesta.
- éxito bool: Indica si la operación fue exitosa o no
- reinicio bool: Indica si el reproductor se está reiniciando o no
Ejemplo de respuesta
{
"data": {
"result": {
"success": true,
"reboot": true
}
},
"route": "/v1/video/hdmi/output/0/mode",
"method": "PUT"
}