VideoXpert SDK  2.0
A software development kit for third party vendors to integrate with the VideoXpert platform
VxSdk::IVxDeviceAssignment Struct Referenceabstract

Represents a device assignment on a data storage. More...

#include <IVxDeviceAssignment.h>

Public Member Functions

virtual VxResult::Value Delete () const =0
 Deletes this instance. More...
 
virtual VxResult::Value GetDataSources (VxCollection< IVxDataSource ** > &dataSourceCollection) const =0
 Gets the data sources assigned by this device assignment. More...
 
virtual VxResult::Value GetDataStorage (IVxDataStorage *&dataStorage) const =0
 Gets the IVxDataStorage that this device assignment is for. More...
 
virtual VxResult::Value GetDevice (IVxDevice *&device) const =0
 Gets the assigned IVxDevice. More...
 
virtual VxResult::Value GetDriver (IVxDriver *&driver) const =0
 Gets the assigned IVxDriver. More...
 
virtual VxResult::Value SetDataSources (char **dataSourceIds, int dataSourceIdSize)=0
 Sets the data sources assigned by this device assignment. More...
 
virtual VxResult::Value SetDriverType (char driverType[64])=0
 Sets the driver type property. More...
 

Public Attributes

char driverType [64]
 The driver type. More...
 
char id [64]
 The unique identifier of the device assignment. More...
 

Protected Member Functions

void Clear ()
 Clears this instance. More...
 

Detailed Description

Represents a device assignment on a data storage.

Definition at line 15 of file IVxDeviceAssignment.h.

Member Function Documentation

void VxSdk::IVxDeviceAssignment::Clear ( )
inlineprotected

Clears this instance.

Definition at line 75 of file IVxDeviceAssignment.h.

75  {
76  VxZeroArray(this->driverType);
77  VxZeroArray(this->id);
78  }
char driverType[64]
The driver type.
#define VxZeroArray(src)
Definition: VxMacros.h:25
virtual VxResult::Value VxSdk::IVxDeviceAssignment::Delete ( ) const
pure virtual

Deletes this instance.

Returns
The Result of deleting this instance.
virtual VxResult::Value VxSdk::IVxDeviceAssignment::GetDataSources ( VxCollection< IVxDataSource ** > &  dataSourceCollection) const
pure virtual

Gets the data sources assigned by this device assignment.

Available filters: kAllTags, kAllPrivateTags, kCapturing, kId, kIp, kManualRecording, kModifiedSince, kName, kNumber, kRecording, kState, kType, kUnassigned.

Parameters
dataSourceCollectionA VxCollection of the associated data sources.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxDeviceAssignment::GetDataStorage ( IVxDataStorage *&  dataStorage) const
pure virtual

Gets the IVxDataStorage that this device assignment is for.

Parameters
dataStorageThe IVxDataStorage for this device assignment.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxDeviceAssignment::GetDevice ( IVxDevice *&  device) const
pure virtual

Gets the assigned IVxDevice.

Parameters
deviceThe assigned IVxDevice.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxDeviceAssignment::GetDriver ( IVxDriver *&  driver) const
pure virtual

Gets the assigned IVxDriver.

Parameters
driverThe assigned IVxDriver.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxDeviceAssignment::SetDataSources ( char **  dataSourceIds,
int  dataSourceIdSize 
)
pure virtual

Sets the data sources assigned by this device assignment.

Parameters
dataSourceIdsThe data sources to assign.
dataSourceIdSizeThe size of dataSourceIds.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxDeviceAssignment::SetDriverType ( char  driverType[64])
pure virtual

Sets the driver type property.

Parameters
driverTypeThe new driver type value.
Returns
The Result of setting the property.

Member Data Documentation

char VxSdk::IVxDeviceAssignment::driverType[64]

The driver type.

Definition at line 65 of file IVxDeviceAssignment.h.

char VxSdk::IVxDeviceAssignment::id[64]

The unique identifier of the device assignment.

Definition at line 69 of file IVxDeviceAssignment.h.


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