DVDBuilder for .NET  3.4
DVD Authoring Software Development Kit
Package PrimoSoftware.DVDBuilder.VR

Classes

class  FileSystemDeviceConfig
 This interface configures an HDD device used for DVD video recording. More...
 
class  OpticalDiscDeviceConfig
 This interface configures a burner device used for DVD video recording. More...
 
class  Title
 This interface is used to get information about a particular DVD-Video title. More...
 
class  VideoRecorder
 This class represents the DVD video recorder and is used to carry out the DVD recording. More...
 
class  VRDevice
 This interface represents a virtual device used a storage of a DVD video recording. More...
 
class  VRDevicePlugin
 This interface creates the video recording devices used by VideoRecorder. More...
 

Enumerations

enum  VideoRecorderError {
  Success = 0,
  InternalError = 1,
  InvalidStructure = (0x900 + 1),
  RecordingNotStarted = (0x900 + 2),
  RecordingAlreadyStarted = (0x900 + 3),
  MultiplexerError = (0x900 + 4),
  InvalidVideoStreamCount = (0x900 + 5),
  InvalidVideoCodec = (0x900 + 6),
  InvalidVideoAspectRatio = (0x900 + 7),
  InvalidVideoResolution = (0x900 + 8),
  InvalidVideoFrameRate = (0x900 + 9),
  InvalidAudioStreamCount = (0x900 + 10),
  InvalidAudioSamplingFrequency = (0x900 + 11),
  InvalidAudioCodec = (0x900 + 12),
  InvalidAudioBitrate = (0x900 + 13),
  DeviceError = (0x900 + 14),
  DeviceNotSet = (0x900 + 15),
  StartAsyncBufferFull = (0x900 + 16),
  InvalidDeviceIndex = (0x900 + 17)
}
 The VideoRecorderError type defines the possible errors returned by VideoRecorder.Error when the error facility is VideoRecorder. More...
 
enum  VRDeviceError {
  Success = 0,
  IncompatibleMedia = 0x801,
  MediaNotPresent = 0x802,
  FileSystemError = 0x803,
  NotInitialized = 0x804,
  OutOfFreeSpace = 0x805
}
 The VRDeviceError type defines the possible errors returned by VRDevice.Error More...
 
enum  VRDevicePluginError {
  Success = 0,
  NotSupported = 0x701
}
 The VRDevicePluginError type defines the possible errors returned by VRDevicePlugin.Error More...
 
enum  VRDeviceType {
  FileSystem = 1,
  OpticalDisc = 2
}
 The VRDeviceType defines video recording storage devices. More...
 

Enumeration Type Documentation

The VideoRecorderError type defines the possible errors returned by VideoRecorder.Error when the error facility is VideoRecorder.

Version
2.0
Enumerator
Success 

Success.

InternalError 

Unexpected error in Video Recorder.

InvalidStructure 

Invalid DVD structure found in the IFO file on the disc.

RecordingNotStarted 

The recorder must be started in order to complete the required operation.

RecordingAlreadyStarted 

The recorder must be stopped in order to complete the required operation.

MultiplexerError 

The input MPEG-2 stream cannot be re-multiplexed.

InvalidVideoStreamCount 

The input stream must contain one video stream.

InvalidVideoCodec 

The input stream must be encoded in MPEG-2 format.

InvalidVideoAspectRatio 

The input video stream has invalid aspect ratio.

The valid aspect ratios are 4:3 | 16:9

InvalidVideoResolution 

The input video stream has invalid resolution.

The valid video resolutioins are:

    <p>NTSC: 720x480 | 704x480 | 352x480 | 352x240</p>

PAL: 720x576 | 704x576 | 352x576 | 352x288

InvalidVideoFrameRate 

The input video stream has invalid frame rate.

The valid frame rates are 29.97 fsp (NTSC) and 25 fps (PAL).

InvalidAudioStreamCount 

The input MPEG-2 stream contains more than 8 audio streams.

InvalidAudioSamplingFrequency 

One or more input audio streams have invalid sampling frequency. It must be either 48KHz or 96KHz.

InvalidAudioCodec 

One or more input audio streams are not in the expected format.

The valid audio codec are: LPCM (16, 20, 24 bit), MPEG-1 Audio and AC-3 (Dolby Digital), DTS (Digital Theater System).

InvalidAudioBitrate 

One or more input audio streams have invalid bitrate.

The allowed max bitrates are:

LPCM: 6144 kbit/s

MPEG-1 Audio: 384 kbit/s

AC-3 (Dolby Digital): 448 kbit/s

DTS (Digital Theater System): 1536 kbit/s

DeviceError 

One or more of the devices used by the video recorder have failed after calling one of the following methods: VideoRecorder.PrepareMedia VideoRecorder.Start VideoRecorder.Write VideoRecorder.Stop and VideoRecorder.FinalizeMedia In order to get a more detailed information enumerate the device error state using VideoRecorder.GetDeviceError. The device error state is reset upon calling one of the following methods: VideoRecorder.PrepareMedia, VideoRecorder.Start and VideoRecorder.FinalizeMedia.

When VideoRecorder.Write is called any of the attached devices may fail and the error state is preserved until the Stop method is called. The failed devices are not used till the end of the recording. When the application gets a device error after calling VideoRecorder.Write it may either stop the recording process or it may continue to write to the video recorder if at least one of the devices has a clean error state (VideoRecorder.GetDeviceError is ErrorFacility.Success).

When VideoRecorder.Stop is called the video recorder tries to stop the devices that have a clean error state and those that have run out of space. Their error state is updated. The other devices are keep their error state.

DeviceNotSet 

There's no device attached to the video recorder.

StartAsyncBufferFull 

The recording process has been started asyncronously using the StartAsync method and the video recorder cannot accept more data through the Write method. Usually this is a sign that the media cannot be prepared for writing within certain time and the Stop method must be called to stop the recording. All data buffered in the video recorder is lost.

InvalidDeviceIndex 

The device index is not in the allowed range.

The specified index is not a valid index either in the device list or in the device error state list. VideoRecorder.GetTitles VideoRecorder.GetDeviceError

The VRDeviceError type defines the possible errors returned by VRDevice.Error

Version
2.0
Enumerator
Success 

No error.

The operation is successful.

IncompatibleMedia 

The device can neither read from nor write to the disc.

A DVD disc is required.

MediaNotPresent 

There is no disc in the device.

FileSystemError 

Cannot recognize the existing file system on the disc.

The disc can be used after being erased.

NotInitialized 

In order to complete the required operation the device must be initialized first.

OutOfFreeSpace 

There's no free space on the disc.

The VRDevicePluginError type defines the possible errors returned by VRDevicePlugin.Error

Version
2.0
Enumerator
Success 

No error.

The operation is successful.

NotSupported 

The requested operation is not supported by the device plugin.

The VRDeviceType defines video recording storage devices.

Version
2.0
Enumerator
FileSystem 

The video will be recorded to a file system device like hard disk.

OpticalDisc 

The video will be recorded to an optical disc device.