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

Loading...
Searching...
No Matches
LocalMonitor.idl
1#ifndef __RADM_LOCALMONITOR_IDL__
2#define __RADM_LOCALMONITOR_IDL__
3
4#include <Event.idl>
5#include <VideoResolution.idl>
6
7module radm {
8
9 interface LocalMonitor {
10
11 structure Metadata {
12 string label; ///< Local moniter label
13 int idx; ///< Local monitor index
14 };
15
16 structure Status {
17 boolean detected; ///< Whether local monitor is detected.
18 vector<VideoResolution> supportedResolutions; ///< list of supported resolutions of local monitor connected
19 int preferredIndex; ///< Index of preferred resolution in the above supportedResolutions list
20 string edidDescription; ///< Decode EDID data provided by local monitor in human-readable format
21 };
22
23 /**
24 * Get port meta data
25 *
26 * @return Meta data of this port
27 */
28 Metadata getMetadata();
29
30 /**
31 * Get port settings
32 *
33 * @return Port settings
34 */
35 Status getStatus();
36
37 /** Event: Status has changed */
38 valueobject StatusChangeEvent extends idl.Event {
39 Status oldStatus; ///< status before change
40 Status newStatus; ///< status after change
41 };
42
43 };
44
45}
46
47#endif //__RADM_LOCALMONITOR_IDL__
radm::LocalMonitor
Definition LocalMonitor.idl:9
radm::LocalMonitor::getMetadata
Metadata getMetadata()
Get port meta data.
radm::LocalMonitor::getStatus
Status getStatus()
Get port settings.
idl
Basic IDL definitions.
Definition Event.idl:10
radm
Radm Model.
Definition AccessPort.idl:8
idl::Event
Common base for all events.
Definition Event.idl:13
radm::LocalMonitor::Metadata
Definition LocalMonitor.idl:11
radm::LocalMonitor::Metadata::label
string label
Local moniter label.
Definition LocalMonitor.idl:12
radm::LocalMonitor::Metadata::idx
int idx
Local monitor index.
Definition LocalMonitor.idl:13
radm::LocalMonitor::StatusChangeEvent
Event: Status has changed.
Definition LocalMonitor.idl:38
radm::LocalMonitor::StatusChangeEvent::oldStatus
Status oldStatus
status before change
Definition LocalMonitor.idl:39
radm::LocalMonitor::StatusChangeEvent::newStatus
Status newStatus
status after change
Definition LocalMonitor.idl:40
radm::LocalMonitor::Status
Definition LocalMonitor.idl:16
radm::LocalMonitor::Status::preferredIndex
int preferredIndex
Index of preferred resolution in the above supportedResolutions list.
Definition LocalMonitor.idl:19
radm::LocalMonitor::Status::edidDescription
string edidDescription
Decode EDID data provided by local monitor in human-readable format.
Definition LocalMonitor.idl:20
radm::LocalMonitor::Status::supportedResolutions
vector< VideoResolution > supportedResolutions
list of supported resolutions of local monitor connected
Definition LocalMonitor.idl:18
radm::LocalMonitor::Status::detected
boolean detected
Whether local monitor is detected.
Definition LocalMonitor.idl:17