PrimoBurner for .NET
4.6
CD, DVD and Blu-ray Software Development Kit
|
The DiscLayout object provides a way for recording all or a portion of DiscArchive content on a single disc. More...
Inherits IDisposable.
Public Member Functions | |
bool | Close () |
Finalizes the write operations. More... | |
void | Dispose () |
Disposes DiscLayout and reclaims the resources used by the object. More... | |
bool | Open () |
Prepares the DiscLayout object for recording the selected content and footer to the target medium. More... | |
void | SetFooter (DataFile footer) |
The method sets a layout describing the "footer" to be recorded after the DiscLayout.WriteContent operation finishes. More... | |
bool | WriteContent () |
Writes the selected content on the target medium. More... | |
bool | WriteFileSystem () |
Writes the file system describing the content of the disc More... | |
bool | WriteFileSystem (bool dismountVolume) |
Writes the file system describing the content of the disc More... | |
bool | WriteFooter () |
Writes the selected footer on the target medium. More... | |
Properties | |
DataFile | Content [get] |
Gets the layout that will be written on the target medium. More... | |
DataFile | ContentOnDisc [get] |
Gets the description of the layout already present on the target medium before the current layout is written to it. More... | |
Device | Device [get, set] |
Gets/Sets the device that this object will use. More... | |
ErrorInfo | Error [get] |
The error information for the last DiscLayout operation. More... | |
DataFile | Footer [get] |
Gets a DatFile object defining the content of the footer to be recorded after the layout content goes on disc More... | |
Int32 | ImageSize [get] |
Returns the number of blocks needed on the target medium to write the selected content and footer. More... | |
Int32 | MediaFreeSpace [get] |
Returns the available space in blocks on the target medium before calling any of the write methods. More... | |
Int32 | SessionStartAddress [get, set] |
Gets/sets the address at which content recording will begin on the target medium. More... | |
string | VolumeLabel [get, set] |
Gets/sets the new volume label that will be set on the target medium when DiscLayout.WriteFileSystem method is called. More... | |
Events | |
EventHandler < DiscLayoutContinueWriteEventArgs > | OnContinueWrite |
Raised to check if burning should continue. More... | |
EventHandler < DiscLayoutFileEventArgs > | OnFileComplete |
Raised when a specific file from the layout is written on the target medium. More... | |
EventHandler < DiscLayoutFileErrorEventArgs > | OnFileError |
Raised when a specific file from the layout cannot be written on the target medium due to file access/read errors. More... | |
EventHandler < DiscLayoutProgressEventArgs > | OnProgress |
Raised to report the number of blocks written to the target medium. More... | |
The DiscLayout object provides a way for recording all or a portion of DiscArchive content on a single disc.
A DiscLayout object may be obtained only by calling DiscArchive.PrepareLayout method on a source DiscArchive object. Once obtained the DiscLayout is responsible for writing its content and footer on the target medium, as well as the file system that describes the recorded content and footer.
The following example is a simple demonstration of how DiscArchive and DiscLayout classes can be used:
bool Close | ( | ) |
Finalizes the write operations.
Call this method after DiscLayout.WriteFileSystem to complete the write sequence.
ObjectDisposedException | The DiscLayout object was previously disposed. |
void Dispose | ( | ) |
Disposes DiscLayout and reclaims the resources used by the object.
bool Open | ( | ) |
Prepares the DiscLayout object for recording the selected content and footer to the target medium.
Call this method before calling DiscLayout.WriteContent, DiscLayout.WriteFooter and DiscLayout.WriteFileSystem
false - Failure. Check DiscLayout.Error property.
ObjectDisposedException | The DiscLayout object was previously disposed. |
void SetFooter | ( | DataFile | footer | ) |
The method sets a layout describing the "footer" to be recorded after the DiscLayout.WriteContent operation finishes.
footer | A DataFile layout containing the desired footer content |
Call this method before calling DiscLayout.Open
ObjectDisposedException | The DiscLayout object was previously disposed. |
bool WriteContent | ( | ) |
Writes the selected content on the target medium.
ObjectDisposedException | The DiscLayout object was previously disposed. |
bool WriteFileSystem | ( | ) |
Writes the file system describing the content of the disc
The file system is automatically determined based on the written content and footer as well as any previously loaded data (from previous recording sessions). This method must be called after the content and footer are written (DiscLayout.WriteContent and DiscLayout.WriteFooter), otherwise unwanted results may occur.
The media volume will not be automatically dismounted after the write operation finishes.
ObjectDisposedException | The DiscLayout object was previously disposed. |
bool WriteFileSystem | ( | bool | dismountVolume | ) |
Writes the file system describing the content of the disc
dismountVolume | Indicates whether to dismount the volume after the burning. The default value of this parameter is false. |
The file system is automatically determined based on the written content and footer as well as any previously loaded data (from previous recording sessions). This method must be called after the content and footer are written (DiscLayout.WriteContent and DiscLayout.WriteFooter), otherwise unwanted results may occur.
ObjectDisposedException | The DiscLayout object was previously disposed. |
bool WriteFooter | ( | ) |
Writes the selected footer on the target medium.
If no footer is selected for the current layout this method has no effect.
ObjectDisposedException | The DiscLayout object was previously disposed. |
|
get |
Gets the layout that will be written on the target medium.
ObjectDisposedException | The DiscLayout object was previously disposed. |
|
get |
Gets the description of the layout already present on the target medium before the current layout is written to it.
ObjectDisposedException | The DiscLayout object was previously disposed. |
|
get |
The error information for the last DiscLayout operation.
|
get |
Gets a DatFile object defining the content of the footer to be recorded after the layout content goes on disc
When a DiscLayout object is created using DiscArchive.PrepareLayout method, its footer is a copy of the footer defined originally for the DiscArchive object. It is still possible to define a different footer for each DiscLayout object, despite the fact that one may already be set in the source DiscArchive object.
ObjectDisposedException | The DiscLayout object was previously disposed. |
|
get |
Returns the number of blocks needed on the target medium to write the selected content and footer.
Use this property after calling DiscLayout.Open, otherwise it will return 0.
|
get |
Returns the available space in blocks on the target medium before calling any of the write methods.
Use this property after calling DiscLayout.Open, otherwise it will return 0.
|
getset |
Gets/sets the address at which content recording will begin on the target medium.
Modifying the value of this property (if necessary) should be done before calling DiscLayout.Open.
ObjectDisposedException | The DiscLayout object was previously disposed. |
|
getset |
Gets/sets the new volume label that will be set on the target medium when DiscLayout.WriteFileSystem method is called.
ObjectDisposedException | The DiscLayout object was previously disposed. |
EventHandler<DiscLayoutContinueWriteEventArgs> OnContinueWrite |
Raised to check if burning should continue.
The event handler receives an argument of type DiscLayout_ContinueWriteEventArgs containing data related to this event.
Note: The event gets fired for each file from the layout after it is recorded on the target medium. While a file is being recorded this event not will fire.
EventHandler<DiscLayoutFileEventArgs> OnFileComplete |
Raised when a specific file from the layout is written on the target medium.
EventHandler<DiscLayoutFileErrorEventArgs> OnFileError |
Raised when a specific file from the layout cannot be written on the target medium due to file access/read errors.
EventHandler<DiscLayoutProgressEventArgs> OnProgress |
Raised to report the number of blocks written to the target medium.
The event handler receives an argument of type DiscLayout_ProgressEventArgs containing data related to this event.