Platforms to show: All Mac Windows Linux Cross-Platform
Back to DRBurnMBS class.
DRBurnMBS.burnForDevice(device as DRDeviceMBS) as DRBurnMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Once a burn is created with this method, the object is ready to write data to the disc.
DRBurnMBS.DRBurnAppendableKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The burn property whose value is a boolean indicating if the disc will still be appendable after the burn. If this key is not present, the burn will default to a value of false and the disc will be marked as not appendable.
DRBurnMBS.DRBurnCompletionActionEject as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
DRBurnMBS.DRBurnCompletionActionKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The burn property whose value is a String containing one of the completion actions possible for the disc handling. If this key is not present, the burn will default to a value of DRBurnCompletionActionEject and the disc will be ejected.
DRBurnMBS.DRBurnCompletionActionMount as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
DRBurnMBS.DRBurnDoubleLayerL0DataZoneBlocksKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The burn property key whose value is an double containing the number of blocks desired for the layer 0 data zone on a double layer writable disc.
The size of the layer 0 data zone dictates where the transition point is from layer 0 to layer 1. If this key is present, the data zone size will be set prior to the start of the burn using the value for this key. If it is not present, the default layer 0 data zone will be used (half the available blocks on an empty disc).
The transition point can be specified two ways. If the value specified in this key is greater than 1.0, then it will designate an absolute block number for the transition point. In this case, the block number should be a multiple of 16 and at least 40000h per specification. If the value is less than 1.0, it will specify the percentage of the burn that should reside on layer 0. A typical value is 0.5, designating half the burn for each layer. A value of 0.0 or 1.0 will not change the layer 0 transition point.
DRBurnMBS.DRBurnFailureActionEject as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
DRBurnMBS.DRBurnFailureActionKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The burn property whose value is a string containing a one of the failure actions possible for the disc handling.
If this key is not present, the burn will default to a value of DRBurnFailureActionEject and the disc will be ejected.
DRBurnMBS.DRBurnFailureActionNone as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
DRBurnMBS.DRBurnOverwriteDiscKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The burn property whose value is a boolean indicating if the disc will be overwritten from block zero for the burn. If this key is not present, the burn will default to a value of false and the disc will be appended.
DRBurnMBS.DRBurnRequestedSpeedKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The burn property whose value is a number containing the speed at which the burn should run, expressed as a float value of kilobytes per second. If this key is not present, the speed will default to DRDeviceBurnSpeedMax.
DRBurnMBS.DRBurnStatusChangedNotification as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
See the "DataBurn with Events and Notification" example project.
Some examples using this method:
DRBurnMBS.DRBurnStrategyBDDAO as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
An string value for DRBurnStrategyKey representing the DAO (disc-at-once) burn strategy for BD (Blu-ray). This strategy applies only to BDs.
DRBurnMBS.DRBurnStrategyCDSAO as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
An String value for DRBurnStrategyKey representing the SAO (session-at-once) burn strategy for CD.
DRBurnMBS.DRBurnStrategyCDTAO as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
An String value for DRBurnStrategyKey representing the TAO (track-at-once) burn strategy for CD.
DRBurnMBS.DRBurnStrategyDVDDAO as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
An String value for DRBurnStrategyKey representing the DAO (disc-at-once) burn strategy for DVD. This strategy applies only to DVDs; it is invalid when burning to CD media.
DRBurnMBS.DRBurnStrategyIsRequiredKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The burn property whose value is a BOOL indicating whether the burn strategy/strategies listed for DRBurnStrategyKey are the only strategies allowed. If this key is not present, the burn will default to a value of false.
If this value is set to true, and the device does not support the type(s) of burn requested, the burn will fail with kDRDeviceBurnStrategyNotAvailableErr .
If this value is set to false, and the device does not support the type(s) of burn requested, the engine will choose an alternate burn strategy automatically - one that will provide an equivalent disc.
DRBurnMBS.DRBurnStrategyKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The burn property whose value is a string, or array of strings, indicating the burn strategy or strategies that are suggested. If this key is not present, the burn engine picks an appropriate burn strategy automatically. Most clients will not need to specify a specific burn strategy.
When more than one strategy is suggested, the burn engine will attempt to use the first strategy in the list which is available. A burn strategy will never be used if it cannot write the required data: for example, TAO cannot be used to write CD-Text.
The presence of this key by itself is just a suggestion, and if the burn engine cannot fulfill the request it will burn using whatever strategy is available. To make the suggestion into a requirement, add DRBurnStrategyIsRequiredKey with a value of true.
DRBurnMBS.DRBurnTestingKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The burn property whose value is a boolean indicating if the burn will run as a test burn.
When this is set and the burn object is sent writeLayout, the entire burn process proceeds as if data would be written to the disc, but the laser is not turned on to full power, so the physical disc is not modified.
If this key is not present or the selected burning device does not support test burning, the burn will default to a value of false and a normal burn will occur.
DRBurnMBS.DRBurnUnderrunProtectionKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The burn property whose value is a boolean indicating if burn underrun protection will be on or off for devices which support it.
For those devices which support it, burn underrun protection is enabled by default.
If the device supports burn underrun protection and this key is not present, the burn will default to a value of true and burn underrun protection will be enabled.
DRBurnMBS.DRBurnVerifyDiscKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The burn property whose value is a boolean indicating if the disc will be verified after being burned. If this key is not present, the burn will default to a value of true and the disc will be verified.
DRBurnMBS.DRCDTextKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
This key points to a DRCDTextBlockMBS, or array of DRCDTextBlockMBS objects containing the CD-Text information for the disc. If this key is not present, the burn will not write CD-Text.
Before using this key, you should to make sure that the device supports CD-Text by checking the value of DRDeviceCanWriteCDTextKey in the device's write capabilities dictionary.
If this value is set to true, and the device does not support writing CD-Text, the burn will fail with kDRDeviceCantWriteCDTextErr.
DRBurnMBS.DRErrorStatusAdditionalSenseStringKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
String describing the RBC additional sense code and additional sense code qualifier pair returned by the device. If no sense is reported, this key will not be present.
DRBurnMBS.DRErrorStatusErrorInfoStringKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
String describing extended error information in a user appropriate manner.
DRBurnMBS.DRErrorStatusErrorKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Number containing the OS error code for the error.
DRBurnMBS.DRErrorStatusErrorStringKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
String describing the error in a user appropriate manner.
DRBurnMBS.DRErrorStatusKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The key in the status dictionary for the error dictionary.
DRBurnMBS.DRErrorStatusSenseCodeStringKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
String describing the RBC sense code returned by the device. If no sense is reported, this key will not be present.
DRBurnMBS.DRErrorStatusSenseKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
String containing the raw RBC sense information structure reported by the device. If no sense is reported, this key will not be present.
DRBurnMBS.DRMediaCatalogNumberKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The burn property whose value is a memoryblock containing exactly 13 bytes of data, which will be written to the disc as the Media Catalog Number. If this key is not present, it will default to all zeroes, indicating that a MCN is not supplied.
This value is the UPC/EAN product number, and should conform to the specifications of the UCC and EAN. See ean-int.org and uc-council.org for more details on the UPC/EAN standard.
http://www.ean-int.org/
http://www.uc-council.org/
DRBurnMBS.DRStatusCurrentSessionKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Number indicating the current session being burned.
DRBurnMBS.DRStatusCurrentSpeedKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Number indicating the current burn speed.
DRBurnMBS.DRStatusCurrentTrackKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Number indicating the current track being burned.
DRBurnMBS.DRStatusEraseTypeKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
String indicating the type of erase operation.
DRBurnMBS.DRStatusPercentCompleteKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
A key for the status dictionaries.
Number containing the percent complete of the operation expressed as a floating point number from 0 to 1.
Some examples using this method:
DRBurnMBS.DRStatusProgressCurrentKPS as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
This is an optional key within the DRStatusProgressInfoKey dictionary. The value of this key, if present, is a Number containing the write speed of the burn.
DRBurnMBS.DRStatusProgressCurrentXFactor as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
This is an optional key within the DRStatusProgressInfoKey dictionary. The value of this key, if present, is a number containing the appropriate x-factor for the media.
DRBurnMBS.DRStatusProgressInfoKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
A dictionary of extended progress information.
A key for the status dictionary. The value of this key is a reference to a Dictionary object containing extended progress information.
DRBurnMBS.DRStatusStateDone as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
DRBurnMBS.DRStatusStateErasing as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Indicates the erase is currently in progress.
DRBurnMBS.DRStatusStateFailed as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
DRBurnMBS.DRStatusStateFinishing as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Indicates the burn is finishing up (closing the last session, writing the TOC, etc).
DRBurnMBS.DRStatusStateKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
A key for the status dictionaries.
String indicating the current state of the operation.
DRBurnMBS.DRStatusStateNone as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
DRBurnMBS.DRStatusStatePreparing as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
DRBurnMBS.DRStatusStateSessionClose as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Indicates the burn is closing a session on disc. The exact session being closing is contained in DRStatusCurrentSessionKey.
DRBurnMBS.DRStatusStateSessionOpen as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Indicates the burn is opening a session on disc. The exact session being opened is contained in DRStatusCurrentSessionKey.
DRBurnMBS.DRStatusStateTrackClose as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Indicates the burn is closing a track on disc. The exact track being closed is contained in DRStatusCurrentTrackKey.
DRBurnMBS.DRStatusStateTrackOpen as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | DiscRecording | MBS MacControls Plugin | 11.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Indicates the burn is opening a track on disc. The exact track being opened is contained in DRStatusCurrentTrackKey.
The items on this page are in the following plugins: MBS MacControls Plugin.