background image

PTBurn SDK 

 

                                                       Page 22 of 53 

© 2005, Primera Technology, Inc.  Primera is a registered trademark and Bravo is a trademark of Primera Technology, Inc.  All other trademarks 
are the property of their respective companies. 

 

3.3.19 

LoadDiscDriveX 

This is the drive that is processing the disc 

3.4 System Section 

3.4.1 

SystemDesc 

String that describes the system (e.g. Disc Publisher DVDR) 

3.4.2 

SystemStatus 

String that gives general system status of the software and robotics (e.g. Offline, System OK, 
Out of Discs, Ink Low, …).   
If the PTBurn software application is not running then this value will always be set to  “Offline”.   
If this key is anything except “Offline” then the software is running. 
 
If the software is running but the printer is offline (user pressed the power button) then the 
SystemStatus will be “Printer Offline”.  For this error, and other system errors, the 
SysErrorNumber key can be queried.   See more information for SysErrorNumber below. 

3.4.3 

SystemDrives 

Integer value that tells how many drives are managed by the robotics.  (for the Disc Publisher 
this will be 1). 

3.4.4 

GoodDiscsLife 

Integer value that tells how many discs have been successfully completed in the life of this 
system (value is stored on the computer – not within the robotics). 

3.4.5 

BadDiscsLife 

Integer value that tells how many discs have been rejected because of failure during the life of 
this system (value is stored on the computer – not within the robotics). 

3.4.6 

GoodDiscsLaunch 

Integer value that tells how many discs have been successfully completed since the PTBurn 
application was launched. 
 

3.4.7 

BadDiscsLaunch 

Integer value that tells how many discs have been rejected because of failure since the PTBurn 
application was launched. 

3.4.8 

ServerTime 

Current time obtained by the PTBurn application on the server (computer on which PTBurn is 
running). 
 
Format is:   
MM/DD/YYYY hh:mm:ss  XX 
where XX is either AM or PM. 

Summary of Contents for PTBurn SDK

Page 1: ...PTBurn SDK Network capable text based shared folder burning Printing Primera Technology Inc...

Page 2: ...2 of 53 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies May 4 2006...

Page 3: ...lank 11 2 1 18 NotifyClient 11 2 1 19 CDTextDiscTitle 12 2 1 20 CDTextDiscPerformer 12 2 1 21 CDTextDiscComposer 12 2 1 22 CDTextTrackTitle 12 2 1 23 CDTextTrackPerformer 12 2 1 24 CDTextTrackComposer...

Page 4: ...3 3 9 TimeCreated 20 3 3 10 TimeStarted 20 3 3 11 TimeCompleted 20 3 3 12 JobState 20 3 3 13 JobErrorNumber 20 3 3 14 JobErrorString 20 3 3 15 DiscErrorIndexX 20 3 3 16 DiscErrorNumberX 21 3 3 17 Dis...

Page 5: ...ingErrors 26 3 5 4 ReadingErrorsMedia 26 3 5 5 RecordingErrors 26 3 5 6 RecordingErrorsMedia 26 3 5 7 VerifyingErrors 26 3 5 8 VerifyingErrorsMedia 26 3 5 9 DriveNotReady 26 3 6 Example of PTStatus tx...

Page 6: ...Publisher XR and Disc PublisherXRP The client application creates an ASCII text file Job Request File in the Job Request Folder shared hot folder The Job Request File specifies the image data to burn...

Page 7: ...g he wants to use If this key is not provided then the ClientID will default to Unknown 2 1 3 Importance This tells PTBurn how important the job is Possible values are 0 to 9 where 0 is most important...

Page 8: ...9 total if Data and ImageFile statements used also Acceptable audio filename types include WAV MP3 and WMA PregapX audio silence values are in sectors so 75 sectors 1 second 150 sectors 2 seconds and...

Page 9: ...with Data or AudioFile keys with the same session value 2 1 8 DeleteFiles This specifies if the files folders image for this particular job should be deleted after the job is completed Possible values...

Page 10: ...system Possible values of Option1 Option2 are the following SETNOW this will cause all files to be set to the time date at which the disc is created If this option is not given then the file s time da...

Page 11: ...ested recorder burn speed The range is from 1 to 100 This corresponds to 1x to 100x even though 100x recorders are currently not available If this key is not given then the recorder will burn at MAX s...

Page 12: ...er of characters for CDTextDiscComposer and all CDTextTrackComposer entries cannot exceed 2000 characters 2 1 22 CDTextTrackTitle This key specifies the CDText field representing the track s title Thi...

Page 13: ...ssible values are as follows ReadGI ReadData The default value is ReadData which will read the data from the disc and store the same data onto the hard disk drive ReadGI will create a Global Image fil...

Page 14: ...33 CheckPreparerIDOnDisc This key will cause PTBurn to check the disc prior to recording to see if the DataPreparerID value in the PVD matches the value of this key If the value is not found then an I...

Page 15: ...could change during the burn process YES NO The default value is NO if this key is not given 2 1 41 DriveID This Key is used to specify a drive to be used in a job There can be more than one DriveID k...

Page 16: ...os std VolumeName My Photos VerifyDisc YES NotifyClient Message This will burn 5 CD R discs with all the files and subfolders within the subfolder 1 SERVER PTBurnJobs KevinsJob Photos Data and it will...

Page 17: ...Jobs ReadData ReadDataFormat ReadData CreateSubFolders YES 2 2 6 Read Global Image Job of 3 Discs ClientID MyComputer JobID Job0 Importance 2 Copies 3 NotifyClient Message ReadDataTo MyComputer PTBurn...

Page 18: ...Request Folder location defined in PTSETUP INI The structure of this status file will be similar to an INI file with three fixed Sections of JobList CompletedJobs and System Also each job will have it...

Page 19: ...lled MyJob1 jrq then the section in the status file would be given as MyJob1 The keys under each job s details section are 3 3 1 JobID String that the describes this job 3 3 2 ClientID String that des...

Page 20: ...g that gives the time and date of when the job was completed Format is MM DD YYYY hh mm ss XX where XX is either AM or PM If not completed yet the value is blank space 3 3 12 JobState Integer values t...

Page 21: ...rs and the potential values X is a value from 0 to 9 that provides a sequential unique key So the first disc error that is encountered in the job will be given the key value of DiscErrorNumber0 the se...

Page 22: ...ors the SysErrorNumber key can be queried See more information for SysErrorNumber below 3 4 3 SystemDrives Integer value that tells how many drives are managed by the robotics for the Disc Publisher t...

Page 23: ...ause the PTBurn software to close down immediately In this case SystemStatus will be set to Offline and SysErrorNumber can be queried to determined what error caused the software to shut down For exam...

Page 24: ...stem The X represents an index if multiple robotically controlled drives are present Below is an example of the drive location string DriveLocation0 Publisher Drive Top G DriveLocation1 Publisher Driv...

Page 25: ...ue is 1 then the number is unknown This value is updated each time a disc is picked from a bin The user can also send the Check Bins command to force an update of this value 3 4 29 DiscsInLeftBin Numb...

Page 26: ...that were a result of reading errors that were media related ie Sense 03 3 5 5 RecordingErrors The number of bad discs produced by this drive that were a result of recording errors that were not media...

Page 27: ...8526B 1 02 DriveLocation1 Publisher Drive Bottom H SystemStatus Offline RoboFWVer 1 14 12 23 2004 SystemDesc Disc Publisher PRO DVDR SystemDrives 2 GoodDiscsLaunch 2 BadDiscsLaunch 0 GoodDiscsLife 2...

Page 28: ...rrentStatus Waiting JobsAhead 1 DiscsAhead 3 DiscsRemaining 10 GoodDiscs 0 BadDiscs 0 TimeCreated 15 32 15 4 15 2003 TimeStarted TimeCompleted JobState 0 JobErrorNumber 0 JobErrorString No Errors Your...

Page 29: ...Remaining 0 GoodDiscs 5 BadDiscs 0 TimeCreated 15 00 08 4 15 2003 TimeStarted 15 00 12 4 15 2003 TimeCompleted 15 15 33 4 15 2003 JobState 2 JobErrorNumber 0 JobErrorString No Errors AnotherJob3 JobID...

Page 30: ...e a new file called MyJob1 PTM Note that the ClientID must be specified and it MUST match the ClientID in the corresponding Job Request File the abort request will be rejected if the ClientID does not...

Page 31: ...sc Publisher PRO The Ignore Ink Low command will ignore an ink low condition when the system error is set to 5 6 or 7 Message IGNORE_INKLOW ClientID Administrator The ClientID should ALWAYS be fixed t...

Page 32: ...e disc This command is only valid when LoadUnloadOverride was set to YES in the jobs jrq file Message PROCESS_DISC DiscID X The DiscID should contain the id of the disc that is being processed ie the...

Page 33: ...urn SDK Page 33 of 53 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective compani...

Page 34: ...pPath which is located in the same location in the Registry PTSETUP INI Setup file for the Primera Text Based Shared Folder Burning application PTBurn NOTE This is the default PTSETUP INI file To chan...

Page 35: ...ages or not FALSE will cause PTBurn to show dialog messages including errors TRUE will cause PTBurn to suppress its dialog messages In this case the front end application should attempt to notify the...

Page 36: ...e old PXROBO_B INI instead of the new printer specific Disc Publisher II_CFG ini file This was added for backwards compatibility and we recommend setting it to FALSE UseOldIniFile FALSE This key deter...

Page 37: ...rn This file is also packaged as a loose file and can be modified before deployment After installation the location of this file can also be obtained from the Registry using the DataPath key as descri...

Page 38: ...of 53 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies end of Disc P...

Page 39: ...l run silently and almost instantaneously The user must reboot prior to running PTBurn You can continue to install other software components but the reboot must occur before the software is first laun...

Page 40: ...eir respective companies desired However your installer MUST add a registry key to reference the location of these files These files NEED to be in the location specified by the registry key Registry K...

Page 41: ...nter cartridge 11 Administrator attention Server lacks local admin rights on the machine 12 Administrator attention Internal software error PTBurn exe 13 Administrator attention No robotically control...

Page 42: ...he 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...

Page 43: ...or 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...

Page 44: ...Error 24 Only used on the DiscPublisherPRO 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 contin...

Page 45: ...r press the Cartridge button change the cartridge close the cover and press Ok to continue System Error 30 Only used on the DiscPublisherPRO This printer is not compatible with a pigment based cartrid...

Page 46: ...r this job Job 7 The print file is invalid Job 8 The job request file is invalid Job 9 The status file is corrupted or invalid Job 10 The media CD DVD is invalid Disc 11 The media CD DVD has insuffici...

Page 47: ...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...

Page 48: ...blisher 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...

Page 49: ...tion 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 e...

Page 50: ...rive0 F This notifies the client that the disc is loaded in drive F and in a hold state until the client releases the hold state The user could do some special procedure on the disc at this point if t...

Page 51: ...companies Message REJECT_DISC DiscID 0 However if the user s special verification passes the client can send the Unload Disc message as detailed below This will cause the hold state to end The job wi...

Page 52: ...ion 3 6 10 14 05 document version 2 5 8 Added Disc Publisher XR to supported devices list 9 15 05 document version 2 5 7 Added note about DVD video burning Section 2 1 10 5 23 05 document version 2 5...

Page 53: ...cation DriveState DrivePercent DriveJob DriveDisc Added more PTM message commands Align Printer Ignore Ink Low Process Disc Reject Disc Unload See section V for details Added ability in PTSETUP INI to...

Reviews: