queryHeadsets

Discover details about headsets connected to your device via USB dongle, USB cable, or Bluetooth or virtual headsets enabled through the EMOTIV Launcher. Additionally, search for a specific headset using its ID or apply a wildcard for partial matches.

Parameters

Name	Type	Required	Description
id	string	No	A headset id or a wildcard
includeFlexMappings	boolean	No	Set this parameter to true to include the mapping of each EPOC FLEX headset in the result headset object.

For the parameter id, you can use these wildcards:

Wildcard	Filter
INSIGHT-*	All Insight headsets
EPOC-*	All Epoc headsets
EPOCPLUS-*	All Epoc Plus headsets

Result

The result is an array of headset objects, or an empty array if no headset matches the request.

Examples

Query all the headsets

Request

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "queryHeadsets"
}

Response

If no headset matches your request, then the result is an empty array.

Request

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "queryHeadsets"
}

Response

Query a headset by its id

Request

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "queryHeadsets",
    "params": {
        "id": "EPOCPLUS-3B9AXXXX"
    }
}

Response

Query all the Insight headsets

Request

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "queryHeadsets",
    "params": {
        "id": "INSIGHT-*"
    }
}

Response