Retrieve the available usersets on the camera.
Message Envelope For ZMQ Message
| Frame | Field | Description | Type |
|---|---|---|---|
| 1 | payload | Method payload | Binary String (UTF-8) |
payload
| Field | Optional | Type | Description |
|---|---|---|---|
| TransactionID | Yes | String | Transaction identification. |
| Action | No | String | Method called. Fixed value GetUserSets |
| DeviceID | No | String | Device identification. |
{
"TransactionID": "1232116",
"Action": "GetUserSets",
"DeviceID": "12323454754"
}
Response
| Frame | Field | Description | Type |
|---|---|---|---|
| 1 | payload | Response object | Binary String (UTF-8) |
Response Object
| Field | Optional | Type | Description |
|---|---|---|---|
| TransactionID | Yes | String | Transaction identification. |
| ReturnCode | No | Integer | Message code following Message Codes. |
| Message | Yes | String | Response message |
| UserSetList | User Set Object Array | Object containing the available parameter settings |
User Set Object
| Field | Optional | Type | Description |
|---|---|---|---|
| DisplayName | Yes | String | This represents the name of the user set to the user |
| Value | No | String | Parameter value that needs to be used to set the user set value |
| IntValue | No | Int | Integer value of the user set |
| Description | Yes | String | User set description. |
{
"TransactionID": "12323454754",
"ReturnCode": 0,
"Message": "Userset retrieved.",
"UserSetList": [
{
"DisplayName": "Default User Set",
"Value": "Default",
"IntValue": 0,
"Description": "The default factory set can be loaded."
},
{
"DisplayName": "User Set 1",
"Value": "UserSet1",
"IntValue": 1,
"Description": "User set 1 can be saved, loaded, or configured."
},
{
"DisplayName": "User Set 2",
"Value": "UserSet2",
"IntValue": 2,
"Description": "User set 2 can be saved, loaded, or configured."
},
{
"DisplayName": "User Set 3",
"Value": "UserSet3",
"IntValue": 3,
"Description": "User set 3 can be saved, loaded, or configured."
}
]
}