| Raritan PX2/PX3 JSON-RPC API
    | 
The storage manager interface. More...
import"StorageManager.idl";
| Classes | |
| struct | Activity | 
| Activity.  More... | |
| struct | ImageStorageMetaData | 
| StorageMetaData.  More... | |
| struct | StorageImage | 
| StorageImage.  More... | |
| struct | StorageInformation | 
| Information.  More... | |
| struct | StorageMetaData | 
| StorageMetaData.  More... | |
| struct | StorageSettings | 
| Settings.  More... | |
| struct | WebcamStorageInfo | 
| Webcam Storage Info.  More... | |
| Public Types | |
| enum | StorageType { LOCAL, FTP, CIFS, NFS } | 
| StorageType.  More... | |
| enum | Direction { ASCENDING, DESCENDING } | 
| Direction.  More... | |
| enum | StorageStatus { INITIALIZING, READY } | 
| StorageStatus.  More... | |
| Public Member Functions | |
| vector< StorageType > | getSupportedStorageTypes () | 
| Get supported storage types.  More... | |
| StorageInformation | getInformation () | 
| get storage information  More... | |
| StorageSettings | getSettings () | 
| get storage settings  More... | |
| int | setSettings (in StorageSettings settings) | 
| set storage settings  More... | |
| int | addImage (in Webcam_2_0_1 webcam, in Image_2_0_0 image, out long index) | 
| add an image to the storage  More... | |
| int | removeImages (in Webcam_2_0_1 webcam, in long start, in int count, in Direction direction) | 
| remove an image of the storage  More... | |
| int | getMetaData (in Webcam_2_0_1 webcam, in long start, in int count, in Direction direction, out vector< ImageStorageMetaData > meta) | 
| get meta data of images from storage  More... | |
| int | getImages (in Webcam_2_0_1 webcam, in long start, in int count, in Direction direction, out vector< StorageImage > image) | 
| retrieve images from the storage  More... | |
| vector< Activity > | getActivities () | 
| get all running activities  More... | |
| int | startActivity (in Webcam_2_0_1 webcam, in int count, in int interval) | 
| start a capture activity  More... | |
| int | startActivityWithFolder (in Webcam_2_0_1 webcam, in int count, in int interval, in string folder) | 
| Start a capture activity, storing the images to a specific storage folder.  More... | |
| int | stopActivity (in Webcam_2_0_1 webcam) | 
| stop a capture activity  More... | |
| Public Attributes | |
| constant int | NO_ERROR = 0 | 
| Error codes.  More... | |
| constant int | ERR_INVALID_PARAM = 1 | 
| Invalid parameter for an operation. | |
| constant int | ERR_INIT_IN_PROGRESS = 2 | 
| Storage information is going to be initialized. | |
| constant int | ERR_ALREADY_RUNNING = 3 | 
| The activity is already running. | |
| constant int | ERR_TOO_LARGE = 4 | 
| The requested result is too large. | |
| constant int | ERR_OPERATION_NOT_SUPPORTED = 5 | 
| The requested operation is not supported on the current storage type. | |
| valueobject | ImageUploadStartedEvent: event::UserEvent { Webcam_2_0_1 webcam | 
| Event: image upload to storage started.  More... | |
| string | folderUrl | 
| URL under which the containing folder can be accessed. | |
The storage manager interface.
| int webcam::StorageManager_1_0_2::addImage | ( | in Webcam_2_0_1 | webcam, | 
| in Image_2_0_0 | image, | ||
| out long | index | ||
| ) | 
add an image to the storage
| webcam | image source webcam | 
| image | image | 
| index | index of the added image | 
| vector<Activity> webcam::StorageManager_1_0_2::getActivities | ( | ) | 
get all running activities
| int webcam::StorageManager_1_0_2::getImages | ( | in Webcam_2_0_1 | webcam, | 
| in long | start, | ||
| in int | count, | ||
| in Direction | direction, | ||
| out vector< StorageImage > | image | ||
| ) | 
retrieve images from the storage
| webcam | image source webcam | 
| start | start index | 
| count | number of images | 
| direction | index counting direction | 
| image | result: list of storage images | 
| StorageInformation webcam::StorageManager_1_0_2::getInformation | ( | ) | 
get storage information
| int webcam::StorageManager_1_0_2::getMetaData | ( | in Webcam_2_0_1 | webcam, | 
| in long | start, | ||
| in int | count, | ||
| in Direction | direction, | ||
| out vector< ImageStorageMetaData > | meta | ||
| ) | 
get meta data of images from storage
| webcam | image source webcam | 
| start | start index | 
| count | number of images | 
| direction | index counting direction | 
| meta | result: list of storage meta data | 
| StorageSettings webcam::StorageManager_1_0_2::getSettings | ( | ) | 
get storage settings
| vector<StorageType> webcam::StorageManager_1_0_2::getSupportedStorageTypes | ( | ) | 
Get supported storage types.
| int webcam::StorageManager_1_0_2::removeImages | ( | in Webcam_2_0_1 | webcam, | 
| in long | start, | ||
| in int | count, | ||
| in Direction | direction | ||
| ) | 
remove an image of the storage
| webcam | image source webcam | 
| start | start index | 
| count | number of images | 
| direction | index counting direction | 
| int webcam::StorageManager_1_0_2::setSettings | ( | in StorageSettings | settings | ) | 
set storage settings
| settings | settings structure | 
| int webcam::StorageManager_1_0_2::startActivity | ( | in Webcam_2_0_1 | webcam, | 
| in int | count, | ||
| in int | interval | ||
| ) | 
start a capture activity
| webcam | webcam | 
| count | number of images to store, zero is interpreted as infinite | 
| interval | interval in ms | 
| int webcam::StorageManager_1_0_2::startActivityWithFolder | ( | in Webcam_2_0_1 | webcam, | 
| in int | count, | ||
| in int | interval, | ||
| in string | folder | ||
| ) | 
Start a capture activity, storing the images to a specific storage folder.
| webcam | webcam | 
| count | number of images to store, zero is interpreted as infinite | 
| interval | interval in ms | 
| folder | folder path to store the images into | 
| int webcam::StorageManager_1_0_2::stopActivity | ( | in Webcam_2_0_1 | webcam | ) | 
stop a capture activity
| webcam | webcam | 
| valueobject webcam::StorageManager_1_0_2::ImageUploadStartedEvent | 
Event: image upload to storage started.
webcam object
| constant int webcam::StorageManager_1_0_2::NO_ERROR = 0 | 
Error codes.
Operation successful, no error
 1.8.14
 1.8.14