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

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

Inheritance diagram for DVDBuilder:
Reference

Public Member Functions

virtual bool_t build ()=0
 Builds a DVD file structure.
 
virtual DVDBuilderCallbackcallback ()=0
 Returns the DVDBuilderCallback object that is used by the DVDBuilder. More...
 
virtual const ErrorInfoerror () const =0
 Returns the error information for the last operation. More...
 
virtual InputDataStreamFactoryinputDataStreamFactory ()=0
 Returns the InputDataStreamFactory object that is used by the DVDBuilder. More...
 
virtual const char_t * outputFolder ()=0
 Gets the output directory for the DVD files.
 
virtual const char_t * projectFile ()=0
 Gets the DVD project file.
 
virtual void setCallback (DVDBuilderCallback *pCallback)=0
 The setCallback method registers the application to receive status messages from the DVDBuilder object. More...
 
virtual void setInputDataStreamFactory (InputDataStreamFactory *pFactory)=0
 Sets a factory object to be used for creating and destroying DataStream objects. More...
 
virtual void setOutputFolder (const char_t *pOutputFolder)=0
 Sets the output directory for the DVD files.
 
virtual void setProject (const uint8_t *pData, uint32_t dwLength)=0
 Sets the DVD project XML from a memory buffer. More...
 
virtual void setProjectFile (const char_t *pProjectFile)=0
 Sets the DVD project file. 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 provides methods that enable an application to build a DVD video file structure.

Version
1.0

Member Function Documentation

virtual DVDBuilderCallback* callback ( )
pure virtual

Returns the DVDBuilderCallback object that is used by the DVDBuilder.

Returns
A pointer to DVDBuilderCallback object or NULL if the callback is not set.
virtual const ErrorInfo* error ( ) const
pure virtual

Returns the error information for the last operation.

Returns
A pointer to an ErrorInfo object.
virtual InputDataStreamFactory* inputDataStreamFactory ( )
pure virtual

Returns the InputDataStreamFactory object that is used by the DVDBuilder.

Returns
A pointer to InputDataStreamFactory object or NULL if the inputDataStreamFactory is not set.
virtual void setCallback ( DVDBuilderCallback pCallback)
pure virtual

The setCallback method registers the application to receive status messages from the DVDBuilder object.

Parameters
pCallback[in] Pointer to the object that implements the DVDBuilderCallback interface. To unregister the callback class set pCallback to NULL.
virtual void setInputDataStreamFactory ( InputDataStreamFactory pFactory)
pure virtual

Sets a factory object to be used for creating and destroying DataStream 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
virtual void setProject ( const uint8_t *  pData,
uint32_t  dwLength 
)
pure virtual

Sets the DVD project XML from a memory buffer.

Parameters
pData[in] Pointer to the memory buffer that contains the DVD Project XML. The data in the buffer must be encoded as UTF-8 or UTF-16.
dwLength[in] Number of bytes in the buffer.
Version
1.10
virtual void setProjectFile ( const char_t *  pProjectFile)
pure virtual

Sets the DVD project file.

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

See also
DVD Project File