CamOverlayAPI

Module for access to CamOverlay HTTP interface.

Methods

CamOverlayAPI(options) - Options parameter contains access to the camera and service ID. Values mentioned in example below are default.

CamOverlayAPI({
    tls: false,
    tlsInsecure: false,
    ip: '127.0.0.1',
    port: 80,
    auth: '',
});

updateCGText(serviceID, fields) - Updates text fields listed in parameter fields.

One field is defined as follows. Parameter "color" is optional.
```
```json
{
    "field_name": "NAME_OF_YOUR_FIELD",
    "text": "UPDATED_TEXT",
    "color": "COLOR"
}
```
```
updateCGImagePos(serviceID, coordinates, x, y) - Changes position of Custom Graphics.

Coordinates values: "top_left", "top_right", "bottom_left", "bottom_right", "left", "right" , "top", "bottom", "center"
updateCGImage(serviceID, path, [coordinates, x, y]) - Updates Custom Graphics background to an image with specified path on the camera. If no coordinates are specified, the service will use positioning from the last update.
updateInfoticker(serviceID, text) - Updates text in Infoticker service, if any is running.
setEnabled(serviceID, enabled) - Enables/disables the bound CO service.
isEnabled(serviceID) - Returns whether the bound CO service is enabled (true) or disabled (false).