This interface represents a virtual device used a storage of a DVD video recording. More...
Public Member Functions | |
| void | Dispose () |
| Disposes the VRDevice and reclaims the resources used by the object. More... | |
| bool | EraseMedia () |
| Erases a rewritable disc. More... | |
| bool | Initialize () |
| Initializes VRDevice. More... | |
| bool | NotifyOSFileSystemChanged () |
| Notifies the operating system that the file contents have changed. More... | |
Properties | |
| object | Config [get] |
| Returns a device configuration object. More... | |
| ErrorInfo | Error [get] |
| The error information for the last operation. More... | |
| Int64 | MediaFreeSpace [get] |
| Gets the remaining free space in bytes. More... | |
| bool | MediaIsBlank [get] |
| Gets whether the disc is blank. More... | |
| bool | MediaIsReWritable [get] |
| Gets whether the disc is rewritable. More... | |
| VRDeviceType | Type [get] |
| Gets the device type of a video recording device. More... | |
Detailed Description
This interface represents a virtual device used a storage of a DVD video recording.
The underlying physical device is either a file system or an optical disc burner. A VRDevice object can be created with VRDevicePlugin.CreateOpticalDiscDevice or VRDevicePlugin.CreateFileSystemDevice.
A VideoRecorder object needs at least one VRDevice. A VRDevice object should be added to the device list of the video recorder: VideoRecorder.Devices The device object must be initialized successfully before it can be used for recording or reading.
- Version
- 2.0
Member Function Documentation
| void Dispose | ( | ) |
Disposes the VRDevice and reclaims the resources used by the object.
| bool EraseMedia | ( | ) |
Erases a rewritable disc.
When a disc is erased it becomes blank. The disc cannot be ejected manually while it is being erased. Non rewritable disc (DVD+R, DVD-R) cannot be erased.
- Returns
- true if the disc is erased successfully; otherwise false.
| bool Initialize | ( | ) |
Initializes VRDevice.
This must be done before the device object can be used for recording or reading existing data. Video Recorder should start the recording process (VideoRecorder.Start) only when all device objects in its device list are initialized successfully. The device object may be initialized before or after it is added to the device list.
- Version
- 2.0
- Returns
- true if the VRDevice is successfully initialized and can be used; otherwise false.
| bool NotifyOSFileSystemChanged | ( | ) |
Notifies the operating system that the file contents have changed.
This is necessary to see the updated files in the file browser.
- Version
- 2.0
- Returns
- true if the operation has succeeded; otherwise false.
Property Documentation
|
get |
Returns a device configuration object.
It should be cast to the appropriate device configuration interface depending on the device type.
- Version
- 2.0
|
get |
Gets the remaining free space in bytes.
If the free space cannot be obtained then VRDevice.Error facilicty is not ErrorFacility.Success.
- Version
- 2.0
|
get |
Gets whether the disc is blank.
Returns true when the disc is blank, false otherwise. If the blank state cannot be obtained then VRDevice.Error facilicty is not ErrorFacility.Success. In this case the return value should be ignored.
- Version
- 2.0
- See also
- VRDevice.EraseMedia
|
get |
Gets whether the disc is rewritable.
Returns true when the disc is rewritable (DVD-RW, DVD+RW, DVD-RAM), false otherwise (DVD-R, DVD+R). If the rewritable property cannot be obtained then VRDevice.Error facilicty is not ErrorFacility.Success. In this case the return value should be ignored.
- Version
- 2.0
|
get |
Gets the device type of a video recording device.
- Version
- 2.0