DVDBuilder for C++  3.4
DVD Authoring Software Development Kit
VRDevicePlugin Class Referenceabstract

This interface creates the video recording devices used by VideoRecorder. More...

Inheritance diagram for VRDevicePlugin:
Reference

Public Member Functions

virtual uint16_t apiRevision ()=0
 Returns the API revision (version) of the DVD VR device plugin. More...
 
virtual VRDevicecreateFileSystemDevice (const char_t *pPath)=0
 Creates a File System device that can be added to the video recorder device list. More...
 
virtual VRDevicecreateOpticalDiscDevice (char letter, bool_t exclusiveAccess)=0
 Creates an Optical Disc device that can be added to the video recorder device list. More...
 
virtual VRDevicecreateOpticalDiscDevice (handle_t handle)=0
 
virtual void disableTraceLog ()=0
 The DisableTraceLog method disables the plugin trace log.
 
virtual bool_t enableTraceLog (const char_t *pFilePath, bool_t fUseExisting=0)=0
 The enableTraceLog method enables the plugin trace log. More...
 
virtual const ErrorInfoerror () const =0
 Returns the error information for the last operation. More...
 
- Public Member Functions inherited from Reference
virtual int32_t release () const =0
 Releases the instance. More...
 
virtual int32_t retain () const =0
 Retains the instance. More...
 
virtual int32_t retainCount () const =0
 Returns the current reference count. More...
 

Detailed Description

This interface creates the video recording devices used by VideoRecorder.

The recorder writes the DVD video to all devices in its device list.

An VRDevicePlugin instance can be created through VideoRecorder::loadDevicePlugin

Version
2.0
See also
VideoRecorder::devices
VideoRecorder::loadDevicePlugin

Member Function Documentation

virtual uint16_t apiRevision ( )
pure virtual

Returns the API revision (version) of the DVD VR device plugin.

Returns
The high order byte is the major version and the low order byte is the minor version of the API.
Version
2.0
virtual VRDevice* createFileSystemDevice ( const char_t *  pPath)
pure virtual

Creates a File System device that can be added to the video recorder device list.

The device is created from a file system path.

Parameters
pPath[in] File system path.
Returns
A pointer to a video recording device.
Version
2.0
See also
VRDeviceType
VRDevice
VideoRecorder::devices
virtual VRDevice* createOpticalDiscDevice ( char  letter,
bool_t  exclusiveAccess 
)
pure virtual

Creates an Optical Disc device that can be added to the video recorder device list.

The device is created either from a drive letter or from an OS handle.

Parameters
letter[in] Drive letter.
handle[in] OS device handle. It is possible to get the handle from an existing video recording device (OpticalDiscDeviceConfig::deviceHandle). The newly created video recording device will operate on the same physical device.
Returns
A pointer to a video recording device.
Version
2.0
See also
VRDeviceType
VRDevice
VideoRecorder::devices
OpticalDiscDeviceConfig::deviceHandle
virtual bool_t enableTraceLog ( const char_t *  pFilePath,
bool_t  fUseExisting = 0 
)
pure virtual

The enableTraceLog method enables the plugin trace log.

The trace log is useful for identifying errors or problems with particular devices.

WARNING: This method will delete the file specified in pFilePath, if fUseExisting parameter is set to FALSE.

Parameters
pFilePath- full path to the file that should be used to log plugin trace messages.
fUseExisting- indicates whether an existing file should be used or a new log file should be created. Set this parameter to FALSE to create a new empty log file or to TRUE to use an already existing file.
Returns
TRUE if the log was enabled successfully.
FALSE if fUseExisting was set to FALSE and a log file cannot be created with the specified path.
FALSE if fUseExisting was set to TRUE and a log file with the specified path does not exist.
virtual const ErrorInfo* error ( ) const
pure virtual

Returns the error information for the last operation.

Returns
A pointer to an ErrorInfo object.