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
            }
        },
        {
            "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
            }
        }
    ],
    "currentMonitor": 0,
    "result": true
}

Parameter description:

• name — Monitor name

• primary — the flag indicating if the display is selected as the primary screen

• 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 of VideoSDK/Room is displayed

• ignored - a flag indicating whether this screen was added to the ignored list using the command-line parameter --ignore_monitor when launching VideoSDK/Room

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

See also:

• changeCurrentMonitor
• monitorsInfoUpdated