VideoXpert SDK  2.0
A software development kit for third party vendors to integrate with the VideoXpert platform
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
VxSdk::IVxClip Struct Referenceabstract

Represents a contiguous duration of stored media originating from a single data source. More...

#include <IVxClip.h>

Public Member Functions

virtual VxResult::Value Delete () const =0
 Deletes this instance. More...
 
virtual VxResult::Value GetSnapshotEndpoint (VxSnapshotFilter *filter, int filterSize, char *endpoint, int &size) const =0
 Gets the endpoint URI for snapshots. More...
 

Public Attributes

char dataSourceId [64]
 The unique identifier of the clips data source. More...
 
char dataSourceName [64]
 The friendly name of the clips data source. More...
 
char dataStorageId [64]
 The unique identifier of the data storage on which the media for this clip is stored. More...
 
char endTime [64]
 The end time of the clip. More...
 
char sourceDataStorageId [64]
 The unique identifier of the data storage on which the media for this clip was originally stored. If different than dataStorageId, indicates that this clip was copied to the data storage from another data storage. More...
 
char startTime [64]
 The start time of the clip. More...
 
char type [64]
 The type of media contained in the clip. More...
 
int dataInterfaceSize
 The size of dataInterfaces. More...
 
IVxDataInterface ** dataInterfaces
 The data interfaces available for retrieval of the stored media this clip represents. More...
 
VxRecordingFramerate::Value framerate
 The framerate of the clip. More...
 
VxRetentionPriority::Value priority
 The recording retention priority of the clip. More...
 
VxRecordingType::Value recordingType
 The event type that triggered the recording of the clip. More...
 

Protected Member Functions

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

Detailed Description

Represents a contiguous duration of stored media originating from a single data source.

Definition at line 15 of file IVxClip.h.

Member Function Documentation

void VxSdk::IVxClip::Clear ( )
inlineprotected

Clears this instance.

Definition at line 87 of file IVxClip.h.

87  {
88  VxZeroArray(this->dataSourceId);
89  VxZeroArray(this->dataSourceName);
90  VxZeroArray(this->dataStorageId);
91  VxZeroArray(this->endTime);
92  VxZeroArray(this->sourceDataStorageId);
93  VxZeroArray(this->startTime);
94  VxZeroArray(this->type);
95  this->dataInterfaceSize = 0;
96  this->dataInterfaces = nullptr;
97  this->framerate = VxRecordingFramerate::kUnknown;
98  this->priority = VxRetentionPriority::kUnknown;
99  this->recordingType = VxRecordingType::kUnknown;
100  }
VxSdk::IVxClip::priority
VxRetentionPriority::Value priority
The recording retention priority of the clip.
Definition: IVxClip.h:77
VxSdk::IVxClip::dataSourceId
char dataSourceId[64]
The unique identifier of the clips data source.
Definition: IVxClip.h:36
VxZeroArray
#define VxZeroArray(src)
Definition: VxMacros.h:25
VxSdk::VxRecordingFramerate::kUnknown
An error or unknown value was returned.
Definition: VxPrimitives.h:550
VxSdk::IVxClip::type
char type[64]
The type of media contained in the clip.
Definition: IVxClip.h:61
VxSdk::VxRecordingType::kUnknown
An error or unknown value was returned.
Definition: VxPrimitives.h:564
VxSdk::IVxClip::dataInterfaces
IVxDataInterface ** dataInterfaces
The data interfaces available for retrieval of the stored media this clip represents.
Definition: IVxClip.h:69
VxSdk::IVxClip::framerate
VxRecordingFramerate::Value framerate
The framerate of the clip.
Definition: IVxClip.h:73
VxSdk::IVxClip::recordingType
VxRecordingType::Value recordingType
The event type that triggered the recording of the clip.
Definition: IVxClip.h:81
VxSdk::IVxClip::dataStorageId
char dataStorageId[64]
The unique identifier of the data storage on which the media for this clip is stored.
Definition: IVxClip.h:44
VxSdk::IVxClip::sourceDataStorageId
char sourceDataStorageId[64]
The unique identifier of the data storage on which the media for this clip was originally stored...
Definition: IVxClip.h:53
VxSdk::IVxClip::dataSourceName
char dataSourceName[64]
The friendly name of the clips data source.
Definition: IVxClip.h:40
VxSdk::IVxClip::endTime
char endTime[64]
The end time of the clip.
Definition: IVxClip.h:48
VxSdk::IVxClip::dataInterfaceSize
int dataInterfaceSize
The size of dataInterfaces.
Definition: IVxClip.h:65
VxSdk::IVxClip::startTime
char startTime[64]
The start time of the clip.
Definition: IVxClip.h:57
VxSdk::VxRetentionPriority::kUnknown
An error or unknown value was returned.
Definition: VxPrimitives.h:826
virtual VxResult::Value VxSdk::IVxClip::Delete ( ) const
pure virtual

Deletes this instance.

Returns
The Result of deleting this instance.
virtual VxResult::Value VxSdk::IVxClip::GetSnapshotEndpoint ( VxSnapshotFilter *  filter,
int  filterSize,
char *  endpoint,
int &  size 
) const
pure virtual

Gets the endpoint URI for snapshots.

Parameters
filterThe filter(s) to use to generate the snapshot endpoint.
filterSizeThe size of filter .
endpointThe snapshots endpoint.
sizeThe size of endpoint .
Returns
The Result of the request.

Member Data Documentation

IVxDataInterface** VxSdk::IVxClip::dataInterfaces

The data interfaces available for retrieval of the stored media this clip represents.

Definition at line 69 of file IVxClip.h.

int VxSdk::IVxClip::dataInterfaceSize

The size of dataInterfaces.

Definition at line 65 of file IVxClip.h.

char VxSdk::IVxClip::dataSourceId[64]

The unique identifier of the clips data source.

Definition at line 36 of file IVxClip.h.

char VxSdk::IVxClip::dataSourceName[64]

The friendly name of the clips data source.

Definition at line 40 of file IVxClip.h.

char VxSdk::IVxClip::dataStorageId[64]

The unique identifier of the data storage on which the media for this clip is stored.

Definition at line 44 of file IVxClip.h.

char VxSdk::IVxClip::endTime[64]

The end time of the clip.

Definition at line 48 of file IVxClip.h.

VxRecordingFramerate::Value VxSdk::IVxClip::framerate

The framerate of the clip.

Definition at line 73 of file IVxClip.h.

VxRetentionPriority::Value VxSdk::IVxClip::priority

The recording retention priority of the clip.

Definition at line 77 of file IVxClip.h.

VxRecordingType::Value VxSdk::IVxClip::recordingType

The event type that triggered the recording of the clip.

Definition at line 81 of file IVxClip.h.

char VxSdk::IVxClip::sourceDataStorageId[64]

The unique identifier of the data storage on which the media for this clip was originally stored. If different than dataStorageId, indicates that this clip was copied to the data storage from another data storage.

Definition at line 53 of file IVxClip.h.

char VxSdk::IVxClip::startTime[64]

The start time of the clip.

Definition at line 57 of file IVxClip.h.

char VxSdk::IVxClip::type[64]

The type of media contained in the clip.

Definition at line 61 of file IVxClip.h.

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