Android API Index

PrinterDriver

closeChannel

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

printImage

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

printPDF

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

printPDF

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

printPDF

Print specified pages of the PDF using print settings.

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 the 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.

requestBatteryInfo

Get the battery info of the specified printer.

requestTemplateInfoList

Get the template list of the specified printer.

transferFirmwareFiles

Transfer firmware files to the printer.

transferTemplateFiles

Transfer template files to the printer.

transferDatabaseFiles

Transfer database files to the printer.

transferBinaryFiles

Transfer binary files to the printer.

transferBinaryData

Transfer binary data to the printer.

transferPrinterConfigurationFiles

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.

Channel

newWifiChannel

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

newBluetoothChannel

Create this class with a MAC address of your printer to connect through Bluetooth.

newBluetoothLowEnergyChannel

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

newUsbChannel

Create this class to connect through a USB connection.

ChannelCredential

printerAdminPassword

Create this class with the administrator password of your printer.

PrinterDriverGenerator

openChannel

Return PrinterDriverGenerateResult object that contains a result of the initialization and PrinterDriver instance if the result is NoError.

openChannelWithCredential

Return PrinterDriverGenerateResult object that contains a result of the initialization and PrinterDriver instance if the result is NoError.

PrinterSearcher

startNetworkSearch

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 printers paired to the mobile device.

startBLESearch

Begins searching printers which support Bluetooth Low Energy.

cancelBLESearch

Cancel searching for compatible printers which support Bluetooth Low Energy.

startUSBSearch

Get the printer connected to the mobile device via USB.

NetworkSearchOption

Initialize this class with searchDuration.

BLESearchOption

Initialize this class with searchDuration.

MediaInfo

getPTLabelSize

Get the size of label. If the type of media is not for PT series, it returns null.

getQLLabelSize

Get the size of label. If the type of media is not for QL series, it returns null.

PrinterModelSpec

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

PJPrintSettings

Initialize this class with your printer model.

copyPrintSettings

Create a new instance with new printer model.

RJPrintSettings

Initialize this class with your printer model.

copyPrintSettings

Create a new instance with new printer model.

TDPrintSettings

Initialize this class with your printer model.

copyPrintSettings

Create a new instance with new printer model.

PTPrintSettings

Initialize this class with your printer model.

copyPrintSettings

Create a new instance with a new printer model.

QLPrintSettings

Initialize this class with your printer model.

copyPrintSettings

Create a new instance with new printer model.

MWPrintSettings

Initialize this class with your printer model.

copyPrintSettings

Create a new instance with new printer model.

TemplateObjectReplacer

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

TemplateObjectReplacer

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

PJTemplatePrintSettings

PJPrintSettings

Initialize this class with your printer model.

copyPrintSettings

Create a new instance with new printer model.

RJTemplatePrintSettings

PJPrintSettings

Initialize this class with your printer model.

copyPrintSettings

Create a new instance with new printer model.

TDTemplatePrintSettings

PJPrintSettings

Initialize this class with your printer model.

copyPrintSettings

Create a new instance with new printer model.

PTTemplatePrintSettings

PTPrintSettings

Initialize this class with your printer model.

copyPrintSettings

Create a new instance with new printer model.

QLTemplatePrintSettings

QLPrintSettings

Initialize this class with your printer model.

copyPrintSettings

Create a new instance with new printer model.

MWTemplatePrintSettings

MWPrintSettings

Initialize this class with your printer model.

copyPrintSettings

Create a new instance with new printer model.

CustomPaperSize

newRollPaperSize

Initialize this object with parameters of a roll paper size.

newDieCutPaperSize

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

newMarkRollPaperSize

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

newFile

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

PJCustomPaperSize

PJPaperSize

newPaperSize

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

newCustomPaper

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

ValidatePrintSettings

validate

ValidatePrintSettingsReport

description

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

ValidatePrintSettingsIssue

description

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

FileAnalyzer

analyzePD3

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

FileConverter

convertPDZtoPD3

Converts a list of PDZ files to PD3 files and returns the result, including file paths, error codes, and logs. If the input files are not PDZ files, the function does not perform any conversion and returns the input file paths as they are.