Class to perform a database export from a VMS server to a local disk. More...

Inheritance diagram for VideoOS.Platform.Data.DBExporter:

Public Member Functions
virtual void	Cancel ()
	Cancels the current export operation.

virtual void	Close ()
	Uninitialize managed wrapper. Should be called when done using any instance of Exporter, for example at exit.

	DBExporter ()
	Create database exporter for database in BLK file format.

	DBExporter (bool blkFormat)
	Create database exporter for database in BLK file format.

virtual void	EndExport ()
	Ends and cleans up the current export operation.

virtual void	Init ()
	Initializes the class and any underlaying classes.

virtual bool	StartExport (DateTime start, DateTime end)
	Exports the currently defined devices as a Milestone database. Returns error if already in progress.

Public Member Functions inherited from VideoOS.Platform.Data.IExporter

Properties
virtual List< Item >	AudioList `[get, set]`
	The list of audio sources to export. Can be both microphones and Speakers.

virtual List< Item >	CameraList `[get, set]`
	The list of cameras to export.

virtual bool	Compression `[get, set]`
	Set to True, if exported database is to be compressed. Note: Unsupported from Smart Client 7.0.

virtual bool	Encryption `[get, set]`
	Set to True if Encryption is required, also set the Password.

virtual EncryptionStrength	EncryptionStrength `[get, set]`
	Specifies the encryption strength. This property is valid for Smart Client plug-ins and standalone applications. Default value is DES-56 bit.

virtual string	ExportName `[get, set]`
	Specific the name of the export. This value is used as a part of the path and a the name of the optical disc. This property is valid for Smart Client plug-ins only. Default value is a construction of current Date and Time.

virtual bool	ExportToDisk `[get, set]`
	Specifies whether to export hard disk. The path of where to store the export is defined in the Path property. This property is valid for Smart Client plug-ins. Default value is true.

virtual bool	ExportToMediaBurner `[get, set]`
	Specifies whether to export to an optical disc (i.e. DVD). The drive letter of where to burn the export is defined in the MediaBurnerDriverLetter property. This property is valid for Smart Client plug-ins only. Default value is false.

virtual bool	IncludeBookmarks `[get, set]`
	Specifies if the export should include bookmarks.

virtual bool	IncludePlayer `[get, set]`
	Specifies whether to include the Smart Client - Player or not. This property is valid for Smart Client plug-ins only. Default value is false.

virtual int	LastDetailedError `[get]`
	Gets the last export detailed error as a number.

virtual int	LastError `[get]`
	Gets the last export error as a number.

virtual string	LastErrorString `[get]`
	Gets the last export error as an English string.

virtual int	LastWarning `[get]`
	Get the last warning, if any.

virtual char	MediaBurnerDriverLetter `[get, set]`
	When the ExportToMediaBurner is set to true, the MediaBurnerDriverLetter is used to identify which burner to use. This property is valid for Smart Client plug-ins only. There is no default value, must be specified for MediaBurner exports.

virtual List< Item >	MetadataList `[get, set]`
	The list of metadata sources to export.

virtual string	Password `[get, set]`
	The password used for encryption. If not set, the export will not be encrypted.

virtual string	Path `[get, set]`
	Where to store the export on hard disk. Used when the ExportToDisk is true.

virtual bool	PreventReExport `[get, set]`
	Specifies whether to prevent the end user from doing a new export from the Smart Client Player. Default is false (allow reexport). Only support for BLK format exports.

virtual String	PrivacyMask `[get, set]`
	An additional mask to be applied on all images.

virtual int	Progress `[get]`
	Gets the updated progress in percent.

virtual bool	SignExport `[get, set]`
	Specifies if the export should be signed.

virtual string[]	ViewerPaths `[get, set]`
	The path to the Viewer, and any language paths that should also be exported. Notice that the Viewer is no longer distributed with the Smart Client, and this field is ignored.

Properties inherited from VideoOS.Platform.Data.IExporter

Detailed Description

Class to perform a database export from a VMS server to a local disk.

Constructor & Destructor Documentation

◆ DBExporter() [1/2]

VideoOS.Platform.Data.DBExporter.DBExporter ( )

inline

Create database exporter for database in BLK file format.

◆ DBExporter() [2/2]

VideoOS.Platform.Data.DBExporter.DBExporter ( bool blkFormat )

inline

Create database exporter for database in BLK file format.

Parameters

blkFormat This parameter is ignored. The export will always be in BLK format

Member Function Documentation

◆ Cancel()

virtual void VideoOS.Platform.Data.DBExporter.Cancel ( )

inlinevirtual

Cancels the current export operation.

Implements VideoOS.Platform.Data.IExporter.

◆ Close()

virtual void VideoOS.Platform.Data.DBExporter.Close ( )

inlinevirtual

Uninitialize managed wrapper. Should be called when done using any instance of Exporter, for example at exit.

Implements VideoOS.Platform.Data.IExporter.

◆ EndExport()

virtual void VideoOS.Platform.Data.DBExporter.EndExport ( )

inlinevirtual

Ends and cleans up the current export operation.

Implements VideoOS.Platform.Data.IExporter.

◆ Init()

virtual void VideoOS.Platform.Data.DBExporter.Init ( )

inlinevirtual

Initializes the class and any underlaying classes.

Implements VideoOS.Platform.Data.IExporter.

◆ StartExport()

virtual bool VideoOS.Platform.Data.DBExporter.StartExport	(	DateTime	start,
		DateTime	end )

inlinevirtual

Exports the currently defined devices as a Milestone database. Returns error if already in progress.

Returns: True if export was started. Use Progress >= 100 to validate when the export has finished.
False if export was not started.

Parameters

start	The start time.
end	The end time.

Implements VideoOS.Platform.Data.IExporter.

Property Documentation

◆ AudioList

virtual List<Item> VideoOS.Platform.Data.DBExporter.AudioList

getset

The list of audio sources to export. Can be both microphones and Speakers.

Implements VideoOS.Platform.Data.IExporter.

◆ CameraList

virtual List<Item> VideoOS.Platform.Data.DBExporter.CameraList

getset

The list of cameras to export.

When executing in the Smart Client, the related audio sources are automatically included.

Implements VideoOS.Platform.Data.IExporter.

◆ Compression

virtual bool VideoOS.Platform.Data.DBExporter.Compression

getset

Set to True, if exported database is to be compressed.
Note: Unsupported from Smart Client 7.0.

◆ Encryption

virtual bool VideoOS.Platform.Data.DBExporter.Encryption

getset

Set to True if Encryption is required, also set the Password.

◆ EncryptionStrength

virtual EncryptionStrength VideoOS.Platform.Data.DBExporter.EncryptionStrength

getset

Specifies the encryption strength.
This property is valid for Smart Client plug-ins and standalone applications.
Default value is DES-56 bit.

◆ ExportName

virtual string VideoOS.Platform.Data.DBExporter.ExportName

getset

Specific the name of the export. This value is used as a part of the path and a the name of the optical disc.
This property is valid for Smart Client plug-ins only.
Default value is a construction of current Date and Time.

◆ ExportToDisk

virtual bool VideoOS.Platform.Data.DBExporter.ExportToDisk

getset

Specifies whether to export hard disk.
The path of where to store the export is defined in the Path property.
This property is valid for Smart Client plug-ins.
Default value is true.

◆ ExportToMediaBurner

virtual bool VideoOS.Platform.Data.DBExporter.ExportToMediaBurner

getset

Specifies whether to export to an optical disc (i.e. DVD).
The drive letter of where to burn the export is defined in the MediaBurnerDriverLetter property.
This property is valid for Smart Client plug-ins only.
Default value is false.

◆ IncludeBookmarks

virtual bool VideoOS.Platform.Data.DBExporter.IncludeBookmarks

getset

Specifies if the export should include bookmarks.

This option is only available for exports in BLK format.

Default value is false

◆ IncludePlayer

virtual bool VideoOS.Platform.Data.DBExporter.IncludePlayer

getset

Specifies whether to include the Smart Client - Player or not.
This property is valid for Smart Client plug-ins only.
Default value is false.

◆ LastDetailedError

virtual int VideoOS.Platform.Data.DBExporter.LastDetailedError

get

Gets the last export detailed error as a number.

The last error.

Implements VideoOS.Platform.Data.IExporter.

◆ LastError

virtual int VideoOS.Platform.Data.DBExporter.LastError

get

Gets the last export error as a number.

The last error.

Implements VideoOS.Platform.Data.IExporter.

◆ LastErrorString

virtual string VideoOS.Platform.Data.DBExporter.LastErrorString

get

Gets the last export error as an English string.

The last error.

Implements VideoOS.Platform.Data.IExporter.

◆ LastWarning

virtual int VideoOS.Platform.Data.DBExporter.LastWarning

get

Get the last warning, if any.

Returns: 0 = No warnings
1 = Incomplete Export
2 = Video was transcoded, takes extra time - but is not an error

◆ MediaBurnerDriverLetter

virtual char VideoOS.Platform.Data.DBExporter.MediaBurnerDriverLetter

getset

When the ExportToMediaBurner is set to true, the MediaBurnerDriverLetter is used to identify which burner to use.
This property is valid for Smart Client plug-ins only.
There is no default value, must be specified for MediaBurner exports.

◆ MetadataList

virtual List<Item> VideoOS.Platform.Data.DBExporter.MetadataList

getset

The list of metadata sources to export.

◆ Password

virtual string VideoOS.Platform.Data.DBExporter.Password

getset

The password used for encryption. If not set, the export will not be encrypted.

◆ Path

virtual string VideoOS.Platform.Data.DBExporter.Path

getset

Where to store the export on hard disk.
Used when the ExportToDisk is true.

Implements VideoOS.Platform.Data.IExporter.

◆ PreventReExport

virtual bool VideoOS.Platform.Data.DBExporter.PreventReExport

getset

Specifies whether to prevent the end user from doing a new export from the Smart Client Player.
Default is false (allow reexport).
Only support for BLK format exports.

◆ PrivacyMask

virtual String VideoOS.Platform.Data.DBExporter.PrivacyMask

getset

An additional mask to be applied on all images.

Any mask defined on the server is applied as well.

The format contains a size definition and a series of rows, seperated by ';'
A 3 by 3 grid with top right square masked out is defined by:
3x3;001;000;000

◆ Progress

virtual int VideoOS.Platform.Data.DBExporter.Progress

get

Gets the updated progress in percent.

The percent done. Out of range 0-100 means error. -2 means uninitialized.

Implements VideoOS.Platform.Data.IExporter.

◆ SignExport

virtual bool VideoOS.Platform.Data.DBExporter.SignExport

getset

Specifies if the export should be signed.

This option is only available for exports in BLK format.

Default value is false

◆ ViewerPaths

virtual string [] VideoOS.Platform.Data.DBExporter.ViewerPaths

getset

The path to the Viewer, and any language paths that should also be exported. Notice that the Viewer is no longer distributed with the Smart Client, and this field is ignored.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ DBExporter() [1/2]

◆ DBExporter() [2/2]

Member Function Documentation

◆ Cancel()

◆ Close()

◆ EndExport()

◆ Init()

◆ StartExport()

Property Documentation

◆ AudioList

◆ CameraList

◆ Compression

◆ Encryption

◆ EncryptionStrength

◆ ExportName

◆ ExportToDisk

◆ ExportToMediaBurner

◆ IncludeBookmarks

◆ IncludePlayer

◆ LastDetailedError

◆ LastError

◆ LastErrorString

◆ LastWarning

◆ MediaBurnerDriverLetter

◆ MetadataList

◆ Password

◆ Path

◆ PreventReExport

◆ PrivacyMask

◆ Progress

◆ SignExport

◆ ViewerPaths