Legrand / Raritan Xerus™ JSON-RPC API for Remote Access Devices like KX4-101, KX3G2
Loading...
Searching...
No Matches
radm::KvmChannel Interface Reference

Classes

struct  AttachedKvmPortChangedEvent
 Event: Attached KVM port changed. More...
struct  KvmSwitchEvent
 Event: Channel connection status changed. More...
 Channel meta data. More...
struct  VideoResolutionChangedEvent
 Event: Video resolution on channel changed. More...

Public Member Functions

Metadata getMetadata ()
 Get channel meta data.
KvmPort getAttachedKvmPort ()
 Get KVM port currently attached to this channel.
boolean hasLocalClient ()
 Get local client connection status.
int getConnectedRemoteClientCount ()
 Get number of connected remote clients.
VideoResolution getVideoResolution ()
 Get video resolution and refresh rate.

Detailed Description

Definition at line 10 of file KvmChannel.idl.

Member Function Documentation

◆ getAttachedKvmPort()

KvmPort radm::KvmChannel::getAttachedKvmPort ( )

Get KVM port currently attached to this channel.

If the device has more KVM ports than channels, the returned port may be empty, as such devices detach the port from the channel when it's not in use.

Returns
Attached KVM port

◆ getConnectedRemoteClientCount()

int radm::KvmChannel::getConnectedRemoteClientCount ( )

Get number of connected remote clients.

Returns
Total number of remote clients connected to this channel

◆ getMetadata()

Metadata radm::KvmChannel::getMetadata ( )

Get channel meta data.

Returns
Channel meta data

◆ getVideoResolution()

VideoResolution radm::KvmChannel::getVideoResolution ( )

Get video resolution and refresh rate.

Returns
Active video resolution and refresh rate of this channel

◆ hasLocalClient()

boolean radm::KvmChannel::hasLocalClient ( )

Get local client connection status.

Returns
true if the device local port is currently connected to this channel, false otherwise

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