|
Raritan PX2/PX3 JSON-RPC API
|
The channel interface. More...
import"WebcamChannel.idl";
Public Member Functions | |
| string | getClientType () |
| Retrieve the channel type. More... | |
| Webcam_2_0_1 | getWebcam () |
| Retrieve the webcam. More... | |
| boolean | isAvailable () |
| Determine whether the channel is available. More... | |
| 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_2_0_0 image) |
| Retrieve a image. More... | |
| int | triggerCapture (out string captureToken) |
| Triggers the capture process to the temporary folder and returns a capture token to view them. More... | |
Public Attributes | |
| constant int | NO_ERROR = 0 |
| Error codes. More... | |
| 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.
| int webcam::Channel_1_0_1::captureImage | ( | out Image_2_0_0 | image | ) |
Retrieve a image.
| image | Result: the image |
| string webcam::Channel_1_0_1::getClientType | ( | ) |
Retrieve the channel type.
| Webcam_2_0_1 webcam::Channel_1_0_1::getWebcam | ( | ) |
Retrieve the webcam.
| boolean webcam::Channel_1_0_1::isAvailable | ( | ) |
Determine whether the channel is available.
A channel may become unavailable when higher prioritized viewers are active.
| int webcam::Channel_1_0_1::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_1_0_1::NO_ERROR = 0 |
Error codes.
Operation successful, no error
1.8.14