VideoDVD Class Reference

VideoDVD provides methods for creating DVD Video compatible image layouts. More...

#include <PrimoBurner.h>

Inherits Reference.

List of all members.

Public Member Functions
virtual DataFile *	copyImageLayout ()=0
	Returns a DVD Video image layout.
virtual const ErrorInfo *	error () const =0
	Gets error information about the last operation.
virtual bool_t	setImageLayout (DataFile *pImageLayout)=0
	The setImageLayout method sets the logical layout of a data image.
virtual bool_t	setImageLayoutFromFolder (const char_t *lpRootFolder)=0
	The setImageLayoutFromFolder method sets the logical layout of a DVD Video image from a folder.
virtual void	setValidation (VideoDVDValidation::Enum validation)=0
	Sets the type of Video DVD structure validation to be performed.
virtual VideoDVDValidation::Enum	validation ()=0
	Gets the type of the Video DVD validation setting.
Protected Member Functions
	~VideoDVD ()
	This object can be destroyed only by the PrimoBurner library.

---

Detailed Description

VideoDVD provides methods for creating DVD Video compatible image layouts.

The layouts can be then written to ISO image file or a DVD with the DataDisc interface.

---

Member Function Documentation

virtual DataFile* copyImageLayout

(

)

[pure virtual]

Returns a DVD Video image layout.

The files and directories in the layout are ordered according to the DVD Video specification. The returned object can be set as an image layout using the DataDisc::setImageLayout method and then written to a disc or ISO image file.

Returns:

NULL There was an error.

see Object Management

virtual const ErrorInfo* error

(

)

const [pure virtual]

Gets error information about the last operation.

Returns:

A pointer to an ErrorInfo object.

virtual bool_t setImageLayout

(

DataFile *

pImageLayout

)

[pure virtual]

The setImageLayout method sets the logical layout of a data image.

Parameters:

pImageLayout

the logical file structure of the image, a tree of files and directories that should be used as an image layout. The first DataFile item in the directory tree should be the root of the image file system. The directory and file structure of pImageLayout must be compatible with the DVD Video specification. The method also reads the content of the *.IFO and *.BUP files in the VIDEO_TS directory and validates the layout.

Returns:

1 Success

0 Failed

See also:

DataFile

VideoDVD::setValidation

VideoDVDValidation::Enum

virtual bool_t setImageLayoutFromFolder

(

const char_t *

lpRootFolder

)

[pure virtual]

The setImageLayoutFromFolder method sets the logical layout of a DVD Video image from a folder.

The directory and file structure of the source folder must be compatible with the DVD Video specification. The logical directory and file layout of the image will be identical to the directory tree under the folder specified in lpRootFolder parameter. The method also reads the content of the *.IFO and *.BUP files in the VIDEO_TS directory and validates the layout.

Parameters:

lpRootFolder

Full path to a folder that should be used to create the image layout.

Returns:

1 Success

0 Failure

See also:

VideoDVD::setValidation

VideoDVDValidation::Enum

VideoDVD::error

virtual void setValidation

(

VideoDVDValidation::Enum

validation

)

[pure virtual]

Sets the type of Video DVD structure validation to be performed.

This method must be called before VideoDVD::setImageLayout or VideoDVD::setImageLayoutFromFolder methods, otherwise the default behavior will be used. The default behavior is full validation (VideoDVDValidation::Full).

Parameters:

validation

Indicates the type of validation to perform when verifying the Video DVD structure.

See also:

VideoDVD::validation

VideoDVD::setImageLayout

VideoDVD::setImageLayoutFromFolder

VideoDVDValidation::Enum

virtual VideoDVDValidation::Enum validation

(

)

[pure virtual]

Gets the type of the Video DVD validation setting.

Returns:

A constant from the VideoDVDValidation enumeration.

See also:

VideoDVD::setValidation

VideoDVDValidation::Enum