getMonitorsInfo

TrueConfAbout 2 min

getMonitorsInfo

Description: Obtain information about monitors.

Request example:

{
    "method" : "getMonitorsInfo",
    "requestId" : "1"
}

Response example:

{
    "method": "getMonitorsInfo",
    "requestId" : "1",
    "monitors": [
        {
            "name": "PHL 275E1",
            "primary": true,
            "index": 0,
            "ignored": false,
            "geomMonitor": {
                "x": 0,
                "y": 0,
                "width": 2560,
                "height": 1440
            },
            "geomWork": {
                "x": 0,
                "y": 0,
                "width": 2560,
                "height": 1380
            },
            "deviceInstancePath": "display\\phl2751e\\4&16666148&0&uid265988",
            "id": "display\\phl2751e\\4&16666148&0&uid265988"
        },
        {
            "name": "Generic PnP Monitor",
            "primary": false,
            "index": 1,
            "ignored": false,
            "geomMonitor": {
                "x": 2560,
                "y": 0,
                "width": 1920,
                "height": 1080
            },
            "geomWork": {
                "x": 2560,
                "y": 0,
                "width": 1920,
                "height": 1032
            },
            "deviceInstancePath": "display\\lgd0457\\4&1e135148&0&uid589647",
            "id": "display\\lgd0457\\4&1e135148&0&uid589647"
        }
    ],
    "currentMonitor": 0,
    "result": true
}

Parameter description:

  • name β€” Monitor name

  • primary β€” the flag indicating if the display is selected as the primary screen

  • deviceInstancePath - unique monitor identifier in the system Deprecated

  • id - unique monitor identifier in the system

  • geomMonitor β€” Geometry of a monitor

  • geomWork β€” Geometry of a monitor work area

  • x β€” x-axis screen coordinate

  • y β€” y-axis screen coordinate

  • width β€” screen width, specified in pixels

  • height β€” screen height, specified in pixels

  • index β€” Monitor index

  • currentMonitor - the index of the monitor where the main window is located TrueConf Room API

  • ignored - a flag indicating whether this screen has been added to the ignored list using the command line parameter --ignore_monitor at startup. TrueConf Room API

  • requestId - a unique request identifier. You can find more details about it here.

See also: