Raritan EMX JSON-RPC API
StorageManager.idl
1 #include <UserEvent.idl>
2 #include <Webcam.idl>
3 
5 module webcam {
6 
8  interface StorageManager_1_0_2 {
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  constant int ERR_OPERATION_NOT_SUPPORTED = 5;
18 
20  enumeration StorageType {
22  FTP,
23  CIFS,
24  NFS
25  };
26 
28  enumeration Direction {
30  DESCENDING
31  };
32 
34  enumeration StorageStatus {
36  READY
37  };
38 
40  structure WebcamStorageInfo {
42  long newestIndex;
43  long oldestIndex;
44  int count;
45  };
46 
48  structure StorageInformation {
50  int capacity;
51  int used;
52  vector<WebcamStorageInfo> webcamStorageInfo;
53  };
54 
56  structure StorageSettings {
58  int capacity;
59  string server;
60  string username;
61  string password;
62  };
63 
65  structure StorageMetaData {
66  long index;
68  };
69 
73  int fileSize;
75  };
76 
78  structure StorageImage {
81  };
82 
84  structure Activity {
86  int interval;
87  int count;
88  int done;
89  };
90 
92  valueobject ImageUploadStartedEvent extends event.UserEvent {
94  string folderUrl;
95  };
96 
102  vector<StorageType> getSupportedStorageTypes();
103 
109  StorageInformation getInformation();
110 
116  StorageSettings getSettings();
117 
126  int setSettings(in StorageSettings settings);
127 
137  int addImage(in Webcam_2_0_1 webcam, in Image_2_0_0 image, out long index);
138 
151  int removeImages(in Webcam_2_0_1 webcam, in long start, in int count, in Direction direction);
152 
167  int getMetaData(in Webcam_2_0_1 webcam, in long start, in int count,
168  in Direction direction, out vector<ImageStorageMetaData> meta);
169 
184  int getImages(in Webcam_2_0_1 webcam, in long start, in int count,
185  in Direction direction, out vector<StorageImage> image);
186 
192  vector<Activity> getActivities();
193 
204  int startActivity(in Webcam_2_0_1 webcam, in int count, in int interval);
205 
217  int startActivityWithFolder(in Webcam_2_0_1 webcam, in int count, in int interval, in string folder);
218 
227  int stopActivity(in Webcam_2_0_1 webcam);
228  };
229 }
vector< WebcamStorageInfo > webcamStorageInfo
List of storage information for each webcam (local storage only)
Definition: StorageManager.idl:52
Settings.
Definition: StorageManager.idl:56
string password
password (empty/ignored for LOCAL storage type)
Definition: StorageManager.idl:61
Webcam Storage Info.
Definition: StorageManager.idl:40
Initializing is in progress,.
Definition: StorageManager.idl:35
StorageMetaData.
Definition: StorageManager.idl:65
ImageMetaData imageMeta
image related meta data
Definition: StorageManager.idl:72
StorageMetaData storageMeta
store related meta data
Definition: StorageManager.idl:74
int used
nr of stored images (local storage only)
Definition: StorageManager.idl:51
The webcam interface.
Definition: Webcam.idl:81
StorageType
StorageType.
Definition: StorageManager.idl:20
StorageStatus
StorageStatus.
Definition: StorageManager.idl:34
Webcam_2_0_1 webcam
webcam object
Definition: StorageManager.idl:41
Image_2_0_0 image
image object
Definition: StorageManager.idl:79
Information.
Definition: StorageManager.idl:48
StorageStatus status
storage status
Definition: StorageManager.idl:49
string folderUrl
URL under which the containing folder can be accessed.
Definition: StorageManager.idl:94
int done
nr of images taken
Definition: StorageManager.idl:88
string server
server ip, share and path (empty/ignored for LOCAL storage type)
Definition: StorageManager.idl:59
Webcam_2_0_1 webcam
source webcam
Definition: StorageManager.idl:67
StorageImage.
Definition: StorageManager.idl:78
The storage manager interface.
Definition: StorageManager.idl:8
StorageMetaData metaData
meta data
Definition: StorageManager.idl:80
FTP.
Definition: StorageManager.idl:22
StorageMetaData.
Definition: StorageManager.idl:71
Webcam_2_0_1 webcam
webcam object
Definition: StorageManager.idl:85
Local.
Definition: StorageManager.idl:21
int count
nr of stored images from this webcam
Definition: StorageManager.idl:44
int fileSize
image file size in bytes
Definition: StorageManager.idl:73
int interval
capture interval
Definition: StorageManager.idl:86
long index
current image index
Definition: StorageManager.idl:66
CIFS.
Definition: StorageManager.idl:23
long oldestIndex
oldest know index
Definition: StorageManager.idl:43
Image.
Definition: Webcam.idl:59
int capacity
over-all nr of storable images
Definition: StorageManager.idl:50
string username
username (empty/ignored for LOCAL storage type)
Definition: StorageManager.idl:60
long newestIndex
newest know index
Definition: StorageManager.idl:42
Direction
Direction.
Definition: StorageManager.idl:28
int count
nr of images to take
Definition: StorageManager.idl:87
Webcam Management.
Definition: StorageManager.idl:5
Activity.
Definition: StorageManager.idl:84
Image meta data.
Definition: Webcam.idl:52
ascending
Definition: StorageManager.idl:29
int capacity
maximum number of stored images; obsolete, no longer used
Definition: StorageManager.idl:58
StorageType type
storage type
Definition: StorageManager.idl:57