PrimoBurner(tm) for C++  4.6
CD, DVD and Blu-ray Software Development Kit
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Pages
DiscLayoutCallback Class Reference

Implement this interface to provide information to DiscArchive for managing the footer size. More...

#include <PrimoBurnerAPI.h>

Inherits Reference.

Public Member Functions

virtual bool_t onContinueWrite ()
 Called to check if recording should continue. More...
 
virtual void onFileCompleteWithPath (const char_t *sourcePath, const char_t *layoutPath)
 Called when a specific file from the layout is written on the target disc. More...
 
virtual void onFileErrorWithPath (const char_t *sourcePath, const char_t *layoutPath, const ErrorInfo *error)
 Called when a specific file from the layout cannot be written on the target disc due to file access/read errors. More...
 
virtual void onProgress (int32_t current, int32_t all)
 Called to report the number of blocks written to the target disc. More...
 
int32_t release () const
 Simple implementation of primo::Reference::release. More...
 
int32_t retain () const
 Simple implementation of primo::Reference::retain. More...
 
int32_t retainCount () const
 Simple implementation of primo::Reference::retainCount. More...
 

Detailed Description

Implement this interface to provide information to DiscArchive for managing the footer size.

See Also
DiscArchive::setFooterPolicy
DiscArchive::footerPolicy

Member Function Documentation

virtual bool_t onContinueWrite ( )
virtual

Called to check if recording should continue.

Remarks
This method is called for each file from the layout after it is recorded on the target disc. While a file is being recorded this method is not called.
Returns
TRUE if writing should continue.
FALSE if writing should be stopped.
virtual void onFileCompleteWithPath ( const char_t *  sourcePath,
const char_t *  layoutPath 
)
virtual

Called when a specific file from the layout is written on the target disc.

Parameters
sourcePath[in] The Actual full path of the file on the hard drive/network location/ etc.
layoutPath[in] The path of the item within the layout which is recorded successfully. This value may be used in the DataFile::find() method to access the actual DataFile item.
virtual void onFileErrorWithPath ( const char_t *  sourcePath,
const char_t *  layoutPath,
const ErrorInfo error 
)
virtual

Called when a specific file from the layout cannot be written on the target disc due to file access/read errors.

Parameters
sourcePath[in] The Actual full path of the file on the hard drive/network location/ etc, for which the error was raised.
layoutPath[in] The path of the item within the layout, for which the error was raised. This value may be used in the DataFile::find() method to access the actual DataFile item.
error[in] The description of the error that triggered the file error.
virtual void onProgress ( int32_t  current,
int32_t  all 
)
virtual

Called to report the number of blocks written to the target disc.

Parameters
current[in] The number of blocks that are already written from the layout.
all[in] The total number of blocks that will be written from the layout. This is always the size of the image layout in blocks.
int32_t release ( ) const
virtual

Simple implementation of primo::Reference::release.

Returns
The updated reference count.

Implements Reference.

int32_t retain ( ) const
virtual

Simple implementation of primo::Reference::retain.

Returns
The updated reference count.

Implements Reference.

int32_t retainCount ( ) const
virtual

Simple implementation of primo::Reference::retainCount.

Returns
The current reference count.

Implements Reference.