CPPCli::ManualRecording Class Reference

The ManualRecording class 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 <ManualRecording.h>

Public Member Functions
	ManualRecording (VxSdk::IVxManualRecording *vxManualRecording)
	Constructor. More...
virtual	~ManualRecording ()
	Destructor. More...
	!ManualRecording ()
	Finaliser. More...
Results::Value	Refresh ()
	Refreshes this instances properties. More...

Package Functions
CPPCli::DataSource^	_GetDataSource ()

Package Attributes
VxSdk::IVxManualRecording *	_manualRecording

Properties
CPPCli::DataSource^	DataSource [get]
	Gets the data source that is being manually recorded. More...
System::String^	DataSourceId [get]
	Gets the unique identifier of the data source that is being manually recorded. More...
System::String^	Id [get]
	Gets the unique manual recording identifier. More...
System::String^	OwnerName [get]
	Gets the name of the user that created this manual recording. More...
System::DateTime	Time [get]
	Gets the time at which this manual recording was created (not necessarily the exact time that the manual record clip starts). More...

Detailed Description

The ManualRecording class 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 17 of file ManualRecording.h.

Constructor & Destructor Documentation

CPPCli::ManualRecording::ManualRecording

(

VxSdk::IVxManualRecording *

vxManualRecording

)

Constructor.

Parameters

vxManualRecording

The vx manual recording.

Definition at line 8 of file ManualRecording.cpp.

                                                                                 {
    _manualRecording = vxManualRecording;
}

virtual CPPCli::ManualRecording::~ManualRecording ( )

inlinevirtual

Destructor.

Definition at line 29 of file ManualRecording.h.

                                   {
            this->!ManualRecording();
        }

CPPCli::ManualRecording::!ManualRecording

(

)

Finaliser.

Definition at line 12 of file ManualRecording.cpp.

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

Member Function Documentation

CPPCli::DataSource CPPCli::ManualRecording::_GetDataSource ( )

package

Definition at line 21 of file ManualRecording.cpp.

                                                        {
    // Get the data source
    VxSdk::IVxDataSource* dataSource = nullptr;
    VxSdk::VxResult::Value result = _manualRecording->GetDataSource(dataSource);

    // Return the data source if GetDataSource was successful
    if (result == VxSdk::VxResult::kOK)
        return gcnew CPPCli::DataSource(dataSource);

    return nullptr;
}

CPPCli::Results::Value CPPCli::ManualRecording::Refresh

(

)

Refreshes this instances properties.

Returns

The Result of updating the properties.

Definition at line 17 of file ManualRecording.cpp.

                                                  {
    return (CPPCli::Results::Value)_manualRecording->Refresh();
}

Member Data Documentation

VxSdk::IVxManualRecording* CPPCli::ManualRecording::_manualRecording

package

Definition at line 90 of file ManualRecording.h.

Property Documentation

CPPCli:: DataSource^ CPPCli::ManualRecording::DataSource

get

Gets the data source that is being manually recorded.

The data source being manually recorded.

Definition at line 48 of file ManualRecording.h.

System:: String^ CPPCli::ManualRecording::DataSourceId

get

Gets the unique identifier of the data source that is being manually recorded.

The unique identifier of the data source.

Definition at line 57 of file ManualRecording.h.

System:: String^ CPPCli::ManualRecording::Id

get

Gets the unique manual recording identifier.

The unique identifier.

Definition at line 66 of file ManualRecording.h.

System:: String^ CPPCli::ManualRecording::OwnerName

get

Gets the name of the user that created this manual recording.

The owner name.

Definition at line 75 of file ManualRecording.h.

System:: DateTime CPPCli::ManualRecording::Time

get

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

A default DateTime if it fails, else the DateTime at which this manual recording was created.

Definition at line 84 of file ManualRecording.h.

---

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

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