|
Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
|
The channel interface. More...
import <WebcamChannel.idl;
Public Member Functions | |
| string | getClientType () |
| Retrieve the channel type. | |
| Webcam | getWebcam () |
| Retrieve the webcam. | |
| boolean | isAvailable () |
| Determine whether the channel is available. | |
| void | release () |
| Releases the channel to allow lower proritized clients to view an image otherwise the channel expires when it is unused (neither a image related method nor "isAvailable" is called) for 20 seconds. | |
| int | captureImage (out Image image) |
| Retrieve a image. | |
| int | triggerCapture (out string captureToken) |
| Triggers the capture process to the temporary folder and returns a capture token to view them. | |
Public Attributes | |
| constant int | NO_ERROR = 0 |
| Error codes. | |
| constant int | ERR_NOT_AVAILABLE = 2 |
| Channel is not available. | |
| constant int | ERR_NO_SUCH_OBJECT = 3 |
| Requested object does not exist. | |
The channel interface.
Definition at line 12 of file WebcamChannel.idl.
| int webcam::Channel::captureImage | ( | out Image | image | ) |
Retrieve a image.
| image | Result: the image |
| string webcam::Channel::getClientType | ( | ) |
Retrieve the channel type.
| Webcam webcam::Channel::getWebcam | ( | ) |
Retrieve the webcam.
| boolean webcam::Channel::isAvailable | ( | ) |
Determine whether the channel is available.
A channel may become unavailable when higher prioritized viewers are active.
| int webcam::Channel::triggerCapture | ( | out string | captureToken | ) |
Triggers the capture process to the temporary folder and returns a capture token to view them.
The capture token is valid for 9 seconds and needs to be refreshed when, or even better before the old token expires.
| captureToken | Result: a new captureToken |
| constant int webcam::Channel::ERR_NO_SUCH_OBJECT = 3 |
Requested object does not exist.
Definition at line 18 of file WebcamChannel.idl.
| constant int webcam::Channel::ERR_NOT_AVAILABLE = 2 |
Channel is not available.
Definition at line 17 of file WebcamChannel.idl.
| constant int webcam::Channel::NO_ERROR = 0 |