DVDBuilder for .NET  3.4
DVD Authoring Software Development Kit
DVDBuilder Class Reference

This interface provides methods that enable an application to build a DVD video file structure. More...

Inheritance diagram for DVDBuilder:

Public Member Functions

 DVDBuilder ()
 Creates a DVDBuilder object. More...
 
bool Build ()
 Builds a DVD file structure. More...
 
void Dispose ()
 Disposes the DVDBuilder and reclaims the resources used by the object. More...
 

Properties

ErrorInfo Error [get]
 The error information for the last operation. More...
 
InputDataStreamFactory InputDataStreamFactory [set]
 Sets a factory object to be used for creating System.IO.Stream objects. More...
 
string OutputFolder [get, set]
 Sets the output directory for the DVD files. More...
 
byte[] Project [set]
 Sets the DVD project XML from a memory buffer. More...
 
string ProjectFile [get, set]
 Sets a DVD project file. More...
 

Events

EventHandler
< DVDBuilderContinueEventArgs
OnContinue
 Raised to check if DVD creation process should continue. More...
 
EventHandler
< DVDBuilderProgressEventArgs
OnProgress
 Raised to report the progress of the DVD creation process. More...
 
EventHandler
< DVDBuilderStatusEventArgs
OnStatus
 Raised to report the DVDBuilder object status. More...
 

Detailed Description

This interface provides methods that enable an application to build a DVD video file structure.

Version
1.0

Constructor & Destructor Documentation

Creates a DVDBuilder object.

Member Function Documentation

bool Build ( )

Builds a DVD file structure.

Returns
true if the DVD-Video structure is created successfully; otherwise false.
void Dispose ( )

Disposes the DVDBuilder and reclaims the resources used by the object.

Property Documentation

ErrorInfo Error
get

The error information for the last operation.

See also
ErrorInfo

Sets a factory object to be used for creating System.IO.Stream objects.

The DVDBuilder engine calls the provided factory class for each <videoObject> XML element which have its "callback" attribute set to "true". The data stream objects which are returned by the factory are then used for reading the actual video object data.

Version
1.10
string OutputFolder
getset

Sets the output directory for the DVD files.

byte [] Project
set

Sets the DVD project XML from a memory buffer.

The data in the buffer must be encoded as UTF-8 or UTF-16.

Version
1.10
string ProjectFile
getset

Sets a DVD project file.

The DVD project file contains XML that configures the DVD titles, video objects and menus.

Event Documentation

EventHandler<DVDBuilderContinueEventArgs> OnContinue

Raised to check if DVD creation process should continue.

The event handler receives an argument of type DVDBuilderContinueEventArgs containing data related to this event.

EventHandler<DVDBuilderProgressEventArgs> OnProgress

Raised to report the progress of the DVD creation process.

The event handler receives an argument of type DVDBuilderProgressEventArgs containing data related to this event.

EventHandler<DVDBuilderStatusEventArgs> OnStatus

Raised to report the DVDBuilder object status.

The event handler receives an argument of type DVDBuilderStatusEventArgs containing data related to this event.