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

Loading...
Searching...
No Matches
KvmChannel.idl
1#ifndef __RADM_KVM_CHANNEL_IDL__
2#define __RADM_KVM_CHANNEL_IDL__
3
4#include <UserEvent.idl>
5#include <VideoResolution.idl>
6#include <KvmPort.idl>
7
8module radm {
9
10 interface KvmChannel {
11
12 structure Metadata {
13 string label;
14 int channelId; ///< data link index
15 int maxRemoteClients;
16 int maxLocalClients;
17 int maxUsbChannels; ///< maximum USB channel
18 };
19
20 Metadata getMetadata();
21
22 KvmPort getAttachedKvmPort();
23
24 boolean hasLocalClient();
25
26 int getConnectedRemoteClientCount();
27
28 VideoResolution getVideoResolution();
29
30 valueobject AttachedKvmPortChangedEvent extends idl.Event {
31 KvmPort newPort;
32 };
33
34 valueobject KvmSwitchEvent extends event.UserEvent {
35 KvmPort port; ///< KVM port for operation
36 boolean connected; ///< whether port was switched on or off
37 int connectedRemoteClients; ///< Total number of connected remote clients
38 boolean hasLocalClient; ///< Whether the device local port is currently connected to this channel
39 };
40
41 valueobject VideoResolutionChangedEvent extends idl.Event {
42 KvmPort port; ///< KVM port operation on
43 VideoResolution newResolution;
44 };
45 };
46
47}
48
49#endif //__RADM_KVM_CHANNEL_IDL__
radm::KvmChannel
Definition KvmChannel.idl:10
radm::KvmPort
Definition KvmPort.idl:11
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::KvmChannel::AttachedKvmPortChangedEvent
Definition KvmChannel.idl:30
radm::KvmChannel::KvmSwitchEvent
Definition KvmChannel.idl:34
radm::KvmChannel::KvmSwitchEvent::hasLocalClient
boolean hasLocalClient
Whether the device local port is currently connected to this channel.
Definition KvmChannel.idl:38
radm::KvmChannel::KvmSwitchEvent::port
KvmPort port
KVM port for operation.
Definition KvmChannel.idl:35
radm::KvmChannel::KvmSwitchEvent::connected
boolean connected
whether port was switched on or off
Definition KvmChannel.idl:36
radm::KvmChannel::KvmSwitchEvent::connectedRemoteClients
int connectedRemoteClients
Total number of connected remote clients.
Definition KvmChannel.idl:37
radm::KvmChannel::Metadata
Definition KvmChannel.idl:12
radm::KvmChannel::Metadata::maxUsbChannels
int maxUsbChannels
maximum USB channel
Definition KvmChannel.idl:17
radm::KvmChannel::Metadata::channelId
int channelId
data link index
Definition KvmChannel.idl:14
radm::KvmChannel::VideoResolutionChangedEvent
Definition KvmChannel.idl:41
radm::KvmChannel::VideoResolutionChangedEvent::port
KvmPort port
KVM port operation on.
Definition KvmChannel.idl:42
radm::VideoResolution
Definition VideoResolution.idl:6