Puntos finales de video LDWS
14 min
GET /v1/video/:connector/output/:device/
Recupera información sobre la salida de video especificada.
Segmentos
- conector: El valor actual siempre es hdmi
- dispositivo: Este valor 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
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- :connector se establece en hdmi
- :device se establece en 0
GET /api/v1/video/hdmi/output/0/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/jsonCuerpo de la respuesta
- resoluciones resolutions[ ]: Un arreglo de información sobre la resolución de gráficos, salida y video. Devuelve valores de resultado para altura y ancho.
- edid_identity: Analiza la cadena anterior en un formato JSON para mejorar la legibilidad. Requiere una salida HDMI conectada al reproductor y una pantalla.
- edid string: Devuelve la cadena de lectura EDID de la pantalla conectada al reproductor. Si el ahorro de energía está activado, se devolverán ceros
- estado:
- audioBitsPerSample int: La cantidad de bits por muestra de audio
- audioChannelCount int: La cantidad 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"
- outputPowered bool: Si el dispositivo de pantalla está encendido (es decir, RX con alimentación)
- outputPresent bool: Si la salida HDMI está conectada a un dispositivo de pantalla o no.
- inestable bool: Si la señal de pantalla es inestable o estable
- modos: Lista de todos los modos de video disponibles en el reproductor.
- activeMode: Información sobre el modo de video activo en el reproductor
- 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.
- powerSaveStatus bool: Este valor indica el estado de ahorro de energía de la pantalla conectada al reproductor.
Ejemplo de respuesta
GET /v1/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: Este valor es 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
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- :connector se establece en hdmi
- :device se establece en 0
GET /api/v1/video/hdmi/output/0/edid/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/jsonEjemplo de respuesta
resultado es el resultado de la cadena EDID
{
"data": {
"result": "00ffffffffffff004c2d0d050100000030120103801009780aee91a3544c99260f5054bdef80714f8111214081809500950fb3000101023a801871382d40582c4500a05a0000001e662150b051001b3040703600a05a0000001e000000fd00184b1a5117000a202020202020000000fc0053414d53554e470a2020202020016b020322f1469004050320222309070783010000e2000fe305030167030c001000b82d011d007251d01e206e285500a05a0000001e011d8018711c1620582c2500a05a0000009e8c0ad08a20e02d10103e9600a05a00000018000000000000000000000000000000000000000000000000000000000000000000000000000000ef00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
}
}GET /v1/video/:connector/output/:device/power-save/
Recupera el estado de energía del monitor conectado al reproductor.
Segmentos
- conector: El valor actual siempre es hdmi
- dispositivo: Este valor es 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
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- :connector se establece en hdmi
- :device se establece en 0
GET /api/v1/video/hdmi/output/0/power-save/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/jsonCuerpo de la respuesta
- is_connected bool: Indica si el monitor está conectado a la salida HDMI del 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 se ha habilitado en la salida HDMI/VGA
Ejemplo de respuesta
{
"data": {
"result": {
"is_connected": true,
"is_powered": true,
"enabled": false
}
}
}PUT /v1/video/:connector/output/:device/power-save/
Habilita o deshabilita el modo de ahorro de energía en el monitor conectado al reproductor.
Segmentos
- conector: El valor actual siempre es hdmi
- dispositivo: Este valor 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
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- :connector se establece en hdmi
- :device se establece en 0
PUT /api/v1/video/hdmi/output/0/power-save/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 51Este es un ejemplo de cuerpo de solicitud que habilita el modo de ahorro de energía:
{
"enabled": true
}Ejemplo de respuesta
{
"data": {
"result": true
}
}GET /v1/video/:connector/output/:device/modes/
Devuelve una lista de todos los modos de video disponibles en la salida de video especificada.
Segmentos
- conector: El valor actual siempre es hdmi
- dispositivo: Este valor 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
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- :connector se establece en hdmi
- :device se establece en 0
GET /api/v1/video/hdmi/output/0/modes/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/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”)
- Profundidad de color 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 del video utiliza drop frame o no
- frecuencia int: La velocidad de fotogramas 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á utilizando una configuración de overscan o no
- preferido bool: Si el video es el modo preferido o no
Ejemplo de respuesta
GET /v1/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 es 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 de la Query String
Cada uno de estos parámetros devuelve un valor de modo diferente:
- mejor int optional: Si se establece en 1, devuelve el mejor modo
- activo int optional: Si se establece en 1, devuelve el modo activo
- configurado int optional: Si se establece en 1, devuelve el modo configurado
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- :connector se establece en hdmi
- :device se establece en 0
- mejor se establece en 1
GET /api/v1/video/hdmi/output/0/mode/?best=1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/jsonCuerpo de la respuesta
- isAutoMode bool: Indica si el modo está configurado como “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.
- escaneo string: El valor del carácter de escaneo del modo de video.
- modo object: El modo de video actualmente configurado en la salida de video con los siguientes parámetros -
- modeName string: El modo (por ejemplo, “1920x1080x60p”)
- Profundidad de color 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 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: 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
{
"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 /v1/video/:connector/output/:device/mode/
Cambia el modo de video en el reproductor. Primero debe enviar una solicitud GET para encontrar los parámetros del cuerpo de esta API, pero solo el parámetro modeName es obligatorio.
Segmentos
- conector: El valor actual siempre es hdmi
- dispositivo: Este valor 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.
Cuerpo de la solicitud
Un objeto de modo de video que contiene los siguientes valores:
- modeName string required: El modo (por ejemplo, “1920x1080x60p”). Consulte Modos de video compatibles para obtener una lista de las posibles cadenas válidas para su reproductor
- Profundidad de color 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 optional: Si el código de tiempo del video usa drop frame o no
- frecuencia int optional: La velocidad de fotogramas 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 /api/v1/video/hdmi/output/0/mode/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 95Este es el cuerpo de la solicitud de ejemplo:
{
"name": {
"modeName": "640x480x60p"
}
}Cuerpo de la respuesta
El servidor devolverá un mensaje de éxito o error. Una respuesta exitosa casi siempre provocará un reinicio, lo cual se indicará en la respuesta.
- éxito bool: Si la operación fue exitosa o no
- reiniciar bool: Si el reproductor se está reiniciando o no
Ejemplo de respuesta
{
"data": {
"result": {
"success": true,
"reboot": true
}
}
}