Legrand / Raritan Xerus™ JSON-RPC API for Remote Access Devices like KX4-101, KX3G2

Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
radm::PortGroup Interface Reference

## Classes
struct | GroupConfig
| Configuration object for a plain port group. More...
struct | Metadata
| Group meta data. More...
struct | MultiMonitorConfig
| Configuration object for a multi-monitor group. More...
struct | Settings
struct | SettingsChangedEvent
| Event: Group settings have been changed. More...

## Public Member Functions
Metadata | getMetadata ()
| Get group meta data.
Settings | getSettings ()
| Get group settings.
int | setSettings (in Settings settings)
| Set group settings.

## Public Attributes
constant int | ERR_INVALID_ARGUMENT = 1

## Detailed Description

Definition at line 9 of file PortGroup.idl.

## Member Function Documentation

## ◆ getMetadata()

Metadata radm::PortGroup::getMetadata | ( |  | ) |

Get group meta data.

Returns
  Meta data

## ◆ getSettings()

Settings radm::PortGroup::getSettings | ( |  | ) |

Get group settings.

Returns
  Group settings

## ◆ setSettings()

int radm::PortGroup::setSettings | ( | in Settings | settings | ) |

Set group settings.

Parameters

  settings | New group settings

Returns
  0 on success
  1 if any given setting was invalid

## Member Data Documentation

## ◆ ERR_INVALID_ARGUMENT

constant int radm::PortGroup::ERR_INVALID_ARGUMENT = 1

Definition at line 10 of file PortGroup.idl.

The documentation for this interface was generated from the following file:

- PortGroup.idl