Skip to content

iOS API Index

BRLMPrinterDriver

closeChannel

Close a session to communicate the printer. You MUST call this when finish your operation and connect to other printers.

printImageWithURL:settings:

Print the image using a print settings.

printImageWithURLs:settings:

Print the images using a print settings. The settings apply every image.

printImageWithImage:settings:

Print the bitmap using a print settings.

printPDFWithURL:settings:

Print the PDF using a print settings. This function prints all pages of the PDF. If you select pages to print, use printPDFWithURL:pages:settings: instead.

printPDFWithURLs:settings:

Print the PDFs using a print settings. This function prints all pages of each PDF.

printPDFWithURL:pages:settings:

Print specified pages of the PDF using a print settings.

printTemplateWithKey:settings:replacers:

Print installed P-touch Template with specified data. This function assumes the default P-touch Template settings. Your application may not be able to print if the printer's settings differ from the defaults. If necessary, use the P-touch Template Setting Tool to configure the printer.

cancelPrinting

Cancel sending commands and data to a printer. Actually, this only sets a cancel flag. The printer driver checks the flag when it finishes converting images and sending one image/page to the printer. Therefore, it will only cancel the printing if the cancel flag is set before the print driver checks.

getPrinterStatus

Get a printer status from the connected printer.

requestMainFirmVersion

Get the firmware version of the connected printer.

requestMediaVersion

Get the media version in the firmware of the connected printer.

requestSerialNumber

Get the serial number of the connected printer.

requestSystemReport

Get the system report of the specified printer.

requestBattery

Get the battery info of the specified printer.

requestTemplateInfoList

Get template list of the specified printer.

transferFirmwareFiles:progress:

Transfer firmware files to the printer.

transferTemplateFiles:progress:

Transfer template files to the printer.

transferDatabaseFiles:progress:

Transfer database files to the printer.

transferBinaryFiles:progress:

Transfer binary files to the printer.

transferBinaryData:progress:

Transfer binary data to the printer.

transferPrinterConfigurationFiles:progress:

Transfer printer configuration files to the printer. Only files with the .json or .eldpk extension are supported. These files can be created using the "BRConfiguration Tool" application.

BRLMChannel

initWithWifiIPAddress:

Initialize this class with an IP address of your printer to connect through a network.

initWithBluetoothSerialNumber:

Initialize this class with a serial number of your printer to connect through Bluetooth.

initWithBLELocalName:

Initialize this class with a local name of your printer to connect through Bluetooth Low Energy.

BRLMChannelCredential

initWithPrinterAdminPassword:

Initialize this class with the administrator password of your printer.

BRLMPrinterDriverGenerator

openChannel:

Return BRLMPrinterDriverGenerateResult object that contains a result of the initialization and BRLMPrinterDriver instance if the result is NoError.

openChannel:withCredential:

Return BRLMPrinterDriverGenerateResult object that contains a result of the initialization and BRLMPrinterDriver instance if the result is NoError.

BRLMPrinterSearcher

startNetworkSearch:callback:

Begins searching for compatible printers that exist on the network.

cancelNetworkSearch

Cancel searching for compatible printers that exist on the network.

startBluetoothSearch

Get the list of compatible MFi Bluetooth printers connected to the mobile device.

startBluetoothAccessorySearch:

Displays an alert view that allows user to pair the discovered Bluetooth accessory from inside your application. Since the view is OS standard one, the behavior may depend on the version of OS.

startBLESearch:callback:

Begins searching printers which support Bluetooth Low Energy.

cancelBLESearch

Cancel searching for compatible printers which support Bluetooth Low Energy.

BRLMMediaInfo

getPTLabelSize

Get the size of label. If the type of media is not for PT series, this methods failes and returns undefined value in BRLMPTPrintSettingsLabelSize.

getQLLabelSize

Get the size of label. If the type of media is not for QL series, this methods failes and returns undefined value in BRLMQLPrintSettingsLabelSize.

BRLMPrinterModelSpec

initWithPrinterModel

Instantiate this class using a BRLMPrinterModel which you want information about.

BRLMPrintSettingsProtocol

initDefaultPrintSettingsWithPrinterModel:

Initialize an object inheriting from this protocol with your printer model.

copyWithPrinterModel:

Copy the object with changing specified printer model.

BRLMTemplateObjectReplacer

initWithObjectName:value:encode:

Initialize replacer to Replaces the text in an object of a P-touch Template, specified by its object name.

initWithObjectIndex:value:encode:

Initialize replacer to Replaces the text in an object of a P-touch Template, specified by its object number.

BRLMTemplatePrintSettingsProtocol

initDefaultPrintSettingsWithPrinterModel:

Initialize an object inheriting from this protocol with your printer model.

copyWithPrinterModel:

Copy the object with changing specified printer model.

BRLMPrinterClassifier

classifyPrinterSerieseFromModel:

Classify the model into series names which are described in BRLMPrinterClassifierSeries.

transferEnumFromString:

Transfer the string of printer model into an enum for the printer model.

BRLMCustomPaperSize

initRollWithTapeWidth:margins:unitOfLength:

Initialize this object with parameters of a roll paper size.

initDieCutWithTapeWidth:tapeLength:margins:gapLength:unitOfLength:

Initialize this object with parameters for a die-cut paper size.

initMarkRollWithTapeWidth:tapeLength:margins:markPosition:markHeight:unitOfLength:

Initialize this object with parameters of a marked roll paper size.

initWithFile:

Initialize this object with a filepath of a binary file including paper size data.

BRLMPJPrintSettingsCustomPaperSize

initWithWidthDots:lengthDots:

BRLMPJPrintSettingsPaperSize

initWithPaperSizeStandard:

Initialize this object with a standard paper size. For allowed values, see BRLMPJPrintSettingsPaperSizeStandard.

initWithCustomPaper:

Initialize this object with a custom paper size. For allowed values, see BRLMPJPrintSettingsCustomPaperSize.

BRLMValidatePrintSettings

validate:

BRLMValidatePrintSettingsReport

description

Description of this report. Basically, this contains numbers of issues ant its descriptions.

BRLMValidatePrintSettingsIssue

description

Description of this issue. Basically, this contains rank and message.

BRLMFileAnalyzer

analyzePD3:

Analyzes a PD3 file and returns the analysis result, including device-dependent data and any errors encountered during the process.