Module Burn

Module Burn
Prev		Next

Module `Burn`

The Burn module.

Index: BLOCK_MODE1 BLOCK_MODE2R BLOCK_MODE2_LAME BLOCK_MODE2_OBSCURE BLOCK_MODE2_OK BLOCK_MODE2_PATHETIC BLOCK_RAW0 BLOCK_RAW16 BLOCK_RAW96P BLOCK_RAW96R CDI CDROM CDXA POS_END finish init message msf_to_sectors sectors_to_msf verbosity=

Functions
`finish`	finish
	Shutdowns the library. This should be called before exiting your application. Make sure that all drives you have grabbed are released before calling this. Returns: always nil.
`init`	init
	This must be called before using any other methods in the library. It may be called more than once with no effect. If is possible to 'restart' the library by shutting it down and re-initializing it, though there is no good reason to do that. Returns: true if the library was able to initialize, false if initialization failed.
`message`	message
	Retrieves a message. Returns: a newly allocated `Burn::Message` or nil when there are no more messages to retrieve.
`msf_to_sectors`	msf_to_sectors(minutes, seconds, frames)
	Converts a minute-second-frame (MSF) value to a sector count. `seconds`: the second component. `minutes`: the minute component. `frames`: the frame component. Returns: a sector count.
`sectors_to_msf`	sectors_to_msf(lba)
	Converts a sector count to a minute-second-frame (MSF). # Example: minutes, seconds, frames = `Burn.sectors_to_msf`(100) `lba`: the sector count. Returns: an Array of 3 elements which contains the minutes, seconds and frames components.
`verbosity=`	verbosity=(level)
	Sets the verbosity level of the library. The default value is 0, which means that nothing is output on stderr. The more you increase this, the more debug output should be displayed on stderr for you. `level`: the verbosity level desired (0 for nothing, higher positive values for more information output. Returns: the level parameter.

Constants
`BLOCK_MODE1`	only 2048 bytes of user data provided by lib/user.
`BLOCK_MODE2R`	2336 bytes of user data provided by lib/user.
`BLOCK_MODE2_LAME`	2048 bytes of data + 8 byte subheader provided by lib/user.
`BLOCK_MODE2_OBSCURE`	2324 bytes of data provided by lib/user subheader provided in write parameters.
`BLOCK_MODE2_OK`	2332 bytes of data supplied by lib/user. 8 bytes sub header provided in write parameters.
`BLOCK_MODE2_PATHETIC`	2048 bytes of user data provided by lib/user subheader provided in write parameters.
`BLOCK_RAW0`	sync, headers, edc/ecc provided by lib/user.
`BLOCK_RAW16`	sync, headers, edc/ecc and p/q subs provided by lib/user.
`BLOCK_RAW96P`	sync, headers, edc/ecc and packed p-w subs provided by lib/user.
`BLOCK_RAW96R`	sync, headers, edc/ecc and raw p-w subs provided by lib/user.
`CDI`	Session format for obsolete CD-I discs.
`CDROM`	Session format for normal audio or data discs.
`CDXA`	Session format for CDROM-XA discs.
`POS_END`	Identifies the "at the end" position.

Prev	Up	Next
Ruby/Libburn API Reference	Home	Class Burn::Disc