Represents an exported data set that is archived within the system. More...

#include <IVxExport.h>

Public Member Functions
virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...

virtual VxResult::Value	DeleteExport () const =0
	Deletes this export from the VideoXpert system. More...

virtual VxResult::Value	GetOwner (IVxUser *&user) const =0
	Gets the IVxUser that owns this export, if any. 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
bool	isProtected
	Indicates whether the export data is signed and encrypted. More...

char	completedTime [64]
	The date and time at which the triggered export completed the export operation. More...

char	dataUri [512]
	The URI to the exported data. It will only be present if the exported data is completed and available for download. More...

char	id [64]
	The unique identifier of the export. More...

char	initiatedTime [64]
	The date and time at which the export was requested. More...

char	name [64]
	The friendly name of the export. More...

char	owner [64]
	The name of the user that has created this export, if any. More...

float	percentComplete
	The percent complete value from 0 to 100. This specifies how close the export is to completion. 0 indicates that the export has not been triggered; 100 indicates that the export is complete. More...

int	exportClipSize
	The size of exportClips. More...

int	fileSizeKb
	The file size of the exported data in kilobytes (kB). More...

int	secondsRemaining
	The estimated time remaining, in seconds, until the export is 100 percent complete. More...

IVxExportClip **	exportClips
	The clips associated with this export. More...

VxExportFormat::Value	format
	The format of the export data. More...

VxExportStatus::Value	status
	The current status of the export. More...

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

Detailed Description

Represents an exported data set that is archived within the system.

Definition at line 13 of file IVxExport.h.

Member Function Documentation

void VxSdk::IVxExport::Clear ( )

inlineprotected

Clears this instance.

Definition at line 100 of file IVxExport.h.

                      {
             this->isProtected = false;
             VxZeroArray(this->completedTime);
             VxZeroArray(this->dataUri);
             VxZeroArray(this->id);
             VxZeroArray(this->initiatedTime);
             VxZeroArray(this->name);
             VxZeroArray(this->owner);
             this->exportClipSize = 0;
             this->percentComplete = 0;
             this->fileSizeKb = 0;
             this->secondsRemaining = 0;
             this->exportClips = nullptr;
             this->format = VxExportFormat::kUnknown;
             this->status = VxExportStatus::kUnknown;
         }

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

pure virtual

Deletes this instance.

Returns: The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxExport::DeleteExport ( ) const

pure virtual

Deletes this export from the VideoXpert system.

Returns: The Result of deleting the export.

virtual VxResult::Value VxSdk::IVxExport::GetOwner ( IVxUser *& user ) const

pure virtual

Gets the IVxUser that owns this export, if any.

Parameters

user	The IVxUser that owns this export.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxExport::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::IVxExport::completedTime[64]

The date and time at which the triggered export completed the export operation.

Definition at line 45 of file IVxExport.h.

char VxSdk::IVxExport::dataUri[512]

The URI to the exported data. It will only be present if the exported data is completed and available for download.

Definition at line 49 of file IVxExport.h.

IVxExportClip** VxSdk::IVxExport::exportClips

The clips associated with this export.

Definition at line 86 of file IVxExport.h.

int VxSdk::IVxExport::exportClipSize

The size of exportClips.

Definition at line 74 of file IVxExport.h.

int VxSdk::IVxExport::fileSizeKb

The file size of the exported data in kilobytes (kB).

Definition at line 78 of file IVxExport.h.

VxExportFormat::Value VxSdk::IVxExport::format

The format of the export data.

Definition at line 90 of file IVxExport.h.

char VxSdk::IVxExport::id[64]

The unique identifier of the export.

Definition at line 53 of file IVxExport.h.

char VxSdk::IVxExport::initiatedTime[64]

The date and time at which the export was requested.

Definition at line 57 of file IVxExport.h.

bool VxSdk::IVxExport::isProtected

Indicates whether the export data is signed and encrypted.

Definition at line 41 of file IVxExport.h.

char VxSdk::IVxExport::name[64]

The friendly name of the export.

Definition at line 61 of file IVxExport.h.

char VxSdk::IVxExport::owner[64]

The name of the user that has created this export, if any.

Definition at line 65 of file IVxExport.h.

float VxSdk::IVxExport::percentComplete

The percent complete value from 0 to 100. This specifies how close the export is to completion. 0 indicates that the export has not been triggered; 100 indicates that the export is complete.

Definition at line 70 of file IVxExport.h.

int VxSdk::IVxExport::secondsRemaining

The estimated time remaining, in seconds, until the export is 100 percent complete.

Definition at line 82 of file IVxExport.h.

VxExportStatus::Value VxSdk::IVxExport::status

The current status of the export.

Definition at line 94 of file IVxExport.h.

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

C:/Git/VXSDK_M3/VxSdk/Include/IVxExport.h

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation