Ptburn sdk

7Appendix B: Deployment Details

Primera includes an installer that can be used to install the PTBurn server and the PxEngine. Simply launch the file SETUP.EXE in the PTBurn directory and complete the installation. Note that there are two separate setup folders – one for Unicode (2-byte fonts) and one MBCS (1-byte fonts) – choose the one appropriate for your application. Each vendor can perform some customization by editing the loose file PTSETUP.INI before deployment. See the PTSETUP.INI file in the PTBurn directory for customization choices in the file.
NOTE: If you require PTBurnService to install quietly you can run the PTBurnServiceInstall.msi file with the following command line:

msiexec /i PTBurnServiceInstall.msi /quiet

After installation, you should have the user reboot the computer. If you want to force a reboot use ‘REBOOT=Force’ in the command line like this:

msiexec /i PTBurnServiceInstall.msi REBOOT=Force

8Appendix C: Job, System and Burn Engine Error Codes

System Errors

System errors are defined in the table below. These are errors that occur that require administrator attention. PTBurn provides these error numbers and messages in the the Status file (See section IV of this document) with key values of SysErrorNumber and SysErrorString. You may choose to use/display the error string provided, or develop your own, for each respective error number.

The following listing contains suggested alternative error strings that may provide the user with more information. This list contains only those errors that have a possible recover action apart from restarting the unit and server software. In the case of a user trying to clear the error (by the method suggested in the strings below), your software can find out if the retry was successful by seeing if the SysErrorNumber changes back to 0.

System Error 1

“Tray movement error. Press the Cartridge button (left button) on the unit to try again.”

System Error 2

“There was a problem finding the ink cartridges. Open the cover and press the Cartridge button (left button). Make sure the color cartridge is installed on the left and the black is on the right. Then close the lid.”

System Error 3

“The input bin is empty. Add more discs and push the Cartridge button (left button) on the unit.”

System Error 4

“There was an internal printer communications error. Press the Cartridge button (left button) on the unit to try again.”

System Error 5

“WARNING: The COLOR cartridge (left side) is LOW on ink. To replace the cartridge, open the cover on the unit and press the Cartridge button (left button), install the new cartridge, and close the cover. To ignore the warning press the Cartridge button (left button).”

System Error 6

“WARNING: The BLACK cartridge (right side) is LOW on ink. To replace the cartridge, open the cover on the unit and press the Cartridge button (left button), install the new cartridge, and close the cover. To ignore the warning press the Cartridge button (left button).”

System Error 7

“WARNING: BOTH cartridges are LOW on ink. To replace the cartridge, open the cover on the unit and press the Cartridge button (left button)., install the new cartridges, and close the cover. To ignore the warning press the Cartridge button (left button).”

System Error 8

“The disc was not picked. Push the Cartridge button (left button) on the unit to try again.”

System Error 9

“There was an arm movement error. Press the Cartridge button (left button) on the unit to try again.”

Note: This error is specific to Disc Publisher I, and not Disc Publisher II.
System Error 10

“Arm picker error (unable to home the picker or unable to hook up the picker). Press the Cartridge button (left button) on the unit to try again.”

System Error 11

“The current user does not have local administrator rights. Please login with local administrator rights and re-start the software.”

System Error 12

“There was an internal software error. Please re-start the software.”

System Error 13

“No external recorder drives were found. Please unplug all cables from the Disc Publisher (including power). Then plug all cables back into the Disc Publisher, re-boot the computer, and then re-start the software.”

Note: This error will occur only at the start of the software.
System Error 14

“The Disc Publisher is offline. Please ensure the unit is connected and powered on, and then shutdown and restart the software.”

Note: In order to consistently recover from the unit going offline the cause must be determined and corrected, and the software restarted.
System Error 15

“The Disc Publisher cover is open. Please close the cover.”

System Error 16

“The disc was not picked from the printer. Please manually remove the

disc from the printer. Then close the cover and press the power button (right

button) several times to reset the printer.”

System Error 17

“Multiple discs were picked up and moved. Please manually remove any extra

discs that were moved, keeping a single disc in place. Then close the cover and

press the left button.”

System Error 18

“The disc was dropped while moving into the Recorder. Please manually place

the disc into the Recorder tray. Then close the cover and press the left button.”
System Error 19

“The disc was dropped while moving into the Printer. Please manually place

the disc into the Printer tray. Then close the cover and press the left button.”
System Error 20

“The disc was dropped while moving into the Left Bin. Please manually place

the disc into the Left Bin. Then close the cover and press the left button.”
System Error 21

“The disc was dropped while moving to the Reject area (Front Slide). Please

remove the dropped disc from the printer. Then close the cover and press the left

button.”
System Error 22

** Not used in Disc Publisher II **

“The printer needs to be aligned. Would you like to align the printer now? Click “Yes” to align the printer, or “No” to quit the application.

System Error 23

** Not used in Disc Publisher II **

“The color cartridge is invalid. To change the cartridge open the cover, press the “Cartridge” button, change the cartridge, close the cover and press “Ok” to continue.

System Error 24

** Not used in Disc Publisher SE **

“The black cartridge is invalid. To change the cartridge open the cover, press the “Cartridge” button, change the cartridge, close the cover and press “Ok” to continue.

System Error 25

** Not used in Disc Publisher SE **

“Both cartridges are invalid. To change the cartridges open the cover, press the “Cartridge” button, change the cartridge, close the cover and press “Ok” to continue.

System Error 26

** Not used in Disc Publisher II **

“No cartridges are installed. To install cartridges open the cover, press the “Cartridge” button, change the cartridge, close the cover and press “Ok” to continue.

System Error 27

** Only used on the DiscPublisher PRO/XRP **

“The black cartridge is in the color cartridge holder. To change the cartridges open the cover, press the “Cartridge” button, change the cartridge, close the cover and press “Ok” to continue.

System Error 28

** Only used on the DiscPublisher PRO/XRP **

“The color cartridge is in the black cartridge holder. To change the cartridges open the cover, press the “Cartridge” button, change the cartridge, close the cover and press “Ok” to continue.

System Error 29

** Only used on the DiscPublisher PRO/XRP **

“The cartridges are swapped (color in black and black in color holders). To change the cartridges open the cover, press the “Cartridge” button, change the cartridge, close the cover, and press “Ok” to continue.

System Error 30

** Only used on the DiscPublisher PRO/XRP **

“This printer is not compatible with a pigment based cartridge. To change the cartridges open the cover, press the “Cartridge” button, change the cartridge, close the cover, and press “Ok” to continue.

System Error 31

** Not used in Disc Publisher II **

“The alignment print failed. Would you like to retry the alignment now? Click “Yes” to align the printer, or “No” to quit the application.

System Error 32

** Not used in the SDK **

System Error 33

** Not used in the SDK **
System Error 34

** Not used in the SDK **
System Error 35

“WARNING: The color cartridge is Empty. To replace the cartridge, open the cover on the unit and press the left button. Then install the new cartridge and close the cover. To ignore the warning, press the left button.”

System Error 36

“WARNING: The black cartridge is Empty. To replace the cartridge, open the cover on the unit and press the left button. Then install the new cartridge and close the cover. To ignore the warning, press the left button.”

System Error 37

“WARNING: Both cartridges are Empty. To replace the cartridge, open the cover on the unit and press the left button. Then install the new cartridge and close the cover. To ignore the warning, press the left button.”

System Error 38

“The system timed out waiting for the printer to finish. The disc may not have been printed.”

System Error 39

“The disc was dropped.”

System Error 40

“The disc to be printed is missing from the printer tray. Please place the disc back into the printer tray and close the tray. NOTE: You can open/close the printer tray by pressing the left button with the cover closed.”

System Error 41

** Not used in the SDK **
System Error 42

“The robot is not responding.”

Job/Disc Errors

Job/Disc errors are defined in the table below. These are errors that either cause a job to fail, or cause a disc within a job to fail. A job error means the job did not complete successfully, whereas disc errors within a job will not cause the job to fail unless too many rejected discs in a row are encountered. PTBurn provides these error numbers and messages in each job’s “Job Details” section of the Status file (See section IV of this document) with key values of JobErrorNumber and JobErrorString for job errors, and DiscErrorNumberX and DiscErrorStringX for disc errors (where X is an integer from 0 to 9). You may choose to use/display the error string provided, or develop your own, for each respective error.

Job/Disc Error Descriptions
Job/Disc Error 1

This error indicates a problem with the recording engine module. This error will cause the job to fail.

Job/Disc Error 2

This error indicates a problem with the JobProcessor.dll module. This error will cause the job to fail.

Job/Disc Error 3

This error indicates a problem with the PxRobo.dll module. This error will cause the job to fail.

Job/Disc Error 4

This error will occur when an invalid burn file/s is specified. An invalid file error can be caused by missing files, corrupt files, or files that are not in the correct format for the job requested. This error will cause the job to fail.

Job/Disc Error 5

The maximum files/folders that can be burned is 99. However, files that are contained within a folder that is specified do not count towards the maximum. This error will cause the job to fail.

Job/Disc Error 6

The error will occur when there is no data files/folder in a job. This error will cause the job to fail.

Job/Disc Error 7

This error will occur when an invalid print file is specified. An invalid print file could be a file that is not one of the following types: .std, .bmp, .jpg, or .prn. This can also occur with a .prn file that was not created for the printer being used. This error will cause the job to fail.

Job/Disc Error 8

This error will occur when an invalid Job Request File is specified. This could be the result of a missing or locked file. This error will cause the job to fail.

Job/Disc Error 9

This error will not occur in the SDK version of PTBurn.

Job/Disc Error 10

This error will occur when attempting to burn to invalid media. This could be the result of a flipped disc or an unreadable disc. This error will cause the disc to fail.

Job/Disc Error 11

This error will occur when attempting to burn more data than is available on the recordable media. This error will cause the disc to fail.

Job/Disc Error 12

This error will occur when attempting to burn data to a disc that is not blank and the key RejectIfNotBlank (in the jrq file) is set to YES. This error will cause the disc to fail.

Job/Disc Error 13

This error will occur when the drive fails to respond to open/close commands. This error will cause the job to fail.

Job/Disc Error 14

This error will occur when a drive fails to become ready after the disc has been inserted. This is usually the result of poor/unreadable media (making it similar to Job/Disc Error 10). This error will cause the disc to fail.

Job/Disc Error 15

This error will occur when the drive that is being used for a job is not the drive in the Disc Publisher. This error can occur when the Disc Publisher drive is not seen by the server, and there is another external recorder on the system. This error will cause the job to fail.

Job/Disc Error 16

This error will occur if the job is aborted by the user.

Job/Disc Error 17

This error will occur when the VIDEO_TS or AUDIO_TS structures do not respect the DVD-Video or DVD-Audio rules. This error will cause the job to fail.

Job/Disc Error 18

This error will occur when the engine reports an error recording the disc. This error will also be accompanied by Sector, Sense, ASC, and ASCQ values. This error will cause the disc to fail.

Job/Disc Error 19

This error will occur when the engine reports an error verifying the disc. This error will also be accompanied by Sector, Sense, ASC, and ASCQ values. This error will cause the disc to fail.

Job/Disc Error 20

This error will occur when the maximum allowable reject limit has been reached. This error will cause the job to fail.

Job/Disc Error 21

This error will occur when the session of a multisession disc is invalid. This error will cause the job to fail.

Job/Disc Error 22

This error will not occur in the SDK version of PTBurn.

Job/Disc Error 23

This error will occur if there is an error processing a client message. This error will cause the job to fail.

Job/Disc Error 24

This error will occur if an unknown job type is specified in the .jrq file. This error will cause the job to fail.

Job/Disc Error 25

This error will occur if a critical key in the jrq file is invalid. This error will cause the job to fail.

Job/Disc Error 26

This error will occur if the temporary storage area for the application runs out of space. This error will cause the job to fail.

Job/Disc Error 27

This error will occur if the CD Text is in an invalid format or exceeds the maximum CD Text length (6000 bytes). This error will cause the job to fail.

Job/Disc Error 28

This error will occur if the CD printing application is not installed and the job requires the printing application. This error will cause the job to fail.

Job/Disc Error 29

This error will occur if the print file specified in the jrq file does not exist. This error will cause the job to fail.

Job/Disc Error 30

This error will occur if an improper ink cartridge is installed for the print file you are attempting to print (e.g. only the Black cartridge is installed but you are attempting to print with Color).

Job/Disc Error 31

This error will occur if the location the you specify to read the data to in a read job does not have sufficient space for the data. This error will cause the disc to fail.

Job/Disc Error 32

This error will occur when the engine reports an error reading the disc. This error will also be accompanied by Sector, Sense, ASC, and ASCQ values. This error will cause the disc to fail.

Job/Disc Error 33

This error will occur if a PVD field is invalid. This is usually the result of a field being too large. This error will cause the job to fail.

Job/Disc Error 34

This error will occur if PVD fields are specified for any jobs except Data Disc Jobs. This error will cause the job to fail.

Job/Disc Error 35

This error will occur if the disc image cannot be created. This error will cause the job to fail.

Job/Disc Error 36

This error will occur if status cannot be obtained from the unit.

Job/Disc Error 37

This error will occur if a robot action is requested, but the robot does not support the action.

Job/Disc Error 38

This error will occur if an incorrect Job ID is specified. This error will cause the job to fail.

Job/Disc Error 39

This error will occur if a merge field string is too long (>260 characters). This error will cause the job to fail.

Job/Disc Error 40

This error will occur if there is a fatal problem that happens during printing.

Burn Engine Errors

Errors from the burn engine are also recorded in the Log file. These errors are differentiated from Job and System errors by their surrounding syntax. For example “Error 33 returned from PrimoSDK_RunningStatus”

PRIMOSDK_OK	0	The operation completed successfully.
PRIMOSDK_CMDSEQUENCE	1	The function was used in the incorrect sequence. Another PrimoSDK API is required before calling this function.
PRIMOSDK_NOASPI	2	The ASPI layer is not loading or is in error.
PRIMOSDK_INTERR	3	An internal error occured.
PRIMOSDK_BADPARAM	4	The function was passed an invalid parameter.
PRIMOSDK_ALREADYEXIST	6	The function was passed a pointer to a directory element that already exists in the target data structure.
PRIMOSDK_NOTREADABLE	7	The function was passed a pointer to source file that either cannot be found or is not readable.
PRIMOSDK_NOSPACE	8	Completion of the operation would result in too many files for the system memory.
PRIMOSDK_INVALIDMEDIUM	9	The function was passed a pointer to a target unit containing media that is not blank.
PRIMOSDK_RUNNING	10	The operation whose status is being queried is currently running.
PRIMOSDK_BUR	11	The unit whose status is being queried went into buffer underrun.
PRIMOSDK_SCSIERROR	12	The unit whose status is being queried experienced a communication error.
PRIMOSDK_UNITERROR	13	The SCSI command sent by the function returned a check condition.
PRIMOSDK_NOTREADY	14	The function was passed a pointer to a unit that is not ready.
PRIMOSDK_INVALIDSOURCE	16	The function was passed a pointer to a disc or file that is not valid.
PRIMOSDK_INCOMPATIBLE	17	The function was passed a pointer to an image from a type of disc that is not compatible with the capabilities of the recorder.
PRIMOSDK_FILEERROR	18	The function was passed a pointer to a file that cannot be found.
PRIMOSDK_ITSADEMO	23	The operation requested by the function would exceed the limits allowed by the Demo version of PrimoSDK.
PRIMOSDK_USERABORT	24	The operation whose status is being queried was aborted because of a call with the PRIMOSDK_ABORT flag.
PRIMOSDK_BADHANDLE	25	The function was passed an invalid PrimoSDK handle.
PRIMOSDK_BADUNIT	26	The function was passed a pointer to a unit that does not exist.
PRIMOSDK_ERRORLOADING	27	An error occurred while reading the directory of the specified session/border.
PRIMOSDK_NOAINCONTROL	29	AIN control cannot be activated, typically because PrimoSDK is running under WinASPI instead of PxHelper.
PRIMOSDK_READERROR	30	The unit whose status is being queried reported a reading error.
PRIMOSDK_WRITEERROR	31	The unit whose status is being queried reported a writing error.
PRIMOSDK_TMPOVERFLOW	32	A temporary file went into overflow.
PRIMOSDK_DVDSTRUCTERROR	33	A data structure includes a VIDEO_TS or AUDIO_TS folder that is not compliant with DVD-Video or DVD-Audio rules.
PRIMOSDK_FILETOOLARGE	34	The function was passed a pointer to a file that is bigger than 9.99 GB for UDF or 4 GB for ISO.
PRIMOSDK_CACHEFULL	35	Not currently used.
PRIMOSDK_FEATURE_NOT_SUPPORTED	36	The device does not support the requested feature.
PRIMOSDK_FEATURE_DISABLED	37	Use of the requested feature is not included in the license under which the SDK was provided.
PRIMOSDK_CALLBACK_ERROR	38	Returned from the caller's callback function to terminate stream.
PRIMOSDK_PROTECTEDWMA	39	Returned if application does not have permission to burn specified WMA file.