Supported API List
The table below shows whether each API is supported in StarPRNT SDK and StarXpand SDK.
Check which SDK supports the APIs you are using.
Check which SDK supports the APIs you are using.
| Process | StarPRNT SDK | StarXpand SDK | Migration Guide | ||
|---|---|---|---|---|---|
| Class | Method | Class | Method | ||
| Printer search/connection | |||||
| Start search | SMPort | searchPrinter | StarDeviceDiscoveryManagerFactory | create | Search for Printer |
| - | - | StarDeviceDiscoveryManager | startDiscovery | ||
| Stop search | - | - | StarDeviceDiscoveryManager | stopDiscovery | |
| Search results | - | - | StarDeviceDiscoveryManagerDelegate | - | |
| Connect | SMPort | getPort | StarPrinter | open | Send Printing Data |
| Disconnect | SMPort | releasePort | StarPrinter | close | |
| Transmit commands + verify print completion | SMPort | beginCheckedBlock | StarPrinter | ||
| SMPort | endCheckedBlock | ||||
| Transmit commands (without verifying print completion) | SMPort | writePort | StarPrinter | write | |
| Receive printer responses | SMPort | readPort | StarPrinter | read | |
| Disconnect Bluetooth | SMPort | disconnect | - | - | |
| Retrieve the printer status | SMPort | getParsedStatus | StarPrinter | getStatus | |
| Retrieve the printer information | SMPort | getParsedStatus | StarPrinter | information | |
| Bluetooth settings | SMBluetoothManager | - | - | - | - |
| Network settings | SMNetworkManager | - | - | - | - |
| Output logs | SMLogger | - | StarIO10Logger | - | - |
| Status monitoring | |||||
| Start monitoring the status | StarIoExtManager | connect | StarPrinter | open | Monitor Printer Status |
| StarIoExtManager | connectAsync | ||||
| Stop monitoring the status | StarIoExtManager | disconnect | StarPrinter | close | |
| Printer notification (Delegate) | |||||
| Notify that a printer communication error has occurred | StarIoExtManagerDelegate | didPrinterImpossible | PrinterDelegate | printer(_:communicationErrorDidOccur:) | Monitor Printer Status |
| Notify that printing is available | StarIoExtManagerDelegate | didPrinterOnline | PrinterDelegate | printerIsReady | |
| Notify that a printer error has occurred | StarIoExtManagerDelegate | didPrinterOffline | PrinterDelegate | printerDidHaveError | |
| Notify that printer paper has been prepared | StarIoExtManagerDelegate | didPrinterPaperReady | PrinterDelegate | printerPaperReady | |
| Notify that the paper is low | StarIoExtManagerDelegate | didPrinterPaperNearEmpty | PrinterDelegate | printerPaperNearEmpty | |
| Notify that the printer has run out of paper | StarIoExtManagerDelegate | didPrinterPaperEmpty | PrinterDelegate | printerPaperEmpty | |
| Notify that the printer cover has been opened | StarIoExtManagerDelegate | didPrinterCoverOpen | PrinterDelegate | printerCoverOpen | |
| Notify that the printer cover has been closed | StarIoExtManagerDelegate | didPrinterCoverClose | PrinterDelegate | printerCoverClose | |
| Notify that the cash drawer has been opened | StarIoExtManagerDelegate | didCashDrawerOpen | DrawerDelegate | drawer(printer:didSwitch:) | Use Cash Drawer |
| Notify that the cash drawer has been closed | StarIoExtManagerDelegate | didCashDrawerClose | DrawerDelegate | drawer(printer:didSwitch:) | |
| Notify that a cash drawer communication error has occurred | - | - | DrawerDelegate | drawer(printer:communicationErrorDidOccur:) | |
| Notify that a barcode reader communication error has occurred | StarIoExtManagerDelegate | didBarcodeReaderImpossible | InputDeviceDelegate | - | Use Barcode Reader |
| Notify that a barcode reader has been connected | StarIoExtManagerDelegate | didBarcodeReaderConnect | InputDeviceDelegate | inputDeviceDidConnect | |
| Notify that a barcode reader has been disconnected | StarIoExtManagerDelegate | didBarcodeReaderDisconnect | InputDeviceDelegate | inputDeviceDidDisconnect | |
| Notify that barcode data has been received | StarIoExtManagerDelegate | didBarcodeDataReceive | InputDeviceDelegate | inputDevice(printer:didReceive:) | |
| Notify that the accessory connection has succeeded | StarIoExtManagerDelegate | didAccessoryConnectSuccess | - | - | - |
| Notify that the accessory connection has failed | StarIoExtManagerDelegate | didAccessoryConnectFailure | - | - | - |
| Notify that the accessory has been disconnected | StarIoExtManagerDelegate | didAccessoryDisconnect | - | - | - |
| Notify that the status has been updated | StarIoExtManagerDelegate | didStatusUpdate | - | - | - |
| Notify that a customer display communication error has occurred | - | - | DisplayDelegate | display(printer:communicationErrorDidOccur:) | Use Customer Display |
| Notify that a customer display has been connected | - | - | DisplayDelegate | displayDidConnect | |
| Notify that a customer display has been disconnected | - | - | DisplayDelegate | displayDidDisconnect | |
| Printer status (StarPrinterStatus / StarPrinterStatusDetail) | |||||
| Paper separator error occurrence status | StarPrinterStatus | paperDetectionError | StarPrinterStatusDetail | paperSeparatorError | - |
| State of the open/close signal for the cash drawer | StarPrinterStatus | compulsionSwitch | StarPrinterStatus | drawerOpenCloseSignal | - |
| Cover open status | StarPrinterStatus | coverOpen | StarPrinterStatus | coverOpen | - |
| Auto cutter error occurrence status | StarPrinterStatus | cutterError | StarPrinterStatusDetail | cutterError | - |
| ETB availability | StarPrinterStatus | etbAvailable | - | - | - |
| ETB counter | StarPrinterStatus | etbCounter | - | - | - |
| Head thermistor error | StarPrinterStatus | headThermistorError | - | - | - |
| Error occurrence status | StarPrinterStatus | offline | StarPrinterStatus | hasError | - |
| Overheat status | StarPrinterStatus | overTemp | - | - | - |
| Paper jamming error occurrence status | StarPrinterStatus | jamError | StarPrinterStatusDetail | paperJamError | - |
| Status byte string | StarPrinterStatus | raw | - | - | - |
| Raw length | StarPrinterStatus | rawLength | - | - | - |
| Paper position error occurrence status | StarPrinterStatus | rollPositionError | StarPrinterStatusDetail | rollPositionError | - |
| Out-of-paper status | StarPrinterStatus | receiptPaperEmpty | StarPrinterStatus | paperEmpty | - |
| Paper-low status | StarPrinterStatus | receiptPaperNearEmptyInner | StarPrinterStatus | paperNearEmpty | - |
| Receive buffer overflow | StarPrinterStatus | receiveBufferOverflow | - | - | - |
| Unrecoverable error | StarPrinterStatus | unrecoverableError | - | - | - |
| Supply voltage error | StarPrinterStatus | voltageError | - | - | - |
| Type of interface that is currently connected | StarPrinterStatus | connectedInterface | - | - | - |
| Hold print status | StarPrinterStatus | paperPresent | StarPrinterStatusDetail | paperPresent | - |
| Cause of cash drawer 1 opening | StarPrinterStatus | drawer1OpenedMethod | StarPrinterStatusDetail | drawer1OpenedMethod | - |
| Open/close status of cash drawer 1 | StarPrinterStatus | drawer1OpenCloseSignal | StarPrinterStatusDetail | drawer1OpenCloseSignal | - |
| Cause of cash drawer 2 opening | StarPrinterStatus | drawer2OpenedMethod | StarPrinterStatusDetail | drawer2OpenedMethod | - |
| Open/close status of cash drawer 2 | StarPrinterStatus | drawer2OpenCloseSignal | StarPrinterStatusDetail | drawer2OpenCloseSignal | - |
| Connection status of external device channel 1 | StarPrinterStatus | externalDevice1Connected | StarPrinterStatusDetail | externalDevice1Connected | - |
| Connection status of external device channel 2 | StarPrinterStatus | externalDevice2Connected | StarPrinterStatusDetail | externalDevice2Connected | - |
| Cash drawer open error occurrence status | - | - | StarPrinterStatusDetail | drawerOpenError | - |
| Printer unit open/close status | - | - | StarPrinterStatusDetail | printUnitOpen | - |
| Parts replacement notification status | StarPrinterStatus | partsReplacementNotification | StarPrinterStatusDetail | partsReplacementNotification | - |
| Cleaning notification status | StarPrinterStatus | cleaningNotification | StarPrinterStatusDetail | cleaningNotification | - |
| Detected paper width | StarPrinterStatus | detectedPaperWidth | StarPrinterStatusDetail | detectedPaperWidth | - |
| Command builder (printer) | |||||
| Add document | ISCBBuilder | beginDocument | StarXpandCommandBuilder | addDocument | Generate Printing Data |
| End document | ISCBBuilder | endDocument | - | - | |
| Generate an initialization command | ISCBBuilder | appendInitialization | PrinterBuilder | actionInitialize | |
| Print text | ISCBBuilder | appendData | PrinterBuilder | actionPrintText | |
| Add raw data | ISCBBuilder | appendRaw | DocumentBuilder | addRaw | |
| Set the font | ISCBBuilder | appendFontStyle | PrinterBuilder | styleFont | |
| Set the width type for UTF-8 1-byte/2-byte fuzzy character printing | - | - | PrinterBuilder | styleAmbiguousCharacterWidthType | |
| Set international characters | ISCBBuilder | appendCodePage | PrinterBuilder | styleInternationalCharacter | |
| ISCBBuilder | appendInternational | ||||
| Set the secondary character encoding | - | - | PrinterBuilder | styleSecondPriorityCharacterEncoding | |
| Set the priority of CJK unified ideographs | ISCBBuilder | appendCjkUnifiedIdeographFont | PrinterBuilder | styleCJKCharacterPriority | |
| Execute paper feeding (line) | ISCBBuilder | appendLineFeed | PrinterBuilder | actionFeedLine | |
| Execute paper feeding (distance) | ISCBBuilder | appendUnitFeed | PrinterBuilder | actionFeed | |
| Execute paper feeding (per gap) | - | - | PrinterBuilder | actionSeparatorFeed | |
| Set the character spacing | ISCBBuilder | appendCharacterSpace | PrinterBuilder | styleCharacterSpace | |
| Set the line spacing | ISCBBuilder | appendLineSpace | PrinterBuilder | styleLineSpace | |
| Set the top margin | ISCBBuilder | appendTopMargin | DocumentBuilder | settingTopMargin | |
| Set in bold | ISCBBuilder | appendEmphasis | PrinterBuilder | styleBold | |
| Set black and white inversion | ISCBBuilder | appendInvert | PrinterBuilder | styleInvert | |
| Set the basic print size | - | - | PrinterBuilder | styleBaseMagnification | |
| Set the magnification | ISCBBuilder | appendMultiple | PrinterBuilder | styleMagnification | |
| Set the underline | ISCBBuilder | appendUnderLine | PrinterBuilder | styleUnderLine | |
| Execute logo printing | ISCBBuilder | appendLogo | PrinterBuilder | actionPrintLogo | |
| Set the horizontal absolute position | ISCBBuilder | appendAbsolutePosition | PrinterBuilder | styleHorizontalPositionTo | |
| Set the horizontal relative position | - | - | PrinterBuilder | styleHorizontalPositionBy | |
| Set the alignment | ISCBBuilder | appendAlignment | PrinterBuilder | styleAlignment | |
| Set the horizontal tab | ISCBBuilder | appendHorizontalTabPosition | PrinterBuilder | styleHorizontalTabPositions | |
| Execute paper cutting | ISCBBuilder | appendCutPaper | PrinterBuilder | actionCut | |
| Execute barcode printing | ISCBBuilder | appendBarcode | PrinterBuilder | actionPrintBarcode | |
| ISCBBuilder | appendBarcodeWithAbsolutePosition | ||||
| ISCBBuilder | appendBarcodeWithAlignment | ||||
| Execute PDF417 printing | ISCBBuilder | appendPdf417 | PrinterBuilder | actionPrintPDF417 | |
| ISCBBuilder | appendPdf417WithAbsolutePosition | ||||
| ISCBBuilder | appendPdf417WithAlignment | ||||
| Execute QR code printing | ISCBBuilder | appendQrCode | PrinterBuilder | actionPrintQRCode | |
| ISCBBuilder | appendQrCodeWithAbsolutePosition | ||||
| ISCBBuilder | appendQrCodeWithAlignment | ||||
| Execute image printing | ISCBBuilder | appendBitmap | PrinterBuilder | actionPrintImage | |
| ISCBBuilder | appendBitmapWithAbsolutePosition | ||||
| ISCBBuilder | appendBitmapWithAlignment | ||||
| Execute border printing | - | - | PrinterBuilder | actionPrintRuledLine | |
| Set black mark detection | ISCBBuilder | appendBlackMark | DocumentBuilder | settingBlackMark | |
| Set gap detection for die cut label paper | ISCBBuilder | appendLabel | DocumentBuilder | settingLabel | |
| Add page mode | ISCBBuilder | beginPageMode | PrinterBuilder | addPageMode | |
| ISCBBuilder | endPageMode | - | - | ||
| Set the vertical relative position | ISCBBuilder | appendPageModeVerticalAbsolutePosition | PageModeBuilder | styleVerticalPositionBy | |
| Set the printing direction | ISCBBuilder | appendPageModeRotation | PageModeBuilder | stylePrintDirection | |
| Set the printing area | ISCBBuilder | appendPrintableArea | DocumentBuilder | settingPrintableArea | |
| Set hold print control | ISCBBuilder | appendHoldPrint | DocumentBuilder | settingHoldPrint | |
| ISCBBuilder | appendPaperPresentStatus | - | - | ||
| Get commands | ISCBBuilder | getCommands | StarXpandCommandBuilder | getCommands | |
| Cash drawer | |||||
| Execute cash drawer opening | ISCBBuilder | appendPeripheral | DrawerBuilder | actionOpen | Generate Printing Data |
| Buzzer | |||||
| Execute buzzer drive | - | - | BuzzerBuilder | actionDrive | Generate Printing Data |
| Melody speaker | |||||
| Execute registered sound playback | ISCBBuilder | appendSoundWithSetting | MelodySpeakerBuilder | actionDriveRegisteredSound | Generate Printing Data |
| Execute received data playback | ISMCBBuilder | appendSoundWithSound | MelodySpeakerBuilder | actionDriveOneTimeSound | |
| Get commands | ISMCBBuilder | getCommands | StarXpandCommandBuilder | getCommands | |
| Customer display | |||||
| Execute text display | ISDCBBuilder | append | DisplayBuilder | actionShowText | Generate Printing Data |
| Backspace | ISDCBBuilder | appendBackSpace | - | - | |
| Set the horizontal tab | ISDCBBuilder | appendHorizontalTab | - | - | |
| Line feed | ISDCBBuilder | appendLineFeed | - | - | |
| Carriage return | ISDCBBuilder | appendCarriageReturn | - | - | |
| Execute image display | ISDCBBuilder | appendBitmap | DisplayBuilder | actionShowImage | |
| Set international characters | ISDCBBuilder | appendInternational | DisplayBuilder | styleInternationalCharacter | |
| Set the character encoding | ISDCBBuilder | appendCodePage | DisplayBuilder | styleCharacterEncoding | |
| Clear the screen to the end of the line | ISDCBBuilder | appendDeleteToEndOfLine | - | - | |
| Clear the current line | - | - | DisplayBuilder | actionClearLine | |
| Clear all | ISDCBBuilder | appendClearScreen | DisplayBuilder | actionClearAll | |
| Set the cursor position | ISDCBBuilder | appendHomePosition | DisplayBuilder | styleCursorPositionTo | |
| ISDCBBuilder | appendTurnOn | DisplayBuilder | actionSetBackLightState | ||
| Set the back light status | ISDCBBuilder | appendSpecifiedPosition | DisplayBuilder | styleCursorPositionTo | |
| ISDCBBuilder | appendCursorMode | DisplayBuilder | actionSetCursorState | ||
| Set the contrast value | ISDCBBuilder | appendContrastMode | DisplayBuilder | actionSetContrast | |
| ISDCBBuilder | appendUserDefinedDbcsCharacter | - | - | ||
| Get commands | ISDCBBuilder | getCommands | - | - | |
| ISDCBBuilder | getPassThroughCommands | StarXpandCommandBuilder | getCommands | ||
The table below shows whether each API is supported in StarPRNT SDK and StarXpand SDK.
Check which SDK supports the APIs you are using.
Check which SDK supports the APIs you are using.
| Process | StarPRNT SDK | StarXpand SDK | Migration Guide | ||
|---|---|---|---|---|---|
| Class | Method | Class | Method | ||
| Printer search/connection | |||||
| Start search | StarIOPort | searchPrinter | StarDeviceDiscoveryManagerFactory | create | Search for Printer |
| - | - | StarDeviceDiscoveryManager | startDiscovery | ||
| Stop search | - | - | StarDeviceDiscoveryManager | stopDiscovery | |
| Search results | - | - | StarDeviceDiscoveryManager.Callback | - | |
| Connect | StarIOPort | getPort | StarPrinter | openAsync | Send Printing Data |
| Disconnect | StarIOPort | releasePort | StarPrinter | closeAsync | |
| Transmit commands + verify print completion | StarIOPort | beginCheckedBlock | StarPrinter | printAsync | |
| StarIOPort | endCheckedBlock | ||||
| Transmit commands (without verifying print completion) | StarIOPort | writePort | StarPrinter | write | |
| Receive printer responses | StarIOPort | readPort | StarPrinter | read | |
| Disconnect Bluetooth | StarIOPort | disconnect | - | - | |
| Retrieve the printer status | StarIOPort | getParsedStatus | StarPrinter | getStatusAsync | |
| Retrieve the printer information | StarIOPort | getParsedStatus | StarPrinter | information | |
| Bluetooth settings | StarBluetoothManager | - | - | - | |
| Network settings | StarNetworkManager | - | - | - | |
| Output logs | - | - | StarIO10Logger | - | |
| Status monitoring | |||||
| Start monitoring the status | StarIoExtManager | connect | StarPrinter | openAsync | Monitor Printer Status |
| StarIoExtManager | connectAsync | ||||
| Stop monitoring the status | StarIoExtManager | disconnect | StarPrinter | closeAsync | |
| Printer notification (Delegate) | |||||
| Notify that a printer communication error has occurred | IStarIoExtManagerListener | onPrinterImpossible | PrinterDelegate | onCommunicationError | Monitor Printer Status |
| Notify that printing is available | IStarIoExtManagerListener | onPrinterOnline | PrinterDelegate | onReady | |
| Notify that a printer error has occurred | IStarIoExtManagerListener | onPrinterOffline | PrinterDelegate | onError | |
| Notify that printer paper has been prepared | IStarIoExtManagerListener | onPrinterPaperReady | PrinterDelegate | onPaperReady | |
| Notify that the paper is low | IStarIoExtManagerListener | onPrinterPaperNearEmpty | PrinterDelegate | onPaperNearEmpty | |
| Notify that the printer has run out of paper | IStarIoExtManagerListener | onPrinterPaperEmpty | PrinterDelegate | onPaperEmpty | |
| Notify that the printer cover has been opened | IStarIoExtManagerListener | onPrinterCoverOpen | PrinterDelegate | onCoverOpened | |
| Notify that the printer cover has been closed | IStarIoExtManagerListener | onPrinterCoverClose | PrinterDelegate | onCoverClosed | |
| Notify that a cash drawer communication error has occurred | - | - | DrawerDelegate | onCommunicationError | Use Cash Drawer |
| Notify that the cash drawer has been opened | IStarIoExtManagerListener | onCashDrawerOpen | DrawerDelegate | onOpenCloseSignalSwitched | |
| Notify that the cash drawer has been closed | IStarIoExtManagerListener | onCashDrawerClose | DrawerDelegate | onOpenCloseSignalSwitched | |
| Notify that a barcode reader communication error has occurred | IStarIoExtManagerListener | onBarcodeReaderImpossible | InputDeviceDelegate | onCommunicationError | Use Barcode Reader |
| Notify that a barcode reader has been connected | IStarIoExtManagerListener | onBarcodeReaderConnect | InputDeviceDelegate | onConnected | |
| Notify that a barcode reader has been disconnected | IStarIoExtManagerListener | onBarcodeReaderDisconnect | InputDeviceDelegate | onDisconnected | |
| Notify that barcode data has been received | IStarIoExtManagerListener | onBarcodeDataReceive | InputDeviceDelegate | onDataReceived | |
| Notify that the accessory connection has succeeded | IStarIoExtManagerListener | onAccessoryConnectSuccess | - | - | - |
| Notify that the accessory connection has failed | IStarIoExtManagerListener | onAccessoryConnectFailure | - | - | - |
| Notify that the accessory has been disconnected | IStarIoExtManagerListener | onAccessoryDisconnect | - | - | - |
| Notify that the status has been updated | IStarIoExtManagerListener | onStatusUpdate | - | - | - |
| Notify that a customer display communication error has occurred | - | - | DisplayDelegate | onCommunicationError | Use Customer Display |
| Notify that a customer display has been connected | - | - | DisplayDelegate | onConnected | |
| Notify that a customer display has been disconnected | - | - | DisplayDelegate | onDisconnected | |
| Printer status (StarPrinterStatus / StarPrinterStatusDetail) | |||||
| Paper separator error occurrence status | StarPrinterStatus | paperDetectionError | StarPrinterStatusDetail | paperSeparatorError | - |
| State of the open/close signal for the cash drawer | StarPrinterStatus | compulsionSwitch | StarPrinterStatus | drawerOpenCloseSignal | - |
| Cover open status | StarPrinterStatus | coverOpen | StarPrinterStatus | coverOpen | - |
| Auto cutter error occurrence status | StarPrinterStatus | cutterError | StarPrinterStatusDetail | cutterError | - |
| ETB availability | StarPrinterStatus | etbAvailable | - | - | - |
| ETB counter | StarPrinterStatus | etbCounter | - | - | - |
| Head thermistor error | StarPrinterStatus | headThermistorError | - | - | - |
| Error occurrence status | StarPrinterStatus | offline | StarPrinterStatus | hasError | - |
| Overheat status | StarPrinterStatus | overTemp | - | - | - |
| Paper jamming error occurrence status | StarPrinterStatus | jamError | StarPrinterStatusDetail | paperJamError | - |
| Status byte string | StarPrinterStatus | raw | - | - | - |
| Raw length | StarPrinterStatus | rawLength | - | - | - |
| Paper position error occurrence status | StarPrinterStatus | rollPositionError | StarPrinterStatusDetail | rollPositionError | - |
| Out-of-paper status | StarPrinterStatus | receiptPaperEmpty | StarPrinterStatus | paperEmpty | - |
| Paper-low status | StarPrinterStatus | receiptPaperNearEmptyInner | StarPrinterStatus | paperNearEmpty | - |
| Receive buffer overflow | StarPrinterStatus | receiveBufferOverflow | - | - | - |
| Unrecoverable error | StarPrinterStatus | unrecoverableError | - | - | - |
| Supply voltage error | StarPrinterStatus | voltageError | - | - | - |
| Type of interface that is currently connected | StarPrinterStatus | connectedInterface | - | - | - |
| Hold print status | StarPrinterStatus | paperPresent | StarPrinterStatusDetail | paperPresent | - |
| Cause of cash drawer 1 opening | StarPrinterStatus | drawer1OpenedMethod | StarPrinterStatusDetail | drawer1OpenedMethod | - |
| Open/close status of cash drawer 1 | StarPrinterStatus | drawer1OpenCloseSignal | StarPrinterStatusDetail | drawer1OpenCloseSignal | - |
| Cause of cash drawer 2 opening | StarPrinterStatus | drawer2OpenedMethod | StarPrinterStatusDetail | drawer2OpenedMethod | - |
| Open/close status of cash drawer 2 | StarPrinterStatus | drawer2OpenCloseSignal | StarPrinterStatusDetail | drawer2OpenCloseSignal | - |
| Connection status of external device channel 1 | StarPrinterStatus | externalDevice1Connected | StarPrinterStatusDetail | externalDevice1Connected | - |
| Connection status of external device channel 2 | StarPrinterStatus | externalDevice2Connected | StarPrinterStatusDetail | externalDevice2Connected | - |
| Cash drawer open error occurrence status | - | - | StarPrinterStatusDetail | drawerOpenError | - |
| Printer unit open/close status | - | - | StarPrinterStatusDetail | printUnitOpen | - |
| Parts replacement notification status | StarPrinterStatus | partsReplacementNotification | StarPrinterStatusDetail | partsReplacementNotification | - |
| Cleaning notification status | StarPrinterStatus | cleaningNotification | StarPrinterStatusDetail | cleaningNotification | - |
| Detected paper width | StarPrinterStatus | detectedPaperWidth | StarPrinterStatusDetail | detectedPaperWidth | - |
| Command builder (printer) | |||||
| Add document | ICommandBuilder | beginDocument | StarXpandCommandBuilder | addDocument | Generate Printing Data |
| End document | ICommandBuilder | endDocument | - | - | |
| Generate an initialization command | ICommandBuilder | appendInitialization | PrinterBuilder | actionInitialize | |
| Print text | ICommandBuilder | appendData | PrinterBuilder | actionPrintText | |
| Add raw data | ICommandBuilder | appendRaw | DocumentBuilder | addRaw | |
| Set the font | ICommandBuilder | appendFontStyle | PrinterBuilder | styleFont | |
| Set the width type for UTF-8 1-byte/2-byte fuzzy character printing | - | - | PrinterBuilder | styleAmbiguousCharacterWidthType | |
| Set international characters | ICommandBuilder | appendCodePage | PrinterBuilder | styleInternationalCharacter | |
| ICommandBuilder | appendInternational | ||||
| Set the secondary character encoding | - | - | PrinterBuilder | styleSecondPriorityCharacterEncoding | |
| Set the priority of CJK unified ideographs | ICommandBuilder | appendCjkUnifiedIdeographFont | PrinterBuilder | styleCJKCharacterPriority | |
| Execute paper feeding (line) | ICommandBuilder | appendLineFeed | PrinterBuilder | actionFeedLine | |
| Execute paper feeding (distance) | ICommandBuilder | appendUnitFeed | PrinterBuilder | actionFeed | |
| Execute paper feeding (per gap on black mark or die cut label paper) | - | - | PrinterBuilder | actionSeparatorFeed | |
| Set the character spacing | ICommandBuilder | appendCharacterSpace | PrinterBuilder | styleCharacterSpace | |
| Set the line spacing | ICommandBuilder | appendLineSpace | PrinterBuilder | styleLineSpace | |
| Set the top margin | ICommandBuilder | appendTopMargin | DocumentBuilder | settingTopMargin | |
| Set in bold | ICommandBuilder | appendEmphasis | PrinterBuilder | styleBold | |
| Set black and white inversion | ICommandBuilder | appendInvert | PrinterBuilder | styleInvert | |
| Set the basic print size | - | - | PrinterBuilder | styleBaseMagnification | |
| Set the magnification | ICommandBuilder | appendMultiple | PrinterBuilder | styleMagnification | |
| Set the underline | ICommandBuilder | appendUnderLine | PrinterBuilder | styleUnderLine | |
| Execute logo printing | ICommandBuilder | appendLogo | PrinterBuilder | actionPrintLogo | |
| Set the horizontal absolute position | ICommandBuilder | appendAbsolutePosition | PrinterBuilder | styleHorizontalPositionTo | |
| Set the horizontal relative position | - | - | PrinterBuilder | styleHorizontalPositionBy | |
| Set the alignment | ICommandBuilder | appendAlignment | PrinterBuilder | styleAlignment | |
| Set the horizontal tab | ICommandBuilder | appendHorizontalTabPosition | PrinterBuilder | styleHorizontalTabPositions | |
| Execute paper cutting | ICommandBuilder | appendCutPaper | PrinterBuilder | actionCut | |
| Execute barcode printing | ICommandBuilder | appendBarcode | PrinterBuilder | actionPrintBarcode | |
| ICommandBuilder | appendBarcodeWithAbsolutePosition | ||||
| ICommandBuilder | appendBarcodeWithAlignment | ||||
| Execute PDF417 printing | ICommandBuilder | appendPdf417 | PrinterBuilder | actionPrintPDF417 | |
| ICommandBuilder | appendPdf417WithAbsolutePosition | ||||
| ICommandBuilder | appendPdf417WithAlignment | ||||
| Execute QR code printing | ICommandBuilder | appendQrCode | PrinterBuilder | actionPrintQRCode | |
| ICommandBuilder | appendQrCodeWithAbsolutePosition | ||||
| ICommandBuilder | appendQrCodeWithAlignment | ||||
| Execute image printing | ICommandBuilder | appendBitmap | PrinterBuilder | actionPrintImage | |
| ICommandBuilder | appendBitmapWithAbsolutePosition | ||||
| ICommandBuilder | appendBitmapWithAlignment | ||||
| Execute border printing | - | - | PrinterBuilder | actionPrintRuledLine | |
| Set black mark detection | ICommandBuilder | appendBlackMark | DocumentBuilder | settingBlackMark | |
| Set gap detection for die cut label paper | ICommandBuilder | appendLabel | DocumentBuilder | settingLabel | |
| Add page mode | ICommandBuilder | beginPageMode | PrinterBuilder | addPageMode | |
| ICommandBuilder | endPageMode | - | - | ||
| Set the vertical relative position | ICommandBuilder | appendPageModeVerticalAbsolutePosition | PageModeBuilder | styleVerticalPositionBy | |
| Set the printing direction | ICommandBuilder | appendPageModeRotation | PageModeBuilder | stylePrintDirection | |
| Set the printing area | ICommandBuilder | appendPrintableArea | DocumentBuilder | settingPrintableArea | |
| Set hold print control | ICommandBuilder | appendHoldPrint | DocumentBuilder | settingHoldPrint | |
| ICommandBuilder | appendPaperPresentStatus | - | - | ||
| Get commands | ICommandBuilder | getCommands | StarXpandCommandBuilder | getCommands | |
| Cash drawer | |||||
| Execute cash drawer opening | ICommandBuilder | appendPeripheral | DrawerBuilder | actionOpen | Generate Printing Data |
| Buzzer | |||||
| Execute buzzer drive | - | - | BuzzerBuilder | actionDrive | Generate Printing Data |
| Melody speaker | |||||
| Execute registered sound playback | IMelodySpeakerCommandBuilder | appendSound | MelodySpeakerBuilder | actionDriveRegisteredSound | Generate Printing Data |
| Execute received data playback | IMelodySpeakerCommandBuilder | appendSoundData | MelodySpeakerBuilder | actionDriveOneTimeSound | |
| Get commands | IMelodySpeakerCommandBuilder | getCommands | StarXpandCommandBuilder | getCommands | |
| Customer display | |||||
| Execute text display | IDisplayCommandBuilder | append | DisplayBuilder | actionShowText | Generate Printing Data |
| Backspace | IDisplayCommandBuilder | appendBackSpace | - | - | |
| Set the horizontal tab | IDisplayCommandBuilder | appendHorizontalTab | - | - | |
| Line feed | IDisplayCommandBuilder | appendLineFeed | - | - | |
| Carriage return | IDisplayCommandBuilder | appendCarriageReturn | - | - | |
| Execute image display | IDisplayCommandBuilder | appendBitmap | DisplayBuilder | actionShowImage | |
| Set international characters | IDisplayCommandBuilder | appendInternational | DisplayBuilder | styleInternationalCharacter | |
| Set the character encoding | IDisplayCommandBuilder | appendCodePage | DisplayBuilder | styleCharacterEncoding | |
| Clear the screen to the end of the line | IDisplayCommandBuilder | appendDeleteToEndOfLine | - | - | |
| Clear the current line | - | - | DisplayBuilder | actionClearLine | |
| Clear all | IDisplayCommandBuilder | appendClearScreen | DisplayBuilder | actionClearAll | |
| Set the cursor position | IDisplayCommandBuilder | appendHomePosition | DisplayBuilder | styleCursorPositionTo | |
| IDisplayCommandBuilder | appendTurnOn | DisplayBuilder | actionSetBackLightState | ||
| Set the back light status | IDisplayCommandBuilder | appendSpecifiedPosition | DisplayBuilder | styleCursorPositionTo | |
| IDisplayCommandBuilder | appendCursorMode | DisplayBuilder | actionSetCursorState | ||
| Set the contrast value | IDisplayCommandBuilder | appendContrastMode | DisplayBuilder | actionSetContrast | |
| IDisplayCommandBuilder | appendUserDefinedDbcsCharacter | - | - | ||
| Get commands | IDisplayCommandBuilder | getCommands | - | - | |
| IDisplayCommandBuilder | getPassThroughCommands | StarXpandCommandBuilder | getCommands | ||
| Presenter | |||||
| Set the operation | IPresenterCommandBuilder | appendOperation | PresenterSettingBuilder | settingMode | Generate Printing Data |
| Initialize the paper counter | IPresenterCommandBuilder | appendClearPaperCounter | - | - | |
| Set the LED lighting function | ILedCommandBuilder | - | PresenterSettingBuilder | settingLedAutomaticBlink | |
| Bezel | |||||
| Set the automatic page length function | IBezelCommandBuilder | appendAutomaticPageLength | BezelSettingBuilder | settingAutomaticPageLength | Generate Printing Data |
| Set the LED lighting function | ILedCommandBuilder | - | BezelSettingBuilder | settingLedAutomaticBlink | |

