Raritan PX2/PX3 JSON-RPC API
StorageManager.idl
1 #include <Webcam.idl>
2 
4 module webcam {
5 
7  interface StorageManager_1_0_1 {
8 
12  constant int NO_ERROR = 0;
13  constant int ERR_INVALID_PARAM = 1;
14  constant int ERR_INIT_IN_PROGRESS = 2;
15  constant int ERR_ALREADY_RUNNING = 3;
16  constant int ERR_TOO_LARGE = 4;
17 
19  enumeration StorageType {
21  FTP,
22  CIFS,
23  NFS
24  };
25 
27  enumeration Direction {
29  DESCENDING
30  };
31 
33  enumeration StorageStatus {
35  READY
36  };
37 
39  structure WebcamStorageInfo {
41  long newestIndex;
42  long oldestIndex;
43  int count;
44  };
45 
47  structure StorageInformation {
49  int capacity;
50  int used;
51  vector<WebcamStorageInfo> webcamStorageInfo;
52  };
53 
55  structure StorageSettings {
57  int capacity;
58  string server;
59  string username;
60  string password;
61  };
62 
64  structure StorageMetaData {
65  long index;
67  };
68 
72  int fileSize;
74  };
75 
77  structure StorageImage {
80  };
81 
83  structure Activity {
85  int interval;
86  int count;
87  int done;
88  };
89 
95  vector<StorageType> getSupportedStorageTypes();
96 
102  StorageInformation getInformation();
103 
109  StorageSettings getSettings();
110 
119  int setSettings(in StorageSettings settings);
120 
130  int addImage(in Webcam_2_0_0 webcam, in Image_2_0_0 image, out long index);
131 
144  int removeImages(in Webcam_2_0_0 webcam, in long start, in int count, in Direction direction);
145 
160  int getMetaData(in Webcam_2_0_0 webcam, in long start, in int count,
161  in Direction direction, out vector<ImageStorageMetaData> meta);
162 
177  int getImages(in Webcam_2_0_0 webcam, in long start, in int count,
178  in Direction direction, out vector<StorageImage> image);
179 
185  vector<Activity> getActivities();
186 
197  int startActivity(in Webcam_2_0_0 webcam, in int count, in int interval);
198 
207  int stopActivity(in Webcam_2_0_0 webcam);
208  };
209 }
Activity.
Definition: StorageManager.idl:83
Webcam Storage Info.
Definition: StorageManager.idl:39
int capacity
over-all nr of storable images
Definition: StorageManager.idl:49
StorageMetaData.
Definition: StorageManager.idl:70
StorageStatus status
storage status
Definition: StorageManager.idl:48
Webcam_2_0_0 webcam
webcam object
Definition: StorageManager.idl:84
StorageType type
storage type
Definition: StorageManager.idl:56
StorageStatus
StorageStatus.
Definition: StorageManager.idl:33
FTP.
Definition: StorageManager.idl:21
Settings.
Definition: StorageManager.idl:55
Image_2_0_0 image
image object
Definition: StorageManager.idl:78
long index
current image index
Definition: StorageManager.idl:65
long oldestIndex
oldest know index
Definition: StorageManager.idl:42
CIFS.
Definition: StorageManager.idl:22
int fileSize
image file size in bytes
Definition: StorageManager.idl:72
int count
nr of images to take
Definition: StorageManager.idl:86
int done
nr of images taken
Definition: StorageManager.idl:87
Local.
Definition: StorageManager.idl:20
StorageType
StorageType.
Definition: StorageManager.idl:19
Information.
Definition: StorageManager.idl:47
Initializing is in progress,.
Definition: StorageManager.idl:34
ascending
Definition: StorageManager.idl:28
int capacity
maximum number of stored images; obsolete, no longer used
Definition: StorageManager.idl:57
int interval
capture interval
Definition: StorageManager.idl:85
Direction
Direction.
Definition: StorageManager.idl:27
string username
username (empty/ignored for LOCAL storage type)
Definition: StorageManager.idl:59
string password
password (empty/ignored for LOCAL storage type)
Definition: StorageManager.idl:60
vector< WebcamStorageInfo > webcamStorageInfo
List of storage information for each webcam (local storage only)
Definition: StorageManager.idl:51
Webcam_2_0_0 webcam
source webcam
Definition: StorageManager.idl:66
The storage manager interface.
Definition: StorageManager.idl:7
int count
nr of stored images from this webcam
Definition: StorageManager.idl:43
StorageImage.
Definition: StorageManager.idl:77
long newestIndex
newest know index
Definition: StorageManager.idl:41
StorageMetaData storageMeta
store related meta data
Definition: StorageManager.idl:73
string server
server ip, share and path (empty/ignored for LOCAL storage type)
Definition: StorageManager.idl:58
Image.
Definition: Webcam.idl:57
Webcam_2_0_0 webcam
webcam object
Definition: StorageManager.idl:40
ImageMetaData imageMeta
image related meta data
Definition: StorageManager.idl:71
Webcam Management.
Definition: StorageManager.idl:4
StorageMetaData metaData
meta data
Definition: StorageManager.idl:79
StorageMetaData.
Definition: StorageManager.idl:64
The webcam interface.
Definition: Webcam.idl:78
int used
nr of stored images (local storage only)
Definition: StorageManager.idl:50
Image meta data.
Definition: Webcam.idl:50