addSound

Adds buzzer sound setting to the command buffer.

Sets the buzzer.

Syntax

	- (int) addSound:(int)pattern repeat:(long)repeat cycle:(long)cycle;

Parameter

pattern

Specifies the buzzer tone.

Value	Description
EPOS2_PATTERN_NONE	Stop (Mobile models)
EPOS2_PATTERN_NONE	Stop. However, the buzzer already sounding does not stop. (Except for Mobile models)
EPOS2_PATTERN_A	Pattern A (optional external buzzer)
EPOS2_PATTERN_B	Pattern B (optional external buzzer)
EPOS2_PATTERN_C	Pattern C (optional external buzzer)
EPOS2_PATTERN_D	Pattern D (optional external buzzer)
EPOS2_PATTERN_E	Pattern E (optional external buzzer)
EPOS2_PATTERN_ERROR	Error sound pattern (optional external buzzer)
EPOS2_PATTERN_PAPER_EMPTY	Paper empty sound pattern (optional external buzzer)
EPOS2_PATTERN_1	Pattern 1 (built-in buzzer)
EPOS2_PATTERN_2	Pattern 2 (built-in buzzer)
EPOS2_PATTERN_3	Pattern 3 (built-in buzzer)
EPOS2_PATTERN_4	Pattern 4 (built-in buzzer)
EPOS2_PATTERN_5	Pattern 5 (built-in buzzer)
EPOS2_PATTERN_6	Pattern 6 (built-in buzzer)
EPOS2_PATTERN_7	Pattern 7 (built-in buzzer)
EPOS2_PATTERN_8	Pattern 8 (built-in buzzer)
EPOS2_PATTERN_9	Pattern 9 (built-in buzzer)
EPOS2_PATTERN_10	Pattern 10 (built-in buzzer)
EPOS2_PARAM_DEFAULT	Specifies the default (Pattern A).

repeat

Specifies the repeat count.

Value	Description
0	Unlimited
1 to 255	1 to 255 times
EPOS2_PARAM_DEFAULT	Specifies the default (once).

cycle

Specifies the buzzer sound interval (in milliseconds).

Value	Description
1000 to 25500	1000 to 25500 milliseconds
EPOS2_PARAM_DEFAULT	Specifies the default (1000 milliseconds).

Effective for Patterns 1 to 10 only.

Return value

Error status	Description
EPOS2_SUCCESS	The function was executed successfully.
EPOS2_ERR_PARAM	An invalid parameter was passed.
EPOS2_ERR_MEMORY	Memory necessary for processing could not be allocated.
EPOS2_ERR_FAILURE	An unknown error occurred.

Supplementary explanation

This API cannot be used in the page mode.
The drawer and optional external buzzer cannot be connected simultaneously.
This API cannot be used if the printer is not equipped with a buzzer.
The timing to receive the callback of sendData API varies by printer.
Mobile models: sendData After running API
Other than Mobile models: After buzzer stops sounding
For built-in buzzer equipped models of the following printers, sounding the buzzer is possible using addPulse.
TM-T70 / TM-T70II / TM-T82II / TM-T82III / TM-T88IV / TM-T88V / TM-T88VI / TM-T88VII / TM-T82II-i / TM-T83II-i / TM-T88VI-iHUB / TM-L90 / TM-L100

Quick Access

[Name]
[Format]
[Range]
[Description]
[Notes]

Epson ePOS SDK includes patented or patent pending functions. The contents must not be disclosed to third parties.

Epson ePOS SDK for iOS

Introduction
help
Epos2Printer class
- initWithPrinterSeries
- connect
- disconnect
- startMonitor
- stopMonitor
- getStatus
- sendData
- beginTransaction
- endTransaction
- requestPrintJobStatus
- clearCommandBuffer
- addTextAlign
- addLineSpace
- addTextRotate
- addText
- addTextLang
- addTextFont
- addTextSmooth
- addTextSize
- addTextStyle
- addHPosition
- addFeedUnit
- addFeedLine
- addImage
- addLogo
- addBarcode
- addSymbol
- addHLine
- addVLineBegin
- addVLineEnd
- addPageBegin
- addPageEnd
- addPageArea
- addPageDirection
- addPagePosition
- addPageLine
- addPageRectangle
- addRotateBegin
- addRotateEnd
- addCut
- addPulse
- addSound
- addFeedPosition
- addLayout
- addCommand
- getMaintenanceCounter
- resetMaintenanceCounter
- getPrinterSetting
- setPrinterSetting
- getPrinterSettingEx
- setPrinterSettingEx
- setPrinterSettingEx[Obsolete]
- verifyPassword
- getPrinterInformation
- downloadFirmwareList
- getPrinterFirmwareInfo
- verifyUpdate
- updateFirmware
- forceRecover
- forcePulse
- forceStopSound
- forceCommand
- forceReset
- setStatusChangeEventDelegate
- setReceiveEventDelegate
- setGetPrinterSettingExDelegate
- setSetPrinterSettingExDelegate
- setVerifyPasswordDelegate
- interval
Epos2LFCPrinter class
- initWithPrinterSeries
- connect
- disconnect
- startMonitor
- stopMonitor
- getStatus
- sendLFCData
- setLFCStatusChangeEventDelegate
- setSendCompleteEventDelegate
- setPrintCompleteEventDelegate
Epos2HybridPrinter class
- initWithLang
- connect
- disconnect
- startMonitor
- stopMonitor
- getStatus
- sendData
- beginTransaction
- endTransaction
- clearCommandBuffer
- selectPaperType
- waitInsertion
- cancelInsertion
- ejectPaper
- readMicrData
- cleanMicrReader
- forceRecover
- forcePulse
- forceCommand
- forceReset
- paperType
- interval
- waitTime
- mode40Cpl
- setStatusChangeEventDelegate
- setReceiveEventDelegate
Epos2LineDisplay class
- initWithDisplayModel
- connect
- disconnect
- getStatus
- sendData
- clearCommandBuffer
- addInitialize
- addCreateWindow
- addDestroyWindow
- addSetCurrentWindow
- addClearCurrentWindow
- addCreateScreen
- addCreateScreenCustom
- addCreateTextArea
- addDestroyTextArea
- addSetCurrentTextArea
- addClearCurrentTextArea
- addSetCursorPosition
- addMoveCursorPosition
- addSetCursorType
- addText
- addReverseText
- addMarqueeText
- addSetBlink
- addSetBrightness
- addBackgroundColor
- addStartSlideShow
- addStopSlideShow
- addDownloadImage
- addRegisterDownloadImage
- addNVImage
- addClearImage
- addSymbol
- addClearSymbol
- addShowClock
- addCommand
- setReceiveEventDelegate
Epos2Keyboard class
- init
- connect
- disconnect
- getStatus
- setPrefix
- getPrefix
- setKeyPressEventDelegate
- setReadStringEventDelegate
Epos2POSKeyboard class
- init
- connect
- disconnect
- getStatus
- setKeyPressEventDelegate
Epos2BarcodeScanner class
- init
- connect
- disconnect
- getStatus
- setScanEventDelegate
Epos2MSR class
- init
- connect
- disconnect
- getStatus
- setDataEventDelegate
Epos2SimpleSerial class
- init
- connect
- disconnect
- getStatus
- sendCommand
- setReceiveEventDelegate
Epos2GermanyFiscalElement class
- init
- connect
- disconnect
- getStatus
- operate
- setReceiveEventDelegate
Epos2OtherPeripheral class
- init
- connect
- disconnect
- getStatus
- sendData
- setReceiveEventDelegate
Epos2CommBox class
- init
- connect
- disconnect
- getStatus
- getCommHistory
- sendMessage
- setReceiveEventDelegate
Common to all classes
- getAdmin
- getLocation
- setConnectionEventDelegate
Epos2Discovery class
- start
- stop
Epos2Log class
- setLogSettings
- SdkVersion
Epos2BluetoothConnection class
- connectDevice
- disconnectDevice
EasySelect class
- parseNFC
- parseQR
- createQR
- parseBeacon
EasySelectInfo class
- deviceType
- printerName
- macAddress
- target
Appendix
- Status list
- Key code list
- List of Supported Classes
- List of Supported APIs
- Printer-specific Support Information
  - TM-m10
  - TM-m30
  - TM-m30II
  - TM-m30II-H
  - TM-m30II-NT
  - TM-m30II-S
  - TM-m30II-SL
  - TM-m30III
  - TM-m30III-H
  - TM-m50
  - TM-m50II
  - TM-m50II-H
  - TM-T20
  - TM-T20II
  - TM-T20III
  - TM-T20IIIL
  - TM-T20X
  - TM-T60
  - TM-T70
  - TM-T70II
  - TM-T81II
  - TM-T81III
  - TM-T82
  - TM-T82II
  - TM-T82III
  - TM-T82IIIL
  - TM-T82X
  - TM-T83III
  - TM-T88V
  - TM-T88VI
  - TM-T88VII
  - TM-T100
  - TM-L90 Liner-Free Label Printer Model
  - TM-L100
  - TM-U220
  - TM-U220II
  - TM-U330
  - TM-P20
  - TM-P20II
  - TM-P60 (Receipt)
  - TM-P60 (Peeler)
  - TM-P60II (Receipt)
  - TM-P60II (Peeler)
  - TM-P80
  - TM-P80II
  - TM-H6000V
  - TM-T20II-i
  - TM-T70-i
  - TM-T82II-i
  - TM-T83II-i
  - TM-T88V-i
  - TM-T88VI-iHUB
  - TM-U220-i
  - TM-U220IIB-i
  - TM-T70II-DT
  - TM-T70II-DT2
  - TM-T88V-DT
  - TM-T88VI-DT2
  - TM-H6000IV-DT
  - TM-T88IV
  - TM-T90
  - TM-L90
  - TM-H6000IV
- Usage restriction by firmware version