PrimoBurner 4 API Changes

Table of Contents

• Classes
  • AudioCD
    • Properties
    • Methods
    • Events
  • AudioCD_ProgressEventArgs
  • AudioCD_StatusEventArgs
  • AudioCD_TrackStatusEventArgs
  • AudioFile
    • Properties
  • AudioInput
    • Properties
  • AudioOutput
    • Properties
  • AudioStream
  • BlockDevice
    • Properties
    • Methods
  • DataDisc
    • Properties
    • Methods
    • Events
    • Error Handling
      • PrimoBurner 3
      • PrimoBurner 4
  • DataDisc_FileStatusEventArgs
  • DataDisc_ProgressEventArgs
  • DataDisc_StatusEventArgs
  • DataDisc_ContinueBurnEventHandler
    • PrimoBurner 3
    • PrimoBurner 4
  • DataDisc_FileStatusEventHandler
    • PrimoBurner 3
    • PrimoBurner 4
  • DataDisc_ProgressEventHandler
    • PrimoBurner 3
    • PrimoBurner 4
  • DataDisc_StatusEventHandler
    • PrimoBurner 3
    • PrimoBurner 4
  • DataFile
    • Methods
  • Device
    • Properties
    • Methods
    • Error Handling
      • PrimoBurner 3
      • PrimoBurner 4
  • DeviceEnumerator
    • Methods
  • Device_ContinueReadEventHandler
    • PrimoBurner 3
    • PrimoBurner 4
  • Device_EraseEventArgs
  • Device_EraseEventHandler
    • PrimoBurner 3
    • PrimoBurner 4
  • Device_FormatEventArgs
  • Device_FormatEventHandler
    • PrimoBurner 3
    • PrimoBurner 4
  • Device_ReadEventArgs
  • Device_ReadEventHandler
    • PrimoBurner 3
    • PrimoBurner 4
  • DiscCopy_ContinueCopyEventHandler
    • PrimoBurner 3
    • PrimoBurner 4
  • DiscCopy_ProgressEventArgs
  • DiscCopy_ProgressEventHandler
    • PrimoBurner 3
    • PrimoBurner 4
  • DiscCopy_StatusEventArgs
  • DiscCopy_StatusEventHandler
    • PrimoBurner 3
    • PrimoBurner 4
  • DiscCopy_TrackStatusEventArgs
  • DiscCopy_TrackStatusEventHandler
    • PrimoBurner 3
    • PrimoBurner 4
  • DiskInfo
    • Properties
  • Engine
    • Properties
    • Methods
  • Library
  • QSubchannel
  • QSubchannelPosition
  • SpeedEnumerator
  • TrackBuffer
  • TrackInfoEx
  • UdfExtentList
• Enums
  • AudioCDStatus
  • AudioSourceType
  • BootEmulation
  • CdTextType
  • DataDiscStatus
  • DataWriteAttribute
  • DiskStatus
  • ImageConstraint
  • ImageType
  • MediaProfile
  • MediumReady
  • UdfRevision

Classes

AudioCD

Properties

PrimoBurner 3	PrimoBurner 4
AudioFiles	AudioCD.AudioInputs
LastError	AudioCD.Error. See also ErrorInfo.
LastSystemError	AudioCD.Error. See also ErrorInfo.
Plugins	Removed.

Methods

PrimoBurner 3	PrimoBurner 4
GetErrorMessage	AudioCD.Error. See also ErrorInfo.

Events

PrimoBurner 3	PrimoBurner 4
OnContinueBurn	AudioCD.OnContinueWrite
OnProgress	AudioCD.OnWriteProgress
OnStatus	AudioCD.OnWriteStatus
OnTrackStatus	AudioCD.OnWriteTrack

AudioCD_ProgressEventArgs

Replaced by AudioCDProgressEventArgs

AudioCD_StatusEventArgs

Replaced by AudioCDStatusEventArgs

AudioCD_TrackStatusEventArgs

Replaced by AudioCDTrackStatusEventArgs

AudioFile

Removed. Use AudioInput instead.

Properties

PrimoBurner 3	PrimoBurner 4
AudioSource	AudioInput.Storage

AudioInput

Properties

PrimoBurner 3	PrimoBurner 4
AudioStream	AudioInput.Stream

AudioOutput

Properties

PrimoBurner 3	PrimoBurner 4
AudioStream	AudioOutput.Stream

AudioStream

Replaced by System.IO.Stream.

BlockDevice

Properties

PrimoBurner 3	PrimoBurner 4
LastError	BlockDevice.Error. See also ErrorInfo.
LastSystemError	BlockDevice.Error. See also ErrorInfo.

Methods

PrimoBurner 3	PrimoBurner 4
bool FinalizeDisc(DataFile fileSystemLayout, string volumeLabel, bool closeTrack, bool closeSession, bool closeDisc)	bool FinalizeDisc(DataFile fileSystemLayout, string volumeLabel, bool closeTrack, bool closeSession, bool closeDisc, bool dismount)
GetErrorMessage	BlockDevice.Error. See also ErrorInfo.
Write(byte[] data, Int32 dataLength, ref Int32 bytesWritten)	BlockDevice.Write(byte [] data, Int32 offset, Int32 dataLength)

DataDisc

Properties

PrimoBurner 3	PrimoBurner 4
AbstractFile	DataDisc.UdfVolumeProps.AbstractFile DataDisc.JolietVolumeProps.AbstractFile DataDisc.IsoVolumeProps.AbstractFile
AddVersionToIsoNames	DataDisc.IsoVolumeProps.VersionAppendedToNames
AddDotToIsoNames	DataDisc.IsoVolumeProps.DotAppendedToNames
AddVersionToJolietNames	DataDisc.JolietVolumeProps.VersionAppendedToNames
AddDotToJolietNames	DataDisc.JolietVolumeProps.DotAppendedToNames
Application	DataDisc.JolietVolumeProps.Application DataDisc.IsoVolumeProps.Application
BibliographicFile	DataDisc.JolietVolumeProps.BibliographicFile DataDisc.IsoVolumeProps.BibliographicFile
BootImageFile	DataDisc.BootProps.ImageFile
BootEmulation	DataDisc.BootProps.Emulation
BootPlatformID	DataDisc.BootProps.PlatformID
BootLoadSegment	DataDisc.BootProps.LoadSegment
BootSectorCount	DataDisc.BootProps.SectorCount
CacheSmallFiles	DataDisc.CachePolicy.CacheSmallFiles
CopyrightFile	DataDisc.UdfVolumeProps.CopyrightFile DataDisc.JolietVolumeProps.CopyrightFile DataDisc.IsoVolumeProps.CopyrightFile
DataPreparer	DataDisc.JolietVolumeProps.DataPreparer DataDisc.IsoVolumeProps.DataPreparer
LastError	DataDisc.Error. See also ErrorInfo.
LastSystemError	DataDisc.Error. See also ErrorInfo.
Publisher	DataDisc.JolietVolumeProps.Publisher DataDisc.IsoVolumeProps.Publisher
SmallFileCacheSize	DataDisc.CachePolicy.SmallFilesCacheSize
SmallFileThresholdSize	DataDisc.CachePolicy.SmallFileSizeThreshold
SystemID	DataDisc.JolietVolumeProps.SystemID DataDisc.IsoVolumeProps.SystemID
VolumeCreationTime	DataDisc.UdfVolumeProps.CreationTime DataDisc.JolietVolumeProps.CreationTime DataDisc.IsoVolumeProps.CreationTime
VolumeLabel	DataDisc.UdfVolumeProps.VolumeLabel DataDisc.JolietVolumeProps.VolumeLabel DataDisc.IsoVolumeProps.VolumeLabel
VolumeSetLabel	DataDisc.UdfVolumeProps.VolumeSet DataDisc.JolietVolumeProps.VolumeSet DataDisc.IsoVolumeProps.VolumeSet
WriteAttributes	DataDisc.WriteStrategy

Methods

PrimoBurner 3	PrimoBurner 4
GetErrorMessage	DataDisc.Error. See also ErrorInfo.
WriteImageToDiscEx(DataStream image, object context, bool dismountVolume)	DataDisc.WriteImageToDisc(System.IO.Stream image, bool dismountVolume)
WriteImageToDiscEx(DataStream image, object context)	DataDisc.WriteImageToDisc(System.IO.Stream image)

Events

PrimoBurner 3	PrimoBurner 4
EventHandler<EventArgs> OnContinueBurn	EventHandler<DataDiscContinueEventArgs> OnContinueBurn

Error Handling

PrimoBurner 3

string CreateErrorMessage(int systemError)
{
        return new System.ComponentModel.Win32Exception(systemError).Message;
}
 
string CreateErrorMessage(Device device)
{
        string message = string.Empty;
        if (null != device)
        {
                switch (device.LastError)
                {
                        case (int)DeviceError.SystemError:
                                message = CreateErrorMessage(device.LastSystemError);
                                break;
                        default:
                                message = string.Format("Device error detected:{0}\t0x{1:x8}{0}\t{2}", System.Environment.NewLine, device.LastError, device.GetErrorMessage(device.LastError));
                                break;
                }
        }
 
        return message;
}
 
string CreateErrorMessage(DataDisc dataDisc, Device device)
{
        string message = string.Empty;
        if (null != dataDisc)
        {
                switch (dataDisc.LastError)
                {
            case DataDiscError.SystemError:
                message = CreateErrorMessage(dataDisc.LastSystemError);
                break;
            case DataDiscError.DeviceError:
                                message = CreateErrorMessage(device);
                                break;
                        default:
                                message = string.Format("DataDisc error detected:{0}\t0x{1:x8}{0}\t{2}", System.Environment.NewLine, (int)dataDisc.LastError, dataDisc.GetErrorMessage(dataDisc.LastError));
                                break;
                }
        }
 
        return message;
}

PrimoBurner 4

string CreateErrorMessage(int systemError)
{
        return new System.ComponentModel.Win32Exception(systemError).Message;
}
 
string CreateErrorMessage(Device device)
{
        string message = string.Empty;
        if (null != device)
        {
        ErrorInfo error = device.Error;
                switch (error.Facility)
                {
                        case ErrorFacility.SystemWindows:
                                message = CreateErrorMessage(error.Code);
                                break;
                        default:
                                message = string.Format("Device error detected:{0}\t0x{1:x8}{0}\t{2}", System.Environment.NewLine, error.Code, error.Message);
                                break;
                }
        }
 
        return message;
}
 
string CreateErrorMessage(DataDisc dataDisc, Device device)
{
        string message = string.Empty;
        if (null != dataDisc)
        {
        ErrorInfo error = dataDisc.Error;
        switch (error.Facility)
        {
            case ErrorFacility.SystemWindows:
                message = CreateErrorMessage(error.Code);
                break;
            case ErrorFacility.Device:
                                message = CreateErrorMessage(device);
                                break;
                        default:
                                message = string.Format("DataDisc error detected:{0}\t0x{1:x8}{0}\t{2}", System.Environment.NewLine, error.Code, error.Message);
                                break;
                }
        }
 
        return message;
}

DataDisc_FileStatusEventArgs

Replaced by DataDiscFileStatusEventArgs

DataDisc_ProgressEventArgs

Replaced by DataDiscProgressEventArgs

DataDisc_StatusEventArgs

Replaced by DataDiscStatusEventArgs

DataDisc_ContinueBurnEventHandler

Removed.

PrimoBurner 3

dataDisc.OnContinueBurn += new DataDisc_ContinueBurnEventHandler(OnContinueBurn);

PrimoBurner 4

dataDisc.OnContinueBurn += OnContinueBurn;

DataDisc_FileStatusEventHandler

Removed.

PrimoBurner 3

dataDisc.OnFileStatus += new DataDisc_FileStatusEventHandler(OnFileStatus);

PrimoBurner 4

dataDisc.OnFileStatus += OnFileStatus;

DataDisc_ProgressEventHandler

Removed.

PrimoBurner 3

dataDisc.OnProgress += new DataDisc_ProgressEventHandler(OnProgress);

PrimoBurner 4

dataDisc.OnProgress += OnProgress;

DataDisc_StatusEventHandler

Removed.

PrimoBurner 3

dataDisc.OnStatus += new DataDisc_StatusEventHandler(OnStatus);

PrimoBurner 4

dataDisc.OnStatus += OnStatus;

DataFile

Methods

PrimoBurner 3	PrimoBurner 4
Dispose	Removed. DataFile no longer implements IDisposable.
SetHiddenAttribute	DataFile.HiddenMask

Device

Properties

PrimoBurner 3	PrimoBurner 4
CDTextSupport	Device.CDFeatures.CanReadCDText
MediumReady	Device.MediaState
ReWritePossible	Combination of: Device.CDFeatures.CanWriteCDRW Device.DVDFeatures.CanWriteDVDMinusRW Device.DVDFeatures.CanWriteDVDPlusRW Device.DVDFeatures.CanWriteDVDRam Device.BDFeatures.CanWriteBDRE
SaoPossible	Device.CDFeatures.CanWriteSao
TaoPossible	Device.CDFeatures.CanWriteTao
WritePossible	Combination of: Device.CDFeatures.CanWriteCDR Device.CDFeatures.CanWriteCDRW Device.DVDFeatures.CanWriteDVDMinusR Device.DVDFeatures.CanWriteDVDMinusRDL Device.DVDFeatures.CanWriteDVDMinusRW Device.DVDFeatures.CanWriteDVDPlusR Device.DVDFeatures.CanWriteDVDPlusRDL Device.DVDFeatures.CanWriteDVDPlusRW Device.DVDFeatures.CanWriteDVDRam Device.BDFeatures.CanWriteBDR Device.BDFeatures.CanWriteBDRE

Methods

PrimoBurner 3	PrimoBurner 4
CreateTrackBuffer	TrackBuffer constructor
DestroyTrackBuffer	Removed.
LockMedium	LockMedia(bool lockMedia)
ReadDiskInfo	DiscInfo ReadDiscInfo()
ReadToc	Toc ReadToc()
ReadTocEx	Toc ReadTocFromSession(byte sessionNumber)
ReadTrackInfoEx	TrackInfoEx ReadTrackInfoEx(int trackNumber)
SpeedEnumerator GetWriteSpeeds()	IList<SpeedDescriptor> GetWriteSpeeds()

Error Handling

PrimoBurner 3

string CreateErrorMessage(int systemError)
{
        return new System.ComponentModel.Win32Exception(systemError).Message;
}
 
string CreateErrorMessage(Device device)
{
        string message = string.Empty;
        if (null != device)
        {
                switch (device.LastError)
                {
                        case (int)DeviceError.SystemError:
                                message = CreateErrorMessage(device.LastSystemError);
                                break;
                        default:
                                message = string.Format("Device error detected:{0}\t0x{1:x8}{0}\t{2}", System.Environment.NewLine, device.LastError, device.GetErrorMessage(device.LastError));
                                break;
                }
        }
 
        return message;
}

PrimoBurner 4

string CreateErrorMessage(int systemError)
{
        return new System.ComponentModel.Win32Exception(systemError).Message;
}
 
string CreateErrorMessage(Device device)
{
        string message = string.Empty;
        if (null != device)
        {
        ErrorInfo error = device.Error;
                switch (error.Facility)
                {
                        case ErrorFacility.SystemWindows:
                                message = CreateErrorMessage(error.Code);
                                break;
                        default:
                                message = string.Format("Device error detected:{0}\t0x{1:x8}{0}\t{2}", System.Environment.NewLine, error.Code, error.Message);
                                break;
                }
        }
 
        return message;
}

DeviceEnumerator

Methods

PrimoBurner 3	PrimoBurner 4
GetItem(int index)	DeviceEnumerator.CreateDevice(int index)
GetItem(int index, bool exclusiveAccess)	DeviceEnumerator.CreateDevice(int index, bool exclusiveAccess)

Device_ContinueReadEventHandler

Removed.

PrimoBurner 3

device.OnContinueRead += new Device_ContinueReadEventHandler(OnContinueRead);

PrimoBurner 4

device.OnContinueRead += OnContinueRead;

Device_EraseEventArgs

Replaced by DeviceEraseEventArgs

Device_EraseEventHandler

Removed.

PrimoBurner 3

device.OnErase += new Device_EraseEventHandler(Device_Erase);
// erase
dev.OnErase -= new Device_EraseEventHandler(Device_Erase);

PrimoBurner 4

dev.OnErase += Device_Erase;
// erase
dev.OnErase -= Device_Erase;

Device_FormatEventArgs

Replaced by DeviceFormatEventArgs

Device_FormatEventHandler

Removed.

PrimoBurner 3

device.OnFormat += new Device_FormatEventHandler(Device_Format);
// format
dev.OnFormat -= new Device_FormatEventHandler(Device_Format);

PrimoBurner 4

dev.OnFormat += Device_Format;
// format
dev.OnFormat -= Device_Format;

Device_ReadEventArgs

Replaced by DeviceReadEventArgs

Device_ReadEventHandler

Removed.

PrimoBurner 3

device.OnRead += new Device_ReadEventHandler(OnRead);

PrimoBurner 4

device.OnRead += OnRead;

DiscCopy_ContinueCopyEventHandler

Removed.

PrimoBurner 3

// Add event handlers
discCopy.OnContinueCopy += new DiscCopy_ContinueCopyEventHandler(DiscCopy_OnContinueCopy);

PrimoBurner 4

// Add event handlers
discCopy.OnContinueCopy += DiscCopy_OnContinueCopy;

DiscCopy_ProgressEventArgs

Replaced by DiscCopyProgressEventArgs

DiscCopy_ProgressEventHandler

Removed.

PrimoBurner 3

discCopy.OnProgress += new DiscCopy_ProgressEventHandler(DiscCopy_OnProgress);

PrimoBurner 4

discCopy.OnProgress += DiscCopy_OnProgress;

DiscCopy_StatusEventArgs

Replaced by DiscCopyStatusEventArgs

DiscCopy_StatusEventHandler

Removed.

PrimoBurner 3

discCopy.OnStatus += new DiscCopy_StatusEventHandler(DiscCopy_OnStatus);

PrimoBurner 4

discCopy.OnStatus += DiscCopy_OnStatus;

DiscCopy_TrackStatusEventArgs

Replaced by DiscCopyTrackStatusEventArgs

DiscCopy_TrackStatusEventHandler

Removed.

PrimoBurner 3

discCopy.OnTrackStatus += new DiscCopy_TrackStatusEventHandler(DiscCopy_OnTrackStatus);

PrimoBurner 4

discCopy.OnTrackStatus += DiscCopy_OnTrackStatus;

DiskInfo

Replaced by DiscInfo

Properties

PrimoBurner 3	PrimoBurner 4
StatusOfDisk	DiscInfo.DiscStatus
StateOfSession	DiscInfo.SessionState

Engine

Properties

PrimoBurner 3	PrimoBurner 4
LastError	Engine.Error. See also ErrorInfo.
LastSystemError	Engine.Error. See also ErrorInfo.

Methods

PrimoBurner 3	PrimoBurner 4
GetDevices	Engine.CreateDeviceEnumerator
GetErrorMessage	Engine.Error. See also ErrorInfo.

Library

PrimoBurner 3	PrimoBurner 4
CreateAudioCD	AudioCD constructor
CreateAudioFile	AudioInput constructor
CreateAudioInput	AudioInput constructor
CreateAudioOutput	AudioOutput constructor
CreateBlockDevice	BlockDevice constructor
CreateCDSector	Removed. CDSector is a static class.
CreateCDText	CDText constructor
CreateDataFile	DataFile constructor
CreateDataDisc	DataDisc constructor
CreateDiscCopy	DiscCopy constructor
CreateEngine	Engine constructor
CreateUdfExtent	UdfExtent constructor

QSubchannel

Renamed to QSubChannel.

QSubchannelPosition

Replaced by QSubChannelPosition.

PrimoBurner 3	PrimoBurner 4
AbsoluteCDAddress	QSubChannelPosition.AbsoluteMinutes QSubChannelPosition.AbsoluteSeconds QSubChannelPosition.AbsoluteFrames
TrackRelativeAddress	QSubChannelPosition.TrackMinutes QSubChannelPosition.TrackSeconds QSubChannelPosition.TrackFrames

SpeedEnumerator

PrimoBurner 3	PrimoBurner 4
SpeedEnumerator class	IList<SpeedDescriptor> and the Device.GetWriteSpeeds method

TrackBuffer

PrimoBurner 3	PrimoBurner 4
FrameSize	TrackBuffer.BlockSize
NumFrames	TrackBuffer.Blocks
StartFrame	Removed.
DataLength	Removed. Same as: Blocks * BlockSize

TrackInfoEx

PrimoBurner 3	PrimoBurner 4
Packet	TrackInfoEx.IsPacket

UdfExtentList

Replaced by IList<UdfExtent>.

Enums

AudioCDStatus

PrimoBurner 3	PrimoBurner 4
AudioCDStatus.InitializingAudioDecoder	Removed.
AudioCDStatus.IntializingDevice	Corrected typo to AudioCDStatus.InitializingDevice

AudioSourceType

Replaced by AudioStorageType

BootEmulation

PrimoBurner 3	PrimoBurner 4
BootEmulation.Diskette120M	BootEmulation.Diskette120
BootEmulation.Diskette144M	BootEmulation.Diskette144
BootEmulation.Diskette288M	BootEmulation.Diskette288

CdTextType

PrimoBurner 3	PrimoBurner 4
CdTextType.Title	CDTextItem.Title
CdTextType.Performer	CDTextItem.Performer
CdTextType.Songwriter	CDTextItem.Songwriter
CdTextType.Composer	CDTextItem.Composer
CdTextType.Arranger	CDTextItem.Arranger
CdTextType.Message	CDTextItem.Message
CdTextType.DiskId	CDTextItem.DiskId
CdTextType.Genre	CDTextItem.Genre
CdTextType.GenreText	CDTextItem.GenreText
CdTextType.UpcIsrc	CDTextItem.UpcIsrc

DataDiscStatus

PrimoBurner 3	PrimoBurner 4
DataDiscStatus.CachingCdromFiles	DataDiscStatus.CachingCDRomFiles

DataWriteAttribute

Replaced by DataWriteStrategy

PrimoBurner 3	PrimoBurner 4
DataWriteAttribute.ReservePathTableTrack	DataWriteStrategy.ReserveFileTableTrack
DataWriteAttribute.WritePathTableTrack	DataWriteStrategy.WriteFileTableTrack

DiskStatus

Replaced by DiscStatus

ImageConstraint

Replaced by ImageConstraints

ImageType

PrimoBurner 3	PrimoBurner 4
ImageType.ISO9660	ImageType.Iso9660
ImageType.UDF	ImageType.Udf
ImageType.UDF_ISO	ImageType.UdfIso
ImageType.UDF_Joliet	ImageType.UdfJoliet
ImageType.Unknown	ImageType.None

MediaProfile

PrimoBurner 3	PrimoBurner 4
MediaProfile.DvdRamRw	MediaProfile.DvdRam

MediumReady

Replaced by MediaReady

PrimoBurner 3	PrimoBurner 4
MediumReady.MediumPresent	MediaReady.Present
MediumReady.MediumNotPresent	MediaReady.NotPresent

UdfRevision

PrimoBurner 3	PrimoBurner 4
UdfRevision.Rev102	UdfRevision.Revision102
UdfRevision.Rev201	UdfRevision.Revision201
UdfRevision.Rev250	UdfRevision.Revision250