StarBurn SDK (Software Development Kit) |    |    |
StarBurn.h
StarBurn SDK (Software Development Kit) | | |
This is file StarBurn.h.
Name | Description | |
 | Enum that represents callback number | |
| | Enum that represents inserted disc type | |
| | Enum that represents erase type | |
| | Enum that represents exception number | |
| | Enum that represents file time that will be included in the ISO9660/Joliet image | |
| | Enum that represents file tree | |
| | Enum that represent type of ISO9660 tree node | |
| | Enum that represents the solutions of name collisions | |
| | Enum that represents raw read modes | |
| | StarWave callback reasons we'll be using | |
| | Compression templates we'll be using, pointer to compression templates and pointer to pointer to compression templates, all of the compression templates are 44 kHz, stereo, 16-bit, CBR or VBR | |
| | Enum that represents StarPort device type | |
| | Enum that represents write modes | |
Enum that represents callback number | ||
Enum that represents inserted disc type | ||
Enum that represents erase type | ||
Enum that represents exception number | ||
Enum that represents file time that will be included in the ISO9660/Joliet image | ||
Enum that represents file tree | ||
Enum that represent type of ISO9660 tree node | ||
Enum that represents the solutions of name collisions | ||
Enum that represents callback number | ||
Enum that represents inserted disc type | ||
Enum that represents erase type | ||
Enum that represents exception number | ||
Enum that represents file time that will be included in the ISO9660/Joliet image | ||
Enum that represents file tree | ||
Enum that represent type of ISO9660 tree node | ||
Enum that represents the solutions of name collisions | ||
StarWave callback reasons we'll be using | ||
Compression templates we'll be using, pointer to compression templates and pointer to pointer to compression templates, all of the compression templates are 44 kHz, stereo, 16-bit, CBR or VBR | ||
Enum that represents StarPort device type | ||
Enum that represents raw read modes | ||
StarWave callback reasons we'll be using | ||
Compression templates we'll be using, pointer to compression templates and pointer to pointer to compression templates, all of the compression templates are 44 kHz, stereo, 16-bit, CBR or VBR | ||
Enum that represents StarPort device type | ||
Enum that represents write modes | ||
Enum that represents raw read modes | ||
StarWave callback reasons we'll be using | ||
Compression templates we'll be using, pointer to compression templates and pointer to pointer to compression templates, all of the compression templates are 44 kHz, stereo, 16-bit, CBR or VBR | ||
Enum that represents StarPort device type | ||
Enum that represents write modes |
Name | Description | |
 | This function authorizes DVD that has CSS protection system. | |
| | This function erases the rewritable media inserted into CD/DVD/Blu-Ray/HD-DVD burner device. | |
| | This function cancels current read or write process on the CD/DVD/Blu-Ray/HD-DVD burner. | |
| | This function closes session on on CD/DVD/Blu-Ray/HD-DVD burner device after something was written using StarBurn_CdvdBurnerGrabber_TrackAtOnceFromTree, StarBurn_CdvdBurnerGrabber_TrackAtOnceFromPipe or StarBurn_CdvdBurnerGrabber_TrackAtOnceFromFile. | |
| | This function creates CD/DVD/Blu-Ray/HD-DVD burner device object. This object will be used later to perform CD/DVD/Blu-Ray/HD-DVD releated actions. | |
| | This function creates CD/DVD/Blu-Ray/HD-DVD burner device object using SPTI (SCSI Pass Thru Interface) transport. This object will be used later to perform CD/DVD/Blu-Ray/HD-DVD releated actions. | |
| | This function creates CD/DVD/Blu-Ray/HD-DVD burner device object using SPTD (SCSI Pass Thru Direct) transport. This object will be used later to perform CD/DVD/Blu-Ray/HD-DVD releated actions. | |
| | This function records ISO9660 or Joliet file system image located in a file on the hard disk (also it can be one sound file or full set of sound files if an audio CD is mastered) with current write speed on CD/DVD/Blu-Ray/HD-DVD burner device in Disc-At-Once PQ mode. | |
| | This function records ISO9660 or Joliet file system image located in file tree object with current write speed on CD/DVD/Blu-Ray/HD-DVD burner device in Disc-At-Once PQ mode. | |
| | This function records ISO9660 or Joliet file system image located in a file on the hard disk (also it can be one sound file or full set of sound files if an audio CD is mastered) with current write speed on CD/DVD/Blu-Ray/HD-DVD burner device in Disc-At-Once raw P-W mode. | |
| | This function records ISO9660 or Joliet file system image located in file tree object with current write speed on CD/DVD/Blu-Ray/HD-DVD burner device in Disc-At-Once raw P-W mode. | |
| | This function ejects the media on CD/DVD/Blu-Ray/HD-DVD burner device. | |
| | This function executes custom CDB (Command Descriptor Block) on CD/DVD/Blu-Ray/HD-DVD burner device object. This could be used to deal with the propriatry hardware or execute some special code StarBurn does not support out-of-box. | |
| | This function returns CD/DVD/Blu-Ray/HD-DVD burner device object extended information. This data can be used to report the capabilities of the device to the user. | |
| | This function tests is CD/DVD/Blu-Ray/HD-DVD burner device supports BUP (Buffer Underrun Protection) or not and what is BUP current status (if supported). This information can be used later to set BUP status before starting write operations. | |
| | This function returns CD/DVD/Blu-Ray/HD-DVD burner device object information. This data can be used to report the capabilities of the device to the user. | |
| | This function detects disc file system | |
| | This function gets disc information of the currently inserted disc on CD/DVD/Blu-Ray/HD-DVD burner device. | |
| | This function gets DVD protection system of inserted DVD media into DVD device. | |
| | This function gets DVD region mask from DVD media inserted to CD/DVD/Blu-Ray/HD-DVD burner device object created with the call to the one of the StarBurn_CdvdBurnerGrabber_Create or StarBurn_CdvdBurnerGrabber_CreateEx API calls. | |
| | This function returns inserted to CD/DVD/Blu-Ray/HD-DVD burner device disc type. This data can be used to report it to the user and to select the stream type to record. | |
| | This function gets last recorded track from CD/DVD/Blu-Ray/HD-DVD media currently inseted to CD/DVD/Blu-Ray/HD-DVD burner device object. Such a track number could be used for already recorded session import. | |
| | This function gets mechanical options (is device capable of programmatical load/eject and lock/unlock etc) from CD/DVD/Blu-Ray/HD-DVD burner device object. | |
| | This function gets media (inserted or not) and tray (opened or closed) statuses from CD/DVD/Blu-Ray/HD-DVD burner device object. | |
| | This function gets number of system descriptors in system structures stream. This value is used for updating head of the image when creating signle track session import code. | |
| | This function gets RPC (region play code) and some additional DVD region management information from "DVD part" of the CD/DVD/Blu-Ray/HD-DVD burner device object created with the call to the one of the StarBurn_CdvdBurnerGrabber_Create or StarBurn_CdvdBurnerGrabber_CreateEx API calls. | |
| | This function gets current read and write and top supported read and write speeds on CD/DVD/Blu-Ray/HD-DVD burner device. This speeds later will be used to set current speeds during all read and write operations. | |
| | This function returns CD/DVD/Blu-Ray/HD-DVD burner device object extended information. This data can be used to report the capabilities of the device to the user. | |
| | This function returns DVD+R(W) burner device object extended information. This data can be used to report the capabilities of the device to the user. | |
| | This function returns DVD+R(W) burner device object extended extended information. This data can be used to report the capabilities of the device to the user. | |
| | This function gets TOC information of the currently inserted disc on CD/DVD/Blu-Ray/HD-DVD burner device. | |
| | This function gets track information of the asked track number on CD/DVD/Blu-Ray/HD-DVD burner device. | |
| | This function grabs disc image from the currently inserted disc on CD/DVD/Blu-Ray/HD-DVD burner device and store it in MDS format. | |
| | This function grabs disc image from the currently inserted disc on CD/DVD/Blu-Ray/HD-DVD burner device and store it in MDS format, disc image will be stored into the serie of files. | |
| | This function grabs range of logical blocks from the currently inserted disc on CD/DVD/Blu-Ray/HD-DVD burner device. | |
| | This function grabs track from the currently inserted disc on CD/DVD/Blu-Ray/HD-DVD burner device. | |
| | This function loads the media on CD/DVD/Blu-Ray/HD-DVD burner device. | |
| | This function loads the media on CD/DVD/Blu-Ray/HD-DVD burner device. Unlike StarBurn_CdvdBurnerGrabber_Load(...) this API call allows to control should it return immediately or wait until the drive would become into ready state. | |
| | This function locks the media inside the CD/DVD/Blu-Ray/HD-DVD device. | |
| | This function converts MSF (minute:second:frame) address into the LBA (logical block address). | |
| | This function probes supported read modes on the currently inserted disc on CD/DVD/Blu-Ray/HD-DVD burner device. | |
| | This function probes supported read modes on the currently inserted disc on CD/DVD/Blu-Ray/HD-DVD burner device. | |
| | This function reads ATIP information from the media currently inserted into CD/DVD/Blu-Ray/HD-DVD burner device object created with the call to the one of the StarBurn_CdvdBurnerGrabber_Create or StarBurn_CdvdBurnerGrabber_CreateEx API calls. | |
| | This function reads one or more logical block(s) from the currently inserted CD/DVD/Blu-Ray/HD-DVD in cooked format. | |
| | This function reads one logical block from the currently inserted disc on CD/DVD/Blu-Ray/HD-DVD burner device. | |
| | This function reads one or more logical block(s) from the currently inserted CD in RAW format. | |
| | This function releases the media inside the CD/DVD/Blu-Ray/HD-DVD device after the media was locked before. | |
| | This function sends OPC (Optimum Power Calibrarion) for current write speed on CD/DVD/Blu-Ray/HD-DVD burner device and current CD/DVD/Blu-Ray/HD-DVD media. The set laser level will be used later during all write operations. | |
| | This function records ISO9660 or Joliet file system image located in a virtual file tree created with StarBurn_ISO9660JolietFileTree_Create or ISO image with current write speed on CD/DVD/Blu-Ray/HD-DVD burner device in Session-At-Once mode. | |
| | This function records raw image with current write speed on CD/DVD/Blu-Ray/HD-DVD burner device in raw Session-At-Once mode. | |
| | This function sets BUP (Buffer Underrun Protection) on CD/DVD/Blu-Ray/HD-DVD burner device that supports BUP. BUP must be enabled for successful completion of write operations. | |
| | Sets CD-Text item for the specified CD/DVD/Blu-Ray/HD-DVD device. | |
| | This function sets read speed for CD/DVD/Blu-Ray/HD-DVD media currently inserted to CD/DVD/Blu-Ray/HD-DVD burner device object. | |
| | This function sets current read and write speeds on CD/DVD/Blu-Ray/HD-DVD burner device This speeds later will be used during all read and write operations. | |
| | This function resets media state inside CD/DVD/Blu-Ray/HD-DVD burner device object. This actions allow to update disc content w/o need to eject the disc. Could be used for multiple burnings w/o disc eject or manual disc data verification. | |
| | This function records SVCD/MPEG2 image located in a file on the hard disk with current write speed on CD/DVD/Blu-Ray/HD-DVD burner device. | |
| | This function records SVCD/MPEG2 image located in a file on the hard disk with current write speed on CD/DVD/Blu-Ray/HD-DVD burner device in selected write mode. | |
| | This function records SVCD/MPEG2 image located in a file on the hard disk with current write speed on CD/DVD/Blu-Ray/HD-DVD burner device in selected write mode. | |
| | This function tests is CD/DVD/Blu-Ray/HD-DVD burner device object unit ready or not. This information can be used later to start I/O operations. | |
| | This function tests is CD/DVD/Blu-Ray/HD-DVD burner device object unit ready or not. This information can be used later to start I/O operations. The only difference between this and simple StarBurn_CdvdBurnerGrabber_TestUnitReady() is that this code passed parameter to wait for unit to become ready. And "simple" code uses default timeout of 20 seconds. | |
| | This function tests is CD/DVD/Blu-Ray/HD-DVD burner device object unit ready or not. This information can be used later to start I/O operations. This "double extended" variant of the call also can wait for particular amount of seconds and do "fast exit" if there's no disc in drive. | |
| | This function records ISO9660 or Joliet file system image located in a file on the hard disk (also it can be sound file if an audio CD is mastered) with current write speed on CD/DVD/Blu-Ray/HD-DVD burner device in Track-At-Once mode. | |
| | This function records ISO9660 or Joliet file system image or audio stream located in a memory with current write speed on CD/DVD/Blu-Ray/HD-DVD burner device in Track-At-Once mode. | |
| | This function records ISO9660 or Joliet file system image located in a pipe with current write speed on CD/DVD/Blu-Ray/HD-DVD burner device in Track-At-Once mode. | |
| | This function records ISO9660 or Joliet file system image or audio stream located in a pipe with current write speed on CD/DVD/Blu-Ray/HD-DVD burner device in Track-At-Once mode. | |
| | This function records ISO9660 or Joliet file system image located in a virtual file tree created with StarBurn_ISO9660JolietFileTree_Create with current write speed on CD/DVD/Blu-Ray/HD-DVD burner device in Track-At-Once mode. | |
| | This function verifies recorded file system image on CD/DVD/Blu-Ray/HD-DVD burner device object used for this particular image recording (or maybe other image). This information can be used to be sure recorded disc is readable and really contains recorded information. | |
| | This function verifies recorded file system tree on CD/DVD/Blu-Ray/HD-DVD burner device object used for this particular tree recording. This information can be used to be sure recorded disc is readable and really contains recorded information. | |
| | This function verifies recorded file system tree on CD/DVD/Blu-Ray/HD-DVD burner device object used for this particular tree recording. This information can be used to be sure recorded disc is readable and really contains recorded information. | |
| | This function records VCD/MPEG1 image located in a file on the hard disk with current write speed on CD/DVD/Blu-Ray/HD-DVD burner device in Track-At-Once mode. | |
| | This function records VCD/MPEG1 image located in a file on the hard disk with current write speed on CD/DVD/Blu-Ray/HD-DVD burner device in selected write mode. | |
| | This function records VCD/MPEG1 image located in a file on the hard disk with current write speed on CD/DVD/Blu-Ray/HD-DVD burner device in selected write mode. | |
| | Routine Description: This function generate next ISO9660 file name to make it unique | |
| | Routine Description: This function generate next Joliet file name to make it unique | |
| | This function frees allocated memory in the way of destroying the object that toolkit created internally. This is universal call, it frees all the objects and does not care about object type. | |
| | This function uninitializes burning toolkit. It's expected to be called after very last function call before exiting from StarBurn client application. It's a good idea to gather the trash before exiting. Starting from build 4.2.6 it's *REQUIRED* to call this function, it does not matter what build (static Vs. dynamic) of StarBurn is used. | |
| | This function creates DVD-Video file system object from passed pointer to VIDEO_TS directory with DVD corresponding files. | |
| | This function destroys DVD-Video file system object created with StarBurn_DVDVideo_Create API call. | |
| | This function gets file system content size in UCHARs from DVD-Video file system object created with StarBurn_DVDVideo_Create API call. | |
| | This function returns pointer to ISO9660 file tree object embedded to DVD-Video file system object created with StarBurn_DVDVideo_Create API call. | |
| | This function reads requested number of UCHARs from DVD-Video file system object (created with StarBurn_DVDVideo_Create API call) from it's current read position. | |
| | This function moves DVD-Video file system object (created with StarBurn_DVDVideo_Create API call) current read position to the very beginning. | |
| | This function finds device of the specified device type. | |
| | This function returns audio stream size in UCHARs for passed supported as source audio file. | |
| | This function returns buffer underrun timeout in milliseconds. It's amount of time StarBurn core would wait before resubmitting each command to the drive if burning was faster then reading and StarBurn had exhausted software cache it uses for buffering. Modern hardware has BUP (Buffer Underrun Protection) and would perfectly survive in such a condition and keep burning disc still usable. | |
| | This function returns device letter (device root path) for a device name, like the one used in StarBurn_CdvdBurnerGrabber_CreateEx(...) API call. | |
| | This function gets device name by device address. | |
| | This function gets device timeout in seconds by device SCSI address. | |
| | This function returns is DVD padding mode (when at least 1GB of the data would be recorded to DVD media - required for DVD-Video compilations to work properly on standalone DVD players) enabled (TRUE) or disabled (FALSE). | |
| | This function returns is DVD+R DL (Dual Layer) so-called "compatible mode" (when layer would be switched exactly at 1/2 of the data payload recorded on the disc - required for DVD-Video compilations to work properly) enabled (TRUE) or disabled (FALSE). | |
| | This function returns is so-called "eject after fail" (if during burning process error would happen - should StarBurn eject disc or not) enabled (TRUE) or disabled (FALSE). | |
| | This function returns is so-called "fast read TOC" (TOC information is not 100% accurate - to get EXACT track length StarBurn trys to read beginning and end of the track to find subchannel index switch indicating EXACT track beginning or EXACT track end) mode enabled (TRUE) or disabled (FALSE). | |
| | This function gets ASPI layer ID strings. | |
| | This function returns is collision detection disabled (TRUE) or enabled (FALSE). If collision detection is enabled - every new file added to ISO9660 or Joliet file tree would be checked to have unique name. If such a file already exist - special callback (collision detection one) would be called so user would be able to either replace or rename new or old file. However if collision detection is disabled - no comparation and no actions would be performed. File would be just added to the destination file system image AS IS, having it's original name. | |
| | This function returns is so-called "safe grabbing" (when StarBurn would mix read commands with checking for device to become ready - required to workaround broken ATAPI-to-USB bridges) enabled (TRUE) or disabled (FALSE). | |
| | This function returns a 32-bit unsigned long value that contains packed numbers that represent the year, the month and the date of the toolkit build. So 10th of March, year of 1978 will look like 0x19780310. | |
| | This function gets volume ID from ISO9660/Joliet volume name. | |
| | This function returns is currently passed file supported as source audio file. | |
| | This function adds the tree created from the directory to already created ISO9660 or Joliet file tree from passed directory. Later this tree can be used to build "virtual" ISO96600 or Joliet file system image. Resulting "virtual" image can be either stored in the file on the disk or be burn directly to the CD/DVD/Blu-Ray/HD-DVD media w/o any other intermediate operations. | |
| | This function adds the tree created from the directory to already created ISO9660 or Joliet file tree from passed directory. Later this tree can be used to build "virtual" ISO96600 or Joliet file system image. Resulting "virtual" image can be either stored in the file on the disk or be burn directly to the CD/DVD/Blu-Ray/HD-DVD media w/o any other intermediate operations. | |
| | This function adds the node created from the memory to already created ISO9660 or Joliet file tree from passed directory. Later this tree can be used to build "virtual" ISO96600 or Joliet file system image. Resulting "virtual" image can be either stored in the file on the disk or be burn directly to the CD/DVD/Blu-Ray/HD-DVD media w/o any other intermediate operations. | |
| | This function adds the tree created from the directory to already created ISO9660 or Joliet file tree from passed directory. Later this tree can be used to build "virtual" ISO96600 or Joliet file system image. Resulting "virtual" image can be either stored in the file on the disk or be burn directly to the CD/DVD/Blu-Ray/HD-DVD media w/o any other intermediate operations. Unlike other tree management calls this one deals with Unicode names (wide char variant of basic call). | |
| | This function builds ISO9660 or Joliet file system image from ISO9660 or Joliet file tree (assignes all the logical block offsets and allocates and initializes all file system internal structures). Later this tree can be used to store the "virtual" ISO9660 or Joliet image to the file on the disk or to burn this ISO9660 or Joliet image directly to the CD/DVD/Blu-Ray/HD-DVD media. | |
| | This function builds ISO9660 or Joliet file system image from ISO9660 or Joliet file tree (assignes all the logical block offsets and allocates and initializes all file system internal structures). Later this tree can be used to store the "virtual" ISO9660 or Joliet image to the file on the disk or to burn this ISO9660 or Joliet image directly to the CD/DVD/Blu-Ray/HD-DVD media. It's identical to StarBurn_ISO9660JolietFileTree_BuildImage except has some extra parameter to put into file system descriptor. | |
| | This function canceles ISO9660 or Joliet file tree creation process. | |
| | This function allocates in the memory and initializes ISO9660 or Joliet file tree. Later this file tree can be used to build "virtual" ISO96600 or Joliet file system image. Resulting "virtual" image can be either stored in the file on the disk or be recorder directly to the CD/DVD/Blu-Ray/HD-DVD media w/o any other intermediate buffering operations on the hard disk. | |
| | This function returns ISO9660 or Joliet file tree node attributes. | |
| | This function returns ISO9660 or Joliet file tree file size in UCHARs. | |
| | This function returns ISO9660 or Joliet file tree node first kid pointer. | |
| | This function returns full path to ISO9660 or Joliet file tree node. | |
| | This function returns ISO9660 or Joliet file tree level. The number of levels in the created tree. | |
| | This function returns ISO9660 or Joliet file tree node names (long, short and absolute). | |
| | This function returns ISO9660 or Joliet file tree node names (long, short and absolute). Also it returns file system dependent names in ANSI and Unicode. | |
| | StarBurn_ISO9660JolietFileTree_GetNamesW function is not documented | |
| | This function returns ISO9660 or Joliet file tree root node next kid pointer. | |
| | This function returns ISO9660 or Joliet file tree node ISO9660 timestamp (date and time). | |
| | This function returns ISO9660 or Joliet file tree node power (file size) in UCHARs. | |
| | This function returns ISO9660 or Joliet file tree node starting LBA after the image was built. | |
| | This function returns ISO9660 or Joliet file tree node SYSTEMTIME. | |
| | This function returns ISO9660 or Joliet file tree node parent pointer. | |
| | This function returns ISO9660 or Joliet file tree root node pointer. | |
| | This function returns ISO9660 or Joliet built file system image size in UCHARs. | |
| | This function imports file for created ISO9660 or Joliet file tree. | |
| | This function imports track for created ISO9660 or Joliet file tree. | |
| | This function reads ISO9660 or Joliet file system image from current offset into the user's data buffer. ISO9660 or Joliet file tree must have assigned all the logical block offsets and all file system internal structures allocated and initialized. The data that is read can be either stored in the file on the hard disk or directly written to CD/DVD/Blu-Ray/HD-DVD media. | |
| | This function deletes ISO9660 or Joliet file tree node and all it's kids. | |
| | This function seeks the ISO9660 or Joliet file system image from current offset to the very begining so read operation will start from the 0 offset of the file system image. ISO9660 or Joliet file tree must have assigned all the logical block offsets and all file system internal structures allocated and initialized. | |
| | This function sets ISO9660 or Joliet file tree node attributes. | |
| | This function sets boot image for created ISO9660 or Joliet file tree. | |
| | This is function StarBurn_ISO9660JolietFileTree_SetBootImageEx. | |
| | This function sets ISO9660 or Joliet file tree node names (long, short and absolute). | |
| | This function sets buffer underrun timeout in milliseconds. It's amount of time StarBurn core would wait before resubmitting each command to the drive if burning was faster then reading and StarBurn had exhausted software cache it uses for buffering. Modern hardware has BUP (Buffer Underrun Protection) and would perfectly survive in such a condition and keep burning disc still usable. | |
| | This function sets device timeout in seconds by device SCSI address. | |
| | This function sets DVD padding mode (when at least 1GB of the data would be recorded to DVD media - required for DVD-Video compilations to work properly on standalone DVD players) to enabled (TRUE) or disabled (FALSE). | |
| | This function sets DVD+R DL (Dual Layer) so-called "compatible mode" (when layer would be switched exactly at 1/2 of the data payload recorded on the disc - required for DVD-Video compilations to work properly) to enabled (TRUE) or disabled (FALSE). | |
| | This function sets so-called "eject after fail" (if during burning process error would happen - should StarBurn eject disc or not) to enabled (TRUE) or disabled (FALSE). | |
| | This function sets so-called "fast read TOC" (TOC information is not 100% accurate - to get EXACT track length StarBurn trys to read beginning and end of the track to find subchannel index switch indicating EXACT track beginning or EXACT track end) mode to enabled (TRUE) or disabled (FALSE). | |
| | This function sets collision detection to disabled (TRUE) or enabled (FALSE). If collision detection is enabled - every new file added to ISO9660 or Joliet file tree would be checked to have unique name. If such a file already exist - special callback (collision detection one) would be called so user would be able to either replace or rename new or old file. However if collision detection is disabled - no comparation and no actions would be performed. File would be just added to the destination file system image AS IS, having it's original name. | |
| | This function sets so-called "safe grabbing" (when StarBurn would mix read commands with checking for device to become ready - required to workaround broken ATAPI-to-USB bridges) to enabled (TRUE) or disabled (FALSE). | |
| | This function adds local device (RAM disk, hard disk or DVD-ROM emulation) to StarPort virtual storage controller. StarPort acts like RAM disk, hard disk and DVD emulator, AoE (ATA-over-Ethernet) and iSCSI (SCSI-over-IP) initiator driver. | |
| | This function adds remote device (RAM disk, hard disk or DVD-ROM emulation) to StarPort virtual storage controller. StarPort acts like RAM disk, hard disk and DVD emulator, AoE (ATA-over-Ethernet) and iSCSI (SCSI-over-IP) initiator driver. | |
| | This function gets device list from StarPort virtual storage controller. StarPort acts like RAM disk, hard disk and DVD-ROM emulator, AoE (ATA-over-Ethernet) and iSCSI (SCSI-over-IP) initiator driver. Unlike StarBurn_StarPort_DeviceListQueryRemote API call which retreives information about REMOTE device list this call gets information about LOCAL device list. | |
| | This function gets device list from remote StarWind iSCSI target. StarWind exports RAM disk, hard disk and DVD-ROM emulator, AoE (ATA-over-Ethernet) and iSCSI (SCSI-over-IP) targets. Unlike StarBurn_StarPort_DeviceListQueryLocal API call which retreives information about LOCAL device list this call gets information about REMOTE device list. | |
| | This function removes device from StarPort virtual storage controller. StarPort acts like RAM disk, hard disk and DVD-ROM emulator, AoE (ATA-over-Ethernet) and iSCSI (SCSI-over-IP) initiator driver. | |
| | This function retrieves device type, vendor ID, product ID and revision for StarPort device by its target ID. | |
| | This function retrieves device letter (symbolic link) for StarPort device by its target ID. | |
| | This function retrieves device SCSI address for StarPort device by its target ID. | |
| | This function checks if the StarPortLite driver is installed and that its API version is equal to the one StarBurn was built with. | |
| | This function seeks all of the internal object pointers to the very beginning of it so following read operations would start from the very beginning instead of the currently set position. | |
| | This function creates compressed file reader object from passed compressed audio file name. | |
| | This function destroys compressed file reader object. | |
| | This function reads uncompressed payload data chunk from underlying compressed file reader object. | |
| | This function returns uncompressed payload size in UCHARs for underlying compressed file reader object. | |
| | This function recompresses already compressed file to new one with another compression. | |
| | This function checks is file name actually points to supported compressed audio file. | |
| | This function uncompresses compressed file to either WAV or RAW PCM. | |
| | This function creates compressed file writer object. | |
| | This function destroys compressed file writer object. | |
| | This function writes uncompressed data chunk to compressed file writer object. | |
| | This function compresses uncompressed file to new one with asked compression. | |
| | This function checks is file name actually points to supported uncompressed audio file. | |
| | This function returns StarWave library version. | |
| | Creates the UDF Tree Node | |
| | This function removes created UDF tree from the pointed UDF tree node sequentially. Processes file formatted UDF nodes and either closes file handles or frees memory (non-cached vs. cached content). | |
| | StarBurn_UDF_Create() function is obsolete. Use StarBurn_UDF_CreatEx() instead of it | |
| | This function creates UDF tree from the allocated data buffers. | |
| | This function devastates created UDF tree from the pointed root recursively. | |
| | Destroys UDF Tree Node and all its kids | |
| | This function formats UDF tree item as directory. | |
| | This function formats UDF tree item as file. | |
| | StarBurn_UDF_GetFirstChild function is not documented | |
| | StarBurn_UDF_GetNextSibling function is not documented | |
| | Returns the object to current Tree Node | |
| | StarBurn_UDF_GetParent function is not documented | |
| | This function initializes burning toolkit. It's expected to be called as the very first function call before calling any other StarBurn exported code. Some of StarBurn functions would work with not initialized core, some would fail with EN_REGISTRATION_FAILED error. Starting from build 4.2.6 it's *REQUIRED* to call this function, it does not matter what build (static Vs. dynamic) of StarBurn is used. License file StarBurn.key is assumed to be located near main application executable. ATTENTION! This call is OBSOLTE. Use StarBurn_UpStartEx(...) instead of it. | |
| | This function initializes burning toolkit. It's expected to be called as the very first function call before calling any other StarBurn exported code. Some of StarBurn functions would work with not initialized core, some would fail with EN_REGISTRATION_FAILED error. Starting from build 4.2.6 it's *REQUIRED* to call this function, it does not matter what build (static Vs. dynamic) of StarBurn is used. The difference between this call and call to StarBurn_UpStart(...) is that this particular call assumes StarBurn key is being embedded to the application binary and StarBurn_UpStart(...) always looks for StarBurn.key near application executable. |
Name | Description |
Define StarBurn.h to avoid including it more then once | |
ASPI safe buffer size in UCHARs. ASPI is assumed to support at least 64KB large transfer per time. 64KB - PAGE_SIZE_IN_UCHARS was old default value. Now we'll use DVD_ECC_BLOCK_SIZE_IN_UCHARS as it's smaller and produce better results when dealing with DVD media | |
Audio LB (logical block) size in UCHARs | |
Actually 4495.5 | |
2X Blu-Ray speed constant (BD-R and BD-RE) | |
Default buffer status report delay in seconds | |
64 | |
10X CD speed constant | |
12X CD speed constant | |
16X CD speed constant | |
1X CD speed constant | |
20X CD speed constant | |
24X CD speed constant | |
2.2X CD speed constant | |
2X CD speed constant | |
32X CD speed constant | |
36X CD speed constant | |
3X CD speed constant | |
40X CD speed constant | |
44X CD speed constant | |
48X CD speed constant | |
4X CD speed constant | |
52X CD speed constant | |
6X CD speed constant | |
8X CD speed constant | |
Top supported CD/DVD/Blu-Ray/HD-DVD speed constant (wildcard) | |
Default number of read retries during verification process | |
Top number of SCSI devices per logical SCSI bus (was 15 originally) | |
Disc is complete | |
Disc is empty | |
Disc is incomplete | |
Doubled... | |
DVD ECC block size in logical blocks (2048 UCHARs each) | |
DVD ECC block size in UCHARs. This is true "hardware" logical block size on DVD. It's recommended to have transfers of this size and this size aligned | |
DVD with CPRM (Copy-Protected Removable Media) protection | |
DVD with CSS (Content Scrambling System) protection | |
DVD w/o any protection system | |
12X DVD speed constant (DVD-R, DVD+R) | |
16X DVD speed constant (DVD+R and DVD-R) | |
18X DVD speed constant (DVD+R and DVD-R) | |
1X DVD speed constant (DVD-R, DVD-RW and DVD-RAM) | |
20X DVD speed constant (DVD+R and DVD-R) | |
2.4X DVD speed constant (DVD+R, DVD+R DL and DVD+RW) | |
2X DVD speed constant (DVD-R, DVD-RW and DVD-RAM) | |
3X DVD speed constant (DVD-RAM) | |
4X DVD speed constant (DVD-R, DVD-R DL, DVD-RW, DVD+R, DVD+R DL, DVD+RW and DVD-RAM) | |
5X DVD speed constant (DVD-RAM) | |
6X DVD speed constant (DVD-RW) | |
8X DVD speed constant (DVD-R, DVD-R DL, DVD+R, DVD+R DL and DVD+RW) | |
Bootable disc ID | |
Bootable specification signature | |
Real mode code load segment | |
Custom bootable media emulation | |
1.2 MB floppy bootable media emulation | |
1.44 MB floppy bootable media emulation | |
2.88 MB floppy bootable media emulation | |
Hard disk bootable media emulation | |
Non-bootable disc ID | |
x86 platform identifier | |
MAC platform identifier | |
PowerPC platform identifier | |
C2 and block error information | |
C2 error information | |
No error information | |
Reserved | |
Accept all LBs | |
Accept only CDDA (CD digital audio) LBs | |
Accept only MODE1 LBs | |
Accept only MODE2 LBs (both Form1 and Form2) | |
Accept only MODE2 Form1 LBs | |
Accept only MODE2 Form2 LBs | |
Hard disk LB (logical block) size in UCHARs | |
Both header and subheader | |
4-byte header | |
No header | |
MODE2 Form1 or Form2 subheader | |
ISO9660 date size in UCHARs | |
ISO9660 file size in UCHARs | |
ISO9660 name size in UCHARs | |
ISO9660 volume descriptor system and volume ID size in UCHARs | |
ISO9660 top supported file tree level | |
Last session is complete | |
Last session is empty | |
Last session is incomplete | |
MODE1 LB (logical block) size in UCHARs | |
MODE2 Form1 LB (logical block) size in UCHARs | |
MODE2 Form2 LB (logical block) size in UCHARs | |
MODE2 Form2 + 8 UCHARs of subheader LB (logical block) size in UCHARs | |
MODE2 Formless LB (logical block) size in UCHARS | |
Top number of raw tracks (including maintenance tracks) on CD/DVD/Blu-Ray/HD-DVD disc. This is calculated based on the worst CD case when all tracks will be in a separate sessions. We need this approximate value to avoid allocating TOC_INFORMATION structure dynamically. | |
Default number of retries on read operations (if bad block was possibly hit, was 2 originally) | |
Subchannels from P to W | |
Top number of tracks (or border-in/border-out zones) on CD/DVD/Blu-Ray/HD-DVD disc | |
Small page size in UCHARs on x86 machines (default allocatable storage) | |
RAW LB (logical block) with PQ subchannel size in UCHARs | |
RAW LB (logical block) with RAW P-W subchannel size in UCHARs | |
RAW LB (logical block) size in UCHARs | |
Default read report delay in seconds | |
SCSI disk device | |
SCSI MO (Magneto-Optical) disk device | |
SCSI jukebox (disc changer) device | |
SCSI network device | |
SCSI printer device | |
SCSI processor device | |
SCSI CD/DVD/Blu-Ray/HD-DVD device | |
SCSI scanner device | |
SCSI tape device | |
SCSI device... Is gone! | |
SCSI device any (wildcard for StarBurn_FindDevice() function) | |
SCSI WORM (Write-Once-Read-Multiple) device | |
Short (w/o sync and header) RAW LB (logical block) size in UCHARs | |
Number of logical blocks on single layer DVD | |
Default cache size for I/O operations | |
This is macro STARBURN_CACHE_SIZE_READ_WRITE. | |
Disc type is CDDA (CD-ROM or Digital Audio) | |
Disc type is CDI | |
Disc type is undefined | |
Disc type is CD-ROM XA | |
Own definitions and macros (begin) | |
Loading mechanism type constants | |
This is macro STARBURN_LOADING_MECHANISM_TYPE_CARTRIDGE. | |
This is macro STARBURN_LOADING_MECHANISM_TYPE_CHANGER. | |
This is macro STARBURN_LOADING_MECHANISM_TYPE_POP_UP. | |
This is macro STARBURN_LOADING_MECHANISM_TYPE_RESERVED1. | |
This is macro STARBURN_LOADING_MECHANISM_TYPE_RESERVED2. | |
This is macro STARBURN_LOADING_MECHANISM_TYPE_RESERVED3. | |
This is macro STARBURN_LOADING_MECHANISM_TYPE_TRAY. | |
StarBurn smallest split file size in megabytes | |
StarWave recommended I/O buffer size in UCHARs. It's *STRONGLY* recommended to use either it or multiplications of STARWAVE_IO_BUFFER_SIZE_IN_UCHARS as internal calculations and indexations are integer rather then float based | |
StarPort device name size in UCHARs | |
No subchannel | |
PQ subchannel | |
PQ subchannel size in UCHARs | |
RAW P-W subchannel | |
Raw P-W subchannel size in UCHARs | |
Reserved | |
R-W subchannel | |
Subchannel size in UCHARs | |
Special "invisible" track number | |
Logical Unit region is set. Additional restrictions required to make a change | |
No Logical Unit region setting | |
Logical Unit region has been set permanently, but may be reset by vendor if necessery | |
Logical Unit region is set | |
UDF file set descriptor logical block address | |
UDF file set descriptor terminator logical block address | |
UDF head size in logical blocks | |
UDF/ISO9660 bridge file system structures size in logical blocks (was 5 originally) | |
UDF logical block size in UCHARs | |
UDF longest name size in UCHARs | |
UDF tail size in logical blocks | |
WAVE file data alignment (4 UCHARs, 1 ULONG) | |
WAVE file bits per sample | |
WAVE file number of channels | |
WAVE file DATA signature | |
WAVE file RIFF signature | |
WAVE file samples per second | |
WAVE file TAG signature | |
WAVE file WAVE format | |
WAVE file WAVE signature | |
Default write report delay in seconds |
Name | Description | |
 | Structure that represents CDB failure information | |
| | Structure that represents DAO disc layout | |
| | Structure that represents DAO disc layout entry (track) | |
| | Structure with disc file system flags | |
| | Structure that represents disc layout | |
| | Structure that represents disc layout entry (track) | |
| | Structure that represents full TOC entry | |
| | Structure that represents ISO9660 date and time | |
| | Structure that represents information about name collistion | |
| | Structure that represents formatted PQ subchannel | |
| | Structure that represents SCSI device address | |
| | Structure that represents advanced supported media formats | |
| | Structure that represents Disc information | |
| | Structure that represents Track information | |
| | Structure that represents StarPort device list | |
| | Structure that represents StarPort device list entry | |
| | Structure that represents TOC entry | |
| | Structure that represents TOC information | |
| | Structure that represents UDF control block | |
| | Structure that represents UDF file handle | |
| | Structure that represents UDF tree item | |
| | Structure that represents WAVE file header | |
| | Structure that represents WAVE format chunk | |
Structure that represents CDB failure information | ||
Structure that represents DAO disc layout | ||
Structure that represents DAO disc layout entry (track) | ||
Structure with disc file system flags | ||
Structure that represents disc layout | ||
Structure that represents disc layout entry (track) | ||
Structure that represents full TOC entry | ||
Structure that represents ISO9660 date and time | ||
Structure that represents information about name collistion | ||
Structure that represents CDB failure information | ||
Structure that represents DAO disc layout | ||
Structure that represents DAO disc layout entry (track) | ||
Structure with disc file system flags | ||
Structure that represents disc layout | ||
Structure that represents disc layout entry (track) | ||
Structure that represents full TOC entry | ||
Structure that represents ISO9660 date and time | ||
Structure that represents information about name collistion | ||
Structure that represents formatted PQ subchannel | ||
Structure that represents StarPort device list | ||
Structure that represents StarPort device list entry | ||
Structure that represents formatted PQ subchannel | ||
Structure that represents SCSI device address | ||
Structure that represents advanced supported media formats | ||
Structure that represents Disc information | ||
Structure that represents Track information | ||
Structure that represents StarPort device list | ||
Structure that represents StarPort device list entry | ||
Structure that represents TOC entry | ||
Structure that represents TOC information | ||
Structure that represents UDF control block | ||
Structure that represents UDF file handle | ||
Structure that represents UDF tree item | ||
Structure that represents WAVE file header | ||
Structure that represents WAVE format chunk | ||
Structure that represents SCSI device address | ||
Structure that represents advanced supported media formats | ||
Structure that represents Disc information | ||
Structure that represents Track information | ||
Structure that represents StarPort device list | ||
Structure that represents StarPort device list entry | ||
Structure that represents TOC entry | ||
Structure that represents TOC information | ||
Structure that represents UDF control block | ||
Structure that represents UDF file handle | ||
Structure that represents UDF tree item | ||
Structure that represents WAVE file header | ||
Structure that represents WAVE format chunk |
Name | Description |
Callback type (function of this type must be passed as callback) | |
StarWave callback passed to I/O functions. Return anything except zero from it to cancel I/O operation |
Enumerations