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

This interface represents a virtual device used as a storage of a DVD video recording. More...

Inheritance diagram for VRDevice:
Reference

Public Member Functions

virtual void * config ()=0
 Returns a device configuration object. More...
 
virtual bool_t eraseMedia ()=0
 Erases a rewritable disc. More...
 
virtual const
primo::dvdbuilder::ErrorInfo
error () const =0
 Returns the error information for the last operation. More...
 
virtual bool_t initialize ()=0
 Initializes VRDevice . More...
 
virtual uint64_t mediaFreeSpace ()=0
 Gets the remaining free space in bytes. More...
 
virtual bool_t mediaIsBlank ()=0
 Gets whether the disc is blank. More...
 
virtual bool_t mediaIsReWritable ()=0
 Gets whether the disc is rewritable. More...
 
virtual bool_t notifyOSFileSystemChanged ()=0
 Notifies the operating system that the file contents have changed. More...
 
virtual uint32_t type ()=0
 Gets the type of a video recording device. 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 represents a virtual device used as a storage of a DVD video recording.

The underlying physical device is either a file system or an optical disc burner.

An VRDevice instance can be created with VRDevicePlugin::createOpticalDiscDevice or VRDevicePlugin::createFileSystemDevice .

An VideoRecorder object needs at least one VRDevice. An VRDevice instance should be added to the device list of the video recorder: VideoRecorder::devices The VRDevice instance must be initialized successfully before it can be used for recording or reading.

Version
2.0

Member Function Documentation

virtual void* config ( )
pure virtual

Returns a device configuration object.

It should be cast to the appropriate device configuration interface depending on the device type.

Returns
Storage configuration object
Version
2.0
virtual bool_t eraseMedia ( )
pure virtual

Erases a rewritable disc.

When a disc is erased it becomes blank. The disc cannot be ejected manually while it is being erased.

Returns
The return value is 1 when the disc is erased successfully.
The return value is 0 when the disc cannot be erased. Non rewritable discs (DVD+R, DVD-R) cannot be erased.
Version
2.0
See also
VRDevice::mediaIsBlank
VRDevice::mediaIsReWritable
virtual const primo::dvdbuilder::ErrorInfo* error ( ) const
pure virtual

Returns the error information for the last operation.

Returns
A pointer to an ErrorInfo object.
virtual bool_t initialize ( )
pure virtual

Initializes VRDevice .

This must be done before the device can be used for recording or reading existing data.

VideoRecorder should start the recording process (VideoRecorder::start ) only when all device instances in its device list are initialized successfully. A device instance may be initialized before or after it is added to the device list.

Returns
1. The VRDevice instance is successfully initialized and can be used.
0. The VRDevice instance cannot be used.
Version
2.0
virtual uint64_t mediaFreeSpace ( )
pure virtual

Gets the remaining free space in bytes.

If the free space cannot be obtained VRDevice::error facility is non-zero. In this case the return value should be ignored.

Returns
Free space in bytes.
Version
2.0
See also
VRDevice::error
VideoRecorder::mediaFreeSpace
virtual bool_t mediaIsBlank ( )
pure virtual

Gets whether the disc is blank.

If the blank state cannot be obtained VRDevice::error facility is non-zero. In this case the return value should be ignored.

Returns
The return value is 1 when the disc is blank and 0 when the disc is not blank.
Version
2.0
See also
VRDevice::eraseMedia
VRDevice::error
virtual bool_t mediaIsReWritable ( )
pure virtual

Gets whether the disc is rewritable.

If the rewritable state cannot be obtained VRDevice::error facility is non-zero. In this case the return value should be ignored.

Returns
The return value is 1 for DVD-RW, DVD+RW and DVD-RAM and 0 for DVD-R and DVD+R.
Version
2.0
See also
VRDevice::error
virtual bool_t notifyOSFileSystemChanged ( )
pure virtual

Notifies the operating system that the file contents have changed.

This is necessary to see the updated files in the file browser.

Returns
1 Success.
0 An error occurred.
Version
2.0
virtual uint32_t type ( )
pure virtual

Gets the type of a video recording device.

Returns
A VRDeviceType::Enum value.
Version
2.0