The Clip class represents a contiguous duration of stored media originating from a single DataSource. More...

#include <Clip.h>

Public Types
enum	RecordingFramerates { RecordingFramerates::Unknown, RecordingFramerates::Low, RecordingFramerates::Normal }
	Values that represent the video framerate level. More...

enum	RecordingTypes { RecordingTypes::Unknown, RecordingTypes::Alarm, RecordingTypes::Analytic, RecordingTypes::Event, RecordingTypes::Manual, RecordingTypes::Motion, RecordingTypes::Timed }
	Values that represent the type of trigger that caused the recording. More...

enum	RetentionPriorities { RetentionPriorities::Unknown, RetentionPriorities::Low, RetentionPriorities::Medium, RetentionPriorities::High }
	Values that represent how long the recording device should attempt to retain the clip. More...

Public Member Functions
	Clip (VxSdk::IVxClip *vxClip)
	Constructor. More...

virtual	~Clip ()
	Destructor. More...

	!Clip ()
	Finaliser. More...

System::String^	GetSnapshotEndpoint (SnapshotFilter^ filter)
	Gets the endpoint URI for snapshots. More...

Package Functions
System::Collections::Generic::List< DataInterface^ >^	_GetDataInterfaces ()

Package Attributes
VxSdk::IVxClip *	_clip

Properties
System::Collections::Generic::List< DataInterface^ >^	DataInterfaces `[get]`
	Gets the data interfaces available for retrieval of the stored media this clip represents. More...

System::String^	DataSourceId `[get]`
	Gets the unique identifier of the clips data source. More...

System::String^	DataSourceName `[get]`
	Gets the friendly name of the clips data source. More...

System::String^	DataStorageId `[get]`
	Gets the unique identifier of the data storage on which the media for this clip is stored. More...

System::DateTime	EndTime `[get]`
	Gets the end time of the clip. More...

RecordingTypes	EventType `[get]`
	Gets the event type that triggered the recording of the clip. More...

RecordingFramerates	Framerate `[get]`
	Gets the framerate of the clip. More...

System::String^	MediaType `[get]`
	Gets the type of media contained in the clip. More...

RetentionPriorities	Priority `[get]`
	Gets the recording retention priority of the clip. More...

System::String^	SourceDataStorageId `[get]`
	Gets 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...

System::DateTime	StartTime `[get]`
	Gets the start time of the clip. More...

Detailed Description

The Clip class represents a contiguous duration of stored media originating from a single DataSource.

Definition at line 14 of file Clip.h.

Member Enumeration Documentation

enum CPPCli::Clip::RecordingFramerates

strong

Values that represent the video framerate level.

Enumerator
Unknown	An error or unknown value was returned.
Low	Low framerate.
Normal	Normal framerate.

Definition at line 20 of file Clip.h.

enum CPPCli::Clip::RecordingTypes

strong

Values that represent the type of trigger that caused the recording.

Enumerator
Unknown	An error or unknown value was returned.
Alarm	Hardware or software alarm.
Analytic	Video analytic (non-motion).
Event	General system event.
Manual	Manual user initiation.
Motion	Motion anayltic.
Timed	Time-based (continuous); no event.

Definition at line 34 of file Clip.h.

                                   {
             Unknown,
 
             Alarm,
 
             Analytic,
 
             Event,
 
             Manual,
 
             Motion,
 
             Timed
         };

enum CPPCli::Clip::RetentionPriorities

strong

Values that represent how long the recording device should attempt to retain the clip.

Enumerator
Unknown	An error or unknown value was returned.
Low	Low retention priority.
Medium	Medium retention priority.
High	High retention priority.

Definition at line 61 of file Clip.h.

Constructor & Destructor Documentation

CPPCli::Clip::Clip ( VxSdk::IVxClip * vxClip )

Constructor.

Parameters

vxClip The vx clip.

Definition at line 8 of file Clip.cpp.

                                      {
     _clip = vxClip;
 }

virtual CPPCli::Clip::~Clip ( )

inlinevirtual

Destructor.

Definition at line 84 of file Clip.h.

                         {
             this->!Clip();
         }

CPPCli::Clip::!Clip ( )

Finaliser.

Definition at line 12 of file Clip.cpp.

                   {
     _clip->Delete();
     _clip = nullptr;
 }

Member Function Documentation

List< CPPCli::DataInterface^ > CPPCli::Clip::_GetDataInterfaces ( )

package

Definition at line 17 of file Clip.cpp.

                                                            {
     // Create a list of managed export objects
     List<DataInterface^>^ mlist = gcnew List<DataInterface^>();
     for (int i = 0; i < _clip->dataInterfaceSize; i++)
         mlist->Add(gcnew DataInterface(_clip->dataInterfaces[i]));
 
     return mlist;
 }

System::String CPPCli::Clip::GetSnapshotEndpoint ( SnapshotFilter^ filter )

Gets the endpoint URI for snapshots.

Returns: The snapshot endpoint.

Definition at line 45 of file Clip.cpp.

                                                                     {
     // Get the filter count
     const int filterSize = GetFilterSize(filter);
     // Create a VxSnapshotFilter object
     VxSdk::VxSnapshotFilter* vxFilter;
 
     // If there are filters present add them to vxFilter, otherwise set it to nullptr
     if (filterSize > 0) {
         vxFilter = new VxSdk::VxSnapshotFilter[filterSize];
 
         // If a filter has been set, add the the filter item with its value
         int filterPosition = 0;
         if (filter->EndTime != System::DateTime::MinValue) {
             vxFilter[filterPosition].key = VxSdk::VxSnapshotFilterItem::kEndTime;
             VxSdk::Utilities::StrCopySafe(vxFilter[filterPosition].value, Utils::ConvertDateTimeToChar(filter->EndTime));
             filterPosition++;
         }
         if (filter->StartTime != System::DateTime::MinValue) {
             vxFilter[filterPosition].key = VxSdk::VxSnapshotFilterItem::kStartTime;
             VxSdk::Utilities::StrCopySafe(vxFilter[filterPosition].value, Utils::ConvertDateTimeToChar(filter->StartTime));
             filterPosition++;
         }
         if (filter->Offset != NULL) {
             vxFilter[filterPosition].key = VxSdk::VxSnapshotFilterItem::kOffset;
             VxSdk::Utilities::StrCopySafe(vxFilter[filterPosition].value, Utils::ConvertSysString(filter->Offset.ToString()));
             filterPosition++;
         }
         if (filter->Width != NULL) {
             vxFilter[filterPosition].key = VxSdk::VxSnapshotFilterItem::kWidth;
             VxSdk::Utilities::StrCopySafe(vxFilter[filterPosition].value, Utils::ConvertSysString(filter->Width.ToString()));
         }
     }
     else {
         vxFilter = nullptr;
     }
 
     char* snapshotEndpoint = nullptr;
     int size = 0;
 
     // If the rtsp uri is not available on the datasource the result will return VxSdk::VxResult::kActionUnavailable,
     // otherwise VxSdk::VxResult::kInsufficientSize
     VxSdk::VxResult::Value result = _clip->GetSnapshotEndpoint(vxFilter, filterSize, snapshotEndpoint, size);
     if (result == VxSdk::VxResult::kInsufficientSize) {
         // Allocate enough space for rtspEndpoint
         snapshotEndpoint = new char[size];
         // The result should now be kOK since we have allocated enough space
         _clip->GetSnapshotEndpoint(vxFilter, filterSize, snapshotEndpoint, size);
     }
     return gcnew System::String(snapshotEndpoint);
 }

Member Data Documentation

VxSdk::IVxClip* CPPCli::Clip::_clip

package

Definition at line 200 of file Clip.h.

Property Documentation

System:: Collections:: Generic:: List< DataInterface^>^ CPPCli::Clip::DataInterfaces

get

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

A List of the data interfaces.

Definition at line 103 of file Clip.h.

System:: String^ CPPCli::Clip::DataSourceId

get

Gets the unique identifier of the clips data source.

The unique identifier.

Definition at line 112 of file Clip.h.

System:: String^ CPPCli::Clip::DataSourceName

get

Gets the friendly name of the clips data source.

The friendly name of the data source.

Definition at line 121 of file Clip.h.

System:: String^ CPPCli::Clip::DataStorageId

get

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

The unique identifier.

Definition at line 130 of file Clip.h.

System:: DateTime CPPCli::Clip::EndTime

get

Gets the end time of the clip.

The end time.

Definition at line 139 of file Clip.h.

RecordingTypes CPPCli::Clip::EventType

get

Gets the event type that triggered the recording of the clip.

The recording event type.

Definition at line 148 of file Clip.h.

RecordingFramerates CPPCli::Clip::Framerate

get

Gets the framerate of the clip.

The framerate.

Definition at line 157 of file Clip.h.

System:: String^ CPPCli::Clip::MediaType

get

Gets the type of media contained in the clip.

The media type.

Definition at line 166 of file Clip.h.

RetentionPriorities CPPCli::Clip::Priority

get

Gets the recording retention priority of the clip.

The priority level.

Definition at line 175 of file Clip.h.

System:: String^ CPPCli::Clip::SourceDataStorageId

get

Gets 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.

The unique identifier.

Definition at line 185 of file Clip.h.

System:: DateTime CPPCli::Clip::StartTime

get

Gets the start time of the clip.

The start time.

Definition at line 194 of file Clip.h.

The documentation for this class was generated from the following files:

C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/Clip.h
C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Source/Clip.cpp

Public Types

Public Member Functions

Package Functions

Package Attributes

Properties

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation