Puntos finales de control de pantalla LDWS

44 min

Estas APIs de control de pantalla solo pueden utilizarse en pantallas Moka que tengan reproductores BrightSign integrados y solo están disponibles en BOS 9.0.189 y versiones posteriores.

GET /v1/display-control/

Devuelve todos los ajustes de control de una pantalla que está conectada a un reproductor BrightSign.

Ejemplo de solicitud

GET /api/v1/display-control/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Cuerpo de la respuesta

200: Esto devuelve los ajustes de control de pantalla, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "tvInfo": {
        "macAddress": "ff:ff:ff:ff:ff:ff",
        "wifiMacAddress": "ff:ff:ff:ff:ff:ff",
        "serialNo": "1234567890",
        "osVersion": "V8-AM963BS-0020015",
        "hwRevision": 1
      },
      "whiteBalance": {
        "redBalance": 120,
        "greenBalance": 120,
        "blueBalance": 120
      },
      "volume": 50,
      "brightness": 50,
      "contrast": 50,
      "idleStandbyTimeout": 50,
      "powerSetting": "on",
      "videoOutput": "HDMI1",
      "sdConnection": "brightsign",
      "alwaysConnectedEnabled": true
    }
  }
}

GET /v1/display-control/brightness/

Devuelve los ajustes de brillo de una pantalla que está conectada a un reproductor BrightSign.

Ejemplo de solicitud

GET /api/v1/display-control/brightness/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Cuerpo de la respuesta

200: Esto devuelve el ajuste de brillo de la pantalla, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "brightness": 100
    }
  }
}

PUT /v1/display-control/brightness/

Cambia el ajuste de brillo de una pantalla conectada a un reproductor BrightSign.

Ejemplo de solicitud

PUT /api/v1/display-control/brightness/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 18

Este es el cuerpo de solicitud de ejemplo:

{
  "brightness": 100
}

Cuerpo de la respuesta

200: Esto devuelve el ajuste de brillo actualizado de la pantalla, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true,
      "brightness": 100
    }
  }
}

GET /v1/display-control/contrast/

Devuelve los ajustes de contraste de una pantalla que está conectada a un reproductor BrightSign.

Ejemplo de solicitud

GET /api/v1/display-control/contrast/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Cuerpo de la respuesta

200: Esto devuelve el ajuste de contraste de la pantalla, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "contrast": 45
    }
  }
}

PUT /v1/display-control/contrast/

Cambia el contraste de una pantalla conectada a un reproductor BrightSign.

Ejemplo de solicitud

PUT /api/v1/display-control/contrast/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 22

Este es el cuerpo de solicitud de ejemplo:

{
  "contrast": 45
}

Cuerpo de la respuesta

200: Esto devuelve la configuración de contraste actualizada para la pantalla, como se muestra en el ejemplo a continuación.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true,
      "contrast": 45
    }
  }
}

GET /v1/display-control/always-connected/

Devuelve la configuración de conexión para una pantalla conectada a un reproductor BrightSign.

Ejemplo de solicitud

GET /api/v1/display-control/always-connected/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Cuerpo de la respuesta

200: Esto devuelve la configuración de conexión para la pantalla, como se muestra en el ejemplo a continuación.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "enabled": true
    }
  }
}

PUT /v1/display-control/always-connected/

Cambia la configuración de conexión de una pantalla conectada a un reproductor BrightSign.

Ejemplo de solicitud

PUT /api/v1/display-control/always-connected/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 23

Este es el ejemplo de cuerpo de solicitud:

{
  "enable": true
}

Cuerpo de la respuesta

200: Devuelve la configuración de conexión para la pantalla como verdadero, como se muestra en el ejemplo a continuación.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true,
      "enable": true
    }
  }
}

GET /v1/display-control/always-on/

Devuelve una configuración de conexión (si está siempre activa o no) para una pantalla conectada al reproductor. Consulte esta página para obtener una explicación de esta configuración.

Ejemplo de solicitud

GET /api/v1/display-control/always-on/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Cuerpo de la respuesta

200: Esto devuelve la configuración de conexión para la pantalla, como se muestra en el ejemplo a continuación.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "enabled": true
    }
  }
}

PUT /v1/display-control/always-on/

Le permite configurar la conexión de la pantalla para que esté siempre activa. Consulte esta página para obtener una explicación de esta configuración.

Ejemplo de solicitud

PUT /api/v1/display-control/always-on/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 23

Este es el ejemplo de cuerpo de solicitud:

{
  "enable": true
}

Cuerpo de la respuesta

200: Devuelve la configuración de conexión para la pantalla como verdadero, como se muestra en el ejemplo a continuación.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true,
      "enable": true
    }
  }
}

PUT /v1/display-control/firmware/

Cambia la configuración del firmware de una pantalla conectada a un reproductor BrightSign.

Ejemplo de solicitud

PUT /api/v1/display-control/firmware/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 105

El cuerpo de ejemplo de la solicitud puede ser filepath o url:

{
  "filepath": "path/to/firmware/relative/to/sd",
}

{
  "url": "https://example.com/tv-firmware.zip"
}

Cuerpo de la respuesta

202: Esto actualiza el firmware y reinicia el reproductor, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true,
      "reboot": true
    }
  }
}

GET /v1/display-control/info/

Devuelve la configuración del reproductor BrightSign que está conectado a una pantalla

Ejemplo de solicitud

GET /api/v1/display-control/info/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Cuerpo de la respuesta

200: Esto devuelve la información sobre la pantalla que está conectada a un reproductor BrightSign, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "macAddress": "ff:ff:ff:ff:ff:ff",
      "serialNo": "1234567890",
      "osVersion": "V8-AM963BS-0020015",
      "hwRevision": 2,
      "wifiMacAddress": "ff:ff:ff:ff:ff:ff"
    }
  }
}

GET /v1/display-control/power-settings/

Devuelve la configuración de energía de una pantalla que está conectada a un reproductor BrightSign.

Ejemplo de solicitud

GET /api/v1/display-control/power-settings/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Cuerpo de la respuesta

200: Esto devuelve la configuración de energía de la pantalla, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "setting": "on"
    }
  }
}

PUT /v1/display-control/power-settings/

Cambia la configuración de energía de una pantalla conectada a un reproductor BrightSign.

Ejemplo de solicitud

PUT /api/v1/display-control/power-settings/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 38

Este es el cuerpo de ejemplo de la solicitud:

{
  "setting": "standby"
}

Cuerpo de la respuesta

200: Esto devuelve la configuración de energía actualizada para la pantalla, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true,
      "setting": "standby"
    }
  }
}

GET /v1/display-control/standby-timeout/

Devuelve la configuración de espera/tiempo de espera para una pantalla que está conectada a un reproductor BrightSign.

Ejemplo de solicitud

GET /api/v1/display-control/standby-timeout/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Cuerpo de la respuesta

200: Esto devuelve la configuración de espera/tiempo de espera para la pantalla, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "seconds": 60
    }
  }
}

PUT /v1/display-control/standby-timeout/

Cambia la configuración de standby/timeout de una pantalla conectada a un reproductor BrightSign.

Ejemplo de solicitud

PUT /api/v1/display-control/standby-timeout/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 19

Este es el cuerpo de solicitud de ejemplo:

{
  "seconds": 60
}

Cuerpo de respuesta

200: Esto devuelve la configuración actualizada de standby/timeout para la pantalla, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true,
      "seconds": 60
    }
  }
}

GET /v1/display-control/sd-connection/

Devuelve la configuración de conexión SD para una pantalla conectada a un reproductor BrightSign.

Ejemplo de solicitud

GET /api/v1/display-control/sd-connection/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Cuerpo de respuesta

200: Esto devuelve la configuración de conexión SD para la pantalla, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "connection": "brightsign"
    }
  }
}

PUT /v1/display-control/sd-connection/

Cambia la configuración de conexión SD de una pantalla conectada a un reproductor BrightSign. El control de la tarjeta SD se transfiere ya sea a la pantalla (pantalla) o al reproductor BrightSign (brightsign)

Ejemplo de solicitud

PUT /api/v1/display-control/usb-connection/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 19

Este es el cuerpo de solicitud de ejemplo:

{
  "connection": "display"
}

Cuerpo de respuesta

200: Esto devuelve la configuración de conexión SD actualizada para la pantalla, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true,
      "connection": "display"
    }
  }
}

GET /v1/display-control/video-output/

Devuelve la configuración de salida de video para una pantalla conectada a un reproductor BrightSign.

Ejemplo de solicitud

GET /api/v1/display-control/video-output/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Cuerpo de respuesta

200: Esto devuelve la configuración de salida de video para la pantalla, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "output": "HDMI1"
    }
  }
}

PUT /v1/display-control/video-output/

Cambia la configuración de salida de video de una pantalla conectada a un reproductor BrightSign.

Ejemplo de solicitud

PUT /api/v1/display-control/video-output/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 18

Este es el cuerpo de solicitud de ejemplo:

{
  "output": "HDMI2"
}

Cuerpo de respuesta

200: Esto devuelve la configuración actualizada de la conexión de salida de video para la pantalla, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true,
      "output": "HDMI2"
    }
  }
}

GET /v1/display-control/volume/

Devuelve la configuración de volumen de una pantalla que está conectada a un reproductor BrightSign.

Ejemplo de solicitud

GET /api/v1/display-control/volume/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Cuerpo de la respuesta

200: Esto devuelve la configuración de volumen de la pantalla, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "volume": 50
    }
  }
}

PUT /v1/display-control/volume/

Cambia el volumen de una pantalla conectada a un reproductor BrightSign.

Ejemplo de solicitud

PUT /api/v1/display-control/volume/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 16

Este es el cuerpo de solicitud de ejemplo:

{
  "volume": 100
}

Cuerpo de la respuesta

200: Esto devuelve la configuración de volumen actualizada para la pantalla, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true,
      "volume": 100
    }
  }
}

GET /v1/display-control/white-balance/

Devuelve la configuración de balance de blancos de una pantalla que está conectada a un reproductor BrightSign.

Ejemplo de solicitud

GET /api/v1/display-control/white-balance/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Cuerpo de la respuesta

200: Esto devuelve la configuración de balance de blancos para la pantalla, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "redBalance": 120,
      "greenBalance": 120,
      "blueBalance": 120
    }
  }
}

PUT /v1/display-control/white-balance/

Cambia el balance de blancos de una pantalla conectada a un reproductor BrightSign.

Ejemplo de solicitud

PUT /api/v1/display-control/white-balance/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 48

Este es el cuerpo de solicitud de ejemplo:

{
  "redBalance": 120,
  "greenBalance": 120,
  "blueBalance": 120
}

Cuerpo de la respuesta

200: Esto devuelve la configuración actualizada de balance de blancos para la pantalla, como se muestra en el siguiente ejemplo.

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true,
      "redBalance": 120,
      "greenBalance": 120,
      "blueBalance": 120
    }
  }
}