webcam::StorageManager_1_0_1 Interface Reference

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_0 webcam, in Image_2_0_0 image, out long index)
	add an image to the storage More...
int	removeImages (in Webcam_2_0_0 webcam, in long start, in int count, in Direction direction)
	remove an image of the storage More...
int	getMetaData (in Webcam_2_0_0 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_0 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_0 webcam, in int count, in int interval)
	start a capture activity More...
int	stopActivity (in Webcam_2_0_0 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.

Detailed Description

The storage manager interface.

Member Enumeration Documentation

enum webcam::StorageManager_1_0_1::Direction

Direction.

Enumerator
ASCENDING	ascending
DESCENDING	descending

enum webcam::StorageManager_1_0_1::StorageStatus

StorageStatus.

Enumerator
INITIALIZING	Initializing is in progress,.
READY	Storage is ready for usage.

enum webcam::StorageManager_1_0_1::StorageType

StorageType.

Enumerator
LOCAL	Local.
FTP	FTP.
CIFS	CIFS.
NFS	NFS.

Member Function Documentation

int webcam::StorageManager_1_0_1::addImage	(	in Webcam_2_0_0	webcam,
		in Image_2_0_0	image,
		out long	index
	)

add an image to the storage

Parameters

webcam	image source webcam
image	image
index	index of the added image

Returns

NO_ERROR on success

vector<Activity> webcam::StorageManager_1_0_1::getActivities

(

)

get all running activities

Returns

list of running activities

int webcam::StorageManager_1_0_1::getImages	(	in Webcam_2_0_0	webcam,
		in long	start,
		in int	count,
		in Direction	direction,
		out vector< StorageImage >	image
	)

retrieve images from the storage

Note

not supported for remote storage (CIFS and FTP)

Parameters

webcam	image source webcam
start	start index
count	number of images
direction	index counting direction
image	result: list of storage images

Returns

NO_ERROR on success

ERR_TOO_LARGE too many images requested

StorageInformation webcam::StorageManager_1_0_1::getInformation

(

)

get storage information

Returns

StorageInformation

int webcam::StorageManager_1_0_1::getMetaData	(	in Webcam_2_0_0	webcam,
		in long	start,
		in int	count,
		in Direction	direction,
		out vector< ImageStorageMetaData >	meta
	)

get meta data of images from storage

Note

not supported for remote storage (CIFS and FTP)

Parameters

webcam	image source webcam
start	start index
count	number of images
direction	index counting direction
meta	result: list of storage meta data

Returns

NO_ERROR on success

ERR_TOO_LARGE too many information requested

StorageSettings webcam::StorageManager_1_0_1::getSettings

(

)

get storage settings

Returns

StorageSettings

vector<StorageType> webcam::StorageManager_1_0_1::getSupportedStorageTypes

(

)

Get supported storage types.

Returns

a list of supported storage types

int webcam::StorageManager_1_0_1::removeImages	(	in Webcam_2_0_0	webcam,
		in long	start,
		in int	count,
		in Direction	direction
	)

remove an image of the storage

Note

not supported for remote storage (CIFS and FTP)

Parameters

webcam	image source webcam
start	start index
count	number of images
direction	index counting direction

Returns

NO_ERROR on success

int webcam::StorageManager_1_0_1::setSettings

(

in StorageSettings

settings

)

set storage settings

Parameters

settings

settings structure

Returns

NO_ERROR on success

ERR_INVALID_PARAM invalid settings

int webcam::StorageManager_1_0_1::startActivity	(	in Webcam_2_0_0	webcam,
		in int	count,
		in int	interval
	)

start a capture activity

Parameters

webcam	webcam
count	number of images to store, zero is interpreted as infinite
interval	interval in ms

Returns

NO_ERROR on success

ERR_INVALID_PARAM webcam not found

int webcam::StorageManager_1_0_1::stopActivity

(

in Webcam_2_0_0

webcam

)

stop a capture activity

Parameters

webcam

webcam

Returns

NO_ERROR on success

ERR_INVALID_PARAM no matching activity found

Member Data Documentation

constant int webcam::StorageManager_1_0_1::NO_ERROR = 0

Error codes.

Operation successful, no error

---

The documentation for this interface was generated from the following file:

• pdu-json-rpc-api/idl/StorageManager.idl