VxSdk::IVxManualRecording Struct Reference

Represents an instance of an active manual recording (the action, not the recorded clip). Each manual recording will cause its specified data source to be manually recorded by all data storages that the data source is assigned to. Only one manual recording per user per data source is allowed. A clip created via the application of a manual recording will have an event value of manual. More...

#include <IVxManualRecording.h>

Public Member Functions
virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...
virtual VxResult::Value	DeleteManualRecording () const =0
	Delete this manual recording from the VideoXpert system. If all manual recordings are deleted for a data source, manual recording will be stopped for that data source. More...
virtual VxResult::Value	GetDataSource (IVxDataSource *&dataSource) const =0
	Gets the data source that is being manually recorded. More...
virtual VxResult::Value	Refresh ()=0
	Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...

Public Attributes
char	dataSourceId [64]
	The unique identifier of the data source to manually record. More...
char	id [64]
	The unique identifier of the manual recording. More...
char	owner [64]
	The name of the user that created this manual recording. More...
char	time [64]
	The time at which this manual recording was created (not necessarily the exact time that the manual record clip starts). More...

Protected Member Functions
void	Clear ()
	Clears this instance. More...

Detailed Description

Represents an instance of an active manual recording (the action, not the recorded clip). Each manual recording will cause its specified data source to be manually recorded by all data storages that the data source is assigned to. Only one manual recording per user per data source is allowed. A clip created via the application of a manual recording will have an event value of manual.

Definition at line 15 of file IVxManualRecording.h.

Member Function Documentation

void VxSdk::IVxManualRecording::Clear ( )

inlineprotected

Clears this instance.

Definition at line 62 of file IVxManualRecording.h.

                     {
            VxZeroArray(this->dataSourceId);
            VxZeroArray(this->id);
            VxZeroArray(this->owner);
            VxZeroArray(this->time);
        }

virtual VxResult::Value VxSdk::IVxManualRecording::Delete ( ) const

pure virtual

Deletes this instance.

Returns

The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxManualRecording::DeleteManualRecording ( ) const

pure virtual

Delete this manual recording from the VideoXpert system. If all manual recordings are deleted for a data source, manual recording will be stopped for that data source.

Returns

The Result of deleting the manual recording.

virtual VxResult::Value VxSdk::IVxManualRecording::GetDataSource ( IVxDataSource *&  dataSource ) const

pure virtual

Gets the data source that is being manually recorded.

Parameters

dataSource

The data source being manually recorded.

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxManualRecording::Refresh ( )

pure virtual

Refreshes the member values for this object by retrieving its current information from the VideoXpert system.

Returns

The Result of refreshing the member values for this object.

Member Data Documentation

char VxSdk::IVxManualRecording::dataSourceId[64]

The unique identifier of the data source to manually record.

Definition at line 44 of file IVxManualRecording.h.

char VxSdk::IVxManualRecording::id[64]

The unique identifier of the manual recording.

Definition at line 48 of file IVxManualRecording.h.

char VxSdk::IVxManualRecording::owner[64]

The name of the user that created this manual recording.

Definition at line 52 of file IVxManualRecording.h.

char VxSdk::IVxManualRecording::time[64]

The time at which this manual recording was created (not necessarily the exact time that the manual record clip starts).

Definition at line 56 of file IVxManualRecording.h.

---

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

• C:/Git/VXSDK_M3/VxSdk/Include/IVxManualRecording.h