DRBurnSession.h

Overview

Burn configuration and progress user interface for Carbon applications

Functions

DRBurnSessionBeginProgressDialog

Presents the progress interface as a non-modal dialog.

DRBurnSessionCreate

Creates a new burn session.

DRBurnSessionGetBurn

Returns the burn object for this session.

DRBurnSessionGetTypeID

Returns the type identifier of all DRBurnSession instances.

DRBurnSessionSetBurn

Sets the burn object for this session.

DRBurnSessionSetupDialog

Presents the setup interface as a modal dialog.

Presents the progress interface as a non-modal dialog.

extern void DRBurnSessionBeginProgressDialog( 
    DRBurnSessionRef burnSession, 
    CFTypeRef layout, 
    DRBurnSessionProgressDialogOptions *options, 
    DRBurnSessionProgressCallbacks *progressCallbacks);  

Parameters

burnSession

The burn session object

layout

The track layout to be used for the burn.

options

A pointer to a structure of type DRBurnSessionSetupDialogOptions .

progressCallbacks

A pointer to a structure of type DRBurnSessionProgressCallbacks . This pointer may be NULL if no custom behavior is desired.

Discussion

This function present the user with a non-modal dialog that shows the burn progress.

Availability

Introduced in Mac OS X v10.3.

Creates a new burn session.

extern DRBurnSessionRef DRBurnSessionCreate(
    void);  

Return Value

A reference to a new DRBurnSession.

Availability

Introduced in Mac OS X v10.3.

Returns the burn object for this session.

extern DRBurnRef DRBurnSessionGetBurn( 
    DRBurnSessionRef burnSession);  

Parameters

burnSession

The burn session. If this parameter is not a valid DRBurnSessionRef , the behavior is undefined.

Return Value

A reference to the burn object for the session. If the setup dialog has not been run or a burn object has not been set with DRBurnSessionSetBurn , this function returns NULL.

Availability

Introduced in Mac OS X v10.3.

Returns the type identifier of all DRBurnSession instances.

extern CFTypeID DRBurnSessionGetTypeID(
    void);  

Return Value

A Core Foundation type ID.

Availability

Introduced in Mac OS X v10.3.

Sets the burn object for this session.

extern void DRBurnSessionSetBurn( 
    DRBurnSessionRef burnSession, 
    DRBurnRef burn);  

Parameters

burnSession

The burn session. If this parameter is not a valid DRBurnSessionRef , the behavior is undefined.

burn

The burn to use for the session. If this parameter is not a valid DRBurnRef , the behavior is undefined.

Availability

Introduced in Mac OS X v10.3.

Presents the setup interface as a modal dialog.

extern SInt8 DRBurnSessionSetupDialog( 
    DRBurnSessionRef burnSession, 
    DRBurnSessionSetupDialogOptions *options, 
    DRBurnSessionSetupCallbacks *setupCallbacks);  

Parameters

burnSession

The burn session object

options

A pointer to a structure of type DRBurnSessionSetupDialogOptions . This pointer may be NULL if no custom configuration is required.

setupCallbacks

A pointer to a structure of type DRBurnSessionSetupCallbacks . This pointer may be NULL if no custom behavior is desired.

Return Value

Returns one of the constants defined by Burn Session Dialog Result Codes .

Discussion

This function present the user with a modal dialog that allows them to configure a burn to their custom settings. These include: the device to use, whether or not to eject the media when finished, the burn speed and others. The function does not return until the user dismissed the dialog.

Availability

Introduced in Mac OS X v10.3.

Typedefs

Callback notifying the application the burn has finished.

typedef Boolean ( *DRBurnSessionBurnCompleteProcPtr )(
    DRBurnSessionRef burnSession,
    DRBurnRef burn);  

Parameters

burnSession

The burn session object.

burn

The burn instance that just finished.

Return Value

A Boolean value controlling the display of the burn session's error dialog.

Discussion

This callback is called when the burn operation completes, either successfully or with an error. This function can be used by the application to present it's own custom end-of-burn handling. Return a false return value to prevent the burn session from presenting it's own notification.

Callback used for checking the suitability of a device.

typedef Boolean ( *DRBurnSessionDeviceCheckProcPtr )(
    DRBurnSessionRef burnSession,
    DRDeviceRef device);  

Parameters

burnSession

The burn session object.

device

The device to examine.

Return Value

A Boolean value indicating the suitability of the device.

Discussion

This callback is called whenever a new device appears. It's purpose is to allow the application to filter out devices which do not support the operation to be performed. for example, a device may filter our CD-R/Ws if it is a DVD creation appliacation.

Callback used to notify the application of a new device selected.

typedef void ( *DRBurnSessionDeviceSelectionNotificationProcPtr )(
    DRBurnSessionRef burnSession,
    DRDeviceRef device);  

Parameters

burnSession

The burn session object.

device

The newly selected device.

Callback used for checking the suitability of media in a device.

typedef Boolean ( *DRBurnSessionMediaCheckProcPtr )(
    DRBurnSessionRef burnSession,
    DRDeviceRef device,
    CFStringRef *prompt);  

Parameters

burnSession

The burn session object.

device

The device containing the media to examine.

prompt

A pointer to a CFStringRef. An application may return a custom message to display in the setup dialog.

Return Value

A Boolean value indicating the suitability of the media.

Discussion

This callback is called whenever the state of the media has changed. It's purpose is to allow the application to determine if the media is suitable for the operation to be performed. For example, the application an check to see if there is enough space on the media for the data to be written.

Callback notifying the application the burn progress is about to begin.

typedef void ( *DRBurnSessionProgressBeginNotificationProcPtr )(
    DRBurnSessionRef burnSession);  

Parameters

burnSession

The burn session object.

Discussion

This callback is called when the burn progress is about to be displayed. This allows the application to do things such as disable the quit menu item, or the close menu for a document window.

Specifies progress dialog configuration options.

typedef UInt32 DRBurnSessionProgressDialogOptionFlags;  

Callback notifying the application the burn progress has finished.

typedef void ( *DRBurnSessionProgressFinishNotificationProcPtr )(
    DRBurnSessionRef burnSession);  

Parameters

burnSession

The burn session object.

Discussion

This callback is called when the burn progress has been removed from view. This allows the application to do things such as re-enable the quit menu item, or the close menu for a document window.

typedef struct __DRBurnSession* DRBurnSessionRef;  

Discussion

This is the type of a reference to DRBurnSession instances.

Specifies setup dialog configuration options.

typedef UInt32 DRBurnSessionSetupDialogOptionFlags;  

Structs and Unions

Callback functions passed to the progress dialog.

struct DRBurnSessionProgressCallbacks { 
    UInt32 version; 
    DRBurnSessionProgressBeginNotificationProcPtr progressWillBegin; 
    DRBurnSessionProgressFinishNotificationProcPtr progressDidFinish; 
    DRBurnSessionBurnCompleteProcPtr burnDidFinish; 
};  

Fields

version

Identifies the version of this structure.

progressWillBegin

Pointer to a DRBurnSessionProgressBeginNotificationProcPtr. The value of this field may be NULL.

progressDidFinish

Pointer to a DRBurnSessionProgressFinishNotificationProcPtr. The value of this field may be NULL.

burnDidFinish

Pointer to a DRBurnSessionBurnCompleteProcPtr. The value of this field may be NULL.

Options passed into the progress dialog to configure it.

struct DRBurnSessionProgressDialogOptions { 
    UInt32 version; 
    DRBurnSessionProgressDialogOptionFlags dialogOptionFlags; /* 
        option flags for affecting the dialog's behavior */
    CFStringRef description; /* optional description of the burn */
};  

Fields

version

Identifies the version of this structure.

dialogOptionFlags

One of several constants defined by the DRBurnSessionProgressDialogOptionFlags data type as described in Burn Progress Dialog Option Flags .

description

A CFStringRef that defines a custom description to be used for the dialog. If you do not provide this string (passing NULL), the normal description is used.

Callback functions passed to the setup dialog.

struct DRBurnSessionSetupCallbacks { 
    UInt32 version; 
    DRBurnSessionDeviceCheckProcPtr deviceShouldBeTarget; 
    DRBurnSessionMediaCheckProcPtr containsSuitableMedia; 
    DRBurnSessionDeviceSelectionNotificationProcPtr deviceSelectionChanged; 
};  

Fields

version

Identifies the version of this structure.

deviceShouldBeTarget

Pointer to a DRBurnSessionDeviceCheckProcPtr. The value of this field may be NULL.

containsSuitableMedia

Pointer to a DRBurnSessionMediaCheckProcPtr. The value of this field may be NULL.

deviceSelectionChanged

Pointer to a DRBurnSessionDeviceSelectionNotificationProcPtr. The value of this field may be NULL.

Options passed into the setup dialog to configure it.

struct DRBurnSessionSetupDialogOptions { 
    UInt32 version; 
    DRBurnSessionSetupDialogOptionFlags dialogOptionFlags; /* option flags for affecting the dialog's behavior */
    CFStringRef defaultButtonTitle; /* title of default button */
};  

Fields

version

Identifies the version of this structure.

dialogOptionFlags

One of several constants defined by the DRBurnSessionSetupDialogOptionFlags data type as described in Burn Setup Dialog Option Flags .

defaultButtonTitle

A CFStringRef that defines a custom title to be used for the dialog's default button. If you do not provide this string (passing NULL), the normal button title is used.

Enumerations

enum { 
    kBurnSessionProgressDialogDefaultOptions = 0x00000000, /* use defaults for all the options */
    kBurnSessionProgressDialogDisplayVerboseProgress = 0x00000001 /* 
        Report all status changes in detail */
};  

Constants

kBurnSessionProgressDialogDefaultOptions

Use defaults for all the options

kBurnSessionProgressDialogDisplayVerboseProgress

Report all status changes in detail

Discussion

Flags used to configure the burn progress dialog behavior

enum { 
    kDRBurnSessionOK = 1, 
    kDRBurnSessionCancel = 0, 
};  

Constants

kDRBurnSessionOK

Value returned by the setup dialog when the user has confirmed the burn setup.

kDRBurnSessionCancel

Value returned by the setup dialog when the user has canceled the burn setup.

Discussion

Return codes for the burn session setup dialog.

enum { 
    kBurnSessionSetupDialogDefaultOptions = 0x00000000, /* use defaults for all the options */
    kBurnSessionSetupDialogForceClosedDiscs = 0x00000001, /* Force discs to be closed (not appendable) */
    kBurnSessionSetupDialogDontHandleReservations = 0x00000002, /* 
        Don't handle media reservations. Application handles them itself */
    kBurnSessionSetupDialogAllowTestBurns = 0x80000004 /* Allow the user to perform a test burn */
};  

Constants

kBurnSessionSetupDialogDefaultOptions

Use defaults for all the options

kBurnSessionSetupDialogForceClosedDiscs

Force discs to be closed (not appendable)

kBurnSessionSetupDialogDontHandleReservations

Burn session does not handle media reservations. Application handles them itself

kBurnSessionSetupDialogAllowTestBurns

Allow the user to perform a test burn

Discussion

Flags used to configure the burn setup dialog behavior

enum { 
    kBurnSessionProgressDialogOptionsCurrentVersion = 1 
};  

enum { 
    kDRBurnSessionSetupCallbacksCurrentVersion = 1 
};  

enum { 
    kBurnSessionSetupDialogOptionsCurrentVersion = 1 
};  

enum { 
    kDRBurnProgressSetupCallbacksCurrentVersion = 1 
};  

Did this document help you? Yes: Tell us what works for you. It’s good, but: Report typos, inaccuracies, and so forth. It wasn’t helpful: Tell us what would have helped.

Last Updated: 2008-03-11