StarXpand SDK Manual

API ご利用の手引き

手順や参照先はOSによって異なります。表示するOSを選択してください。

StarXpand SDK では、プリンターやPOS周辺機器を制御するための便利なAPIを用意しています。
お客様のアプリにStarIO10ライブラリを組み込み、各機能の説明ページを参考に、必要なAPIを組み合わせて呼び出してご利用ください。
機能別APIリファレンス一覧（iOS）

また、StarIO10ライブラリのアプリへの組み込みについては、下記URLをご参照ください。
https://github.com/star-micronics/StarXpand-SDK-iOS/blob/main/docs/README_JP.md#導入

V1.0.0 からの移行手順について
StarXpand SDK V2.0.0 より、StarPrinter クラスのメソッドの対応するOSバージョンが変更され、呼び出し側コードの変更が必要となりました。
具体的な変更内容はこちらを参照してください。

プリンターを検索する

StarDeviceDiscoveryManagerを使って、非同期にプリンター検索を行います。
サンプルコードを使った説明はこちらを参照してください。

StarXpand SDK では、プリンターやPOS周辺機器を制御するための便利なAPIを用意しています。
お客様のアプリにStarIO10ライブラリを組み込み、各機能の説明ページを参考に、必要なAPIを組み合わせて呼び出してご利用ください。
機能別APIリファレンス一覧（Android）

また、StarIO10ライブラリのアプリへの組み込みについては、下記URLをご参照ください。
https://github.com/star-micronics/StarXpand-SDK-Android/blob/main/docs/README_JP.md#導入

プリンターを検索する

StarDeviceDiscoveryManagerを使って、非同期にプリンター検索を行います。
サンプルコードを使った説明はこちらを参照してください。

印刷を行う

Step1で印刷データを作り、Step2でプリンターに送信します。
各Stepで必要な機能を選択して、リンク先のサンプルコードを使った説明を参照してください。

Step.1 印刷データの生成

標準機能

基本的な機能を組み合わせて印刷データを
生成する

ページモード機能

印刷向き指定や罫線を使って印刷データを
生成する

テンプレート印刷機能

レイアウトを定義するテンプレートと、印刷
内容を定義するフィールドデータに分けて
印刷データを生成する

※ SDKに印刷データサンプルが多数ありますので参考にしてください。

Step.2 印刷データの送信

標準機能

基本的な機能を組み合わせて印刷データを
送信する

スプーラー機能

複数の上位端末から印刷データを送信する

テンプレート印刷機能

テンプレートとフィールドデータを利用して
印刷データを送信する

キャッシュドロアーを使う

プリンターに接続されたキャッシュドロアーの開閉を行います。
サンプルコードを使った説明はこちらをご参照ください。

プリンターのステータスを取得する

プリンターのステータス（例：用紙有り／無し）を取得します。
ステータスの取得にはStarPrinterクラスのgetStatusメソッドを使用します。
SDKに含まれるサンプルも参考にしてください。

また、イベントベースのAPIも利用できます。プリンターのステータスが変化したとき、PrinterDelegateクラスの各メソッドが呼び出されます。
SDKに含まれるサンプルも参考にしてください。

バーコードリーダーを使う

バーコードリーダーで読み取ったデータをイベントベースのAPIで取得します。
バーコードが読み取られたとき、InputDeviceDelegateクラスのonDataReceivedメソッドが呼び出され、バーコードデータが取得できます。
SDKに含まれるサンプルも参考にしてください。

カスタマーディスプレイを使う

カスタマーディスプレイの制御データを生成し、プリンターに送信します。
制御データの生成には、 DisplayBuilderクラスを使用します。
制御データの送信は印刷を行う Step2を参考にしてください。

ブザーを使う

ブザーの制御データを生成し、プリンターに送信します。
制御データの生成にはBuzzerBuilderクラスを使用します。
制御データの送信は印刷を行う Step2を参考にしてください。

メロディースピーカーを使う

メロディースピーカーの制御データを生成し、プリンターに送信します。
制御データの生成にはMelodySpeakerBuilderクラスを使用します。
制御データの送信は印刷を行う Step2を参考にしてください。

周辺機器の接続状態を取得する

周辺機器の接続状態を、イベントベースのAPIで取得します。
入力機器（バーコードリーダー）の接続状態が変化したときはInputDeviceDelegateクラス、カスタマーディスプレイの接続状態が変化したときはDisplayDelegateクラスの各メソッドが呼び出されます。
SDKに含まれるサンプルも参考にしてください。

ログを取得する

StarIO10ライブラリのAPI呼び出し情報や送信データのログを取得します。
ログの取得にはStarIO10Loggerクラスを使用します。

機能別APIリファレンス

通信 API

StarPrinter: プリンターを制御するクラス

StarConnectionSettings: デバイスへの接続設定を定義するクラス

StarPrinterInformation: プリンターの情報を定義するクラス

StarPrinterInformationDetail: プリンターの詳細情報を定義するクラス

StarPrinterInformationLan: プリンターのLAN通信用情報を定義するクラス

StarPrinterInformationBluetooth: プリンターのBluetooth通信用情報を定義するクラス

StarPrinterInformationBluetoothLE: プリンターのBluetoothLE通信用情報を定義するクラス

StarPrinterInformationUSB: プリンターのUSB通信用情報を定義するクラス

StarPrinterStatus: プリンターのステータスを定義するクラス

StarPrinterStatusDetail: プリンターの詳細ステータスを定義するクラス

StarSpoolJobSettings: スプール印刷の設定を定義するクラス

StarSpoolJobStatus: ジョブのステータスを定義するクラス

InterfaceType: インターフェイスの種類

StarPrinterEmulation: プリンターのエミュレーション

StarPrinterModel: プリンターのモデル

SpoolJobState: ジョブの状態

SpoolJobReceivedInterface: プリンターがジョブを受け付けたインターフェイス

DrawerOpenedMethod: キャッシュドロアー開閉メソッド

検索 API

StarDeviceDiscoveryManager: デバイス検索をするクラス

StarDeviceDiscoveryManagerDelegate: プリンター検索のイベントを定義するプロトコル

StarDeviceDiscoveryManagerFactory: StarDeviceDiscoveryManagerオブジェクトを生成するクラス

イベント API

PrinterDelegate: プリンターのステータスイベントを定義するクラス

DrawerDelegate: キャッシュドロアーのステータスイベントを定義するクラス

InputDeviceDelegate: 入力機器 (バーコードリーダーなど) のステータスイベントを定義するクラス

DisplayDelegate: カスタマーディスプレイのステータスイベントを定義するクラス

ログ API

StarIO10Logger: ログの制御をするクラス

エラーAPI

StarIO10Error: 本ライブラリのAPIでスローされるエラークラス

StarIO10ErrorCode: StarIO10Errorのエラーコード

StarIO10ErrorDetail: エラーの詳細情報を定義するクラス

印刷データ／制御データ生成 API

StarXpandCommandBuilder: StarXpandCommandを生成するクラス

DocumentBuilder: ドキュメントに関するStarXpandCommandを生成するクラス

MagnificationParameter: 拡大設定パラメータ

TemplateExtensionParameter: テンプレート印刷のテンプレート側拡張設定パラメータ

プリンター

PrinterBuilder: プリンターに関するStarXpandCommandを生成するクラス

PageModeBuilder: ページモードに関するStarXpandCommandを生成するクラス

Printer: PrinterBuilderで使用する、プリンター制御に関するパラメータ一覧です

Alignment: 位置揃えを示す値

AmbiguousCharacterWidthType: Unicodeあいまい文字の全半角設定

BarcodeBarRatioLevel: バーコードバー比率レベル

BarcodeSymbology: バーコードシンボル

BlackMarkPosition: ブラックマーク位置

CharacterEncodingType: 文字エンコーディング

CJKCharacterType: CJK統合漢字

CutType: 用紙カット方法

FontType: フォント

InternationalCharacterType: 国際文字

Pdf417Level: PDF417 ECC（セキュリティレベル）

QRCodeLevel: QRコード誤り訂正レベル

QRCodeModel: QRコードモデル

TextAlignment: 文字数指定機能での位置揃えを示す値

TextEllipsizeType: 文字数指定機能での省略方法

TextPrintType: 文字数指定機能での印刷方法

TextWidthType: 文字数指定機能での全半角設定

BarcodeParameter: バーコード設定パラメータ

BlackMarkParameter: ブラックマーク設定パラメータ

HoldPrintParameter: 用紙保持制御設定パラメータ

ImageParameter: 画像設定パラメータ

LabelParameter: ラベル設定パラメータ

LogoParameter: ロゴ設定パラメータ

Pdf417Parameter: PDF417設定パラメータ

QRCodeParameter: QRコード設定パラメータ

RuledLineParameter: 水平線設定パラメータ

LineStyle: 線のスタイル

PageModeAreaParameter: ページ領域設定パラメータ

PageModeImageParameter: 画像設定パラメータ

PageModePrintDirection: ページモードでの印刷方向

PageModeRectangleParameter: ページモードでの四角枠線設定パラメータ

PageModeRuledLineParameter: ページモードでの罫線設定パラメータ

PrinterParameter: PrinterBuilder全体に関する設定パラメータ

PageModeParameter: PageModeBuilder全体に関する設定パラメータ

TextParameter: テキスト設定パラメータ

TextWidthParameter: 文字数指定機能の設定パラメータ

キャッシュドロアー

DrawerBuilder: キャッシュドロアーに関するStarXpandCommandを生成するクラス

Drawer: DrawerBuilderで使用する、キャッシュドロアー制御に関するパラメータ一覧です

Channel: キャッシュドロアーチャネル

OpenParameter: キャッシュドロアー開放設定パラメータ

ブザー

BuzzerBuilder: ブザーに関するStarXpandCommandを生成するクラス

Buzzer: BuzzerBuilderで使用する、ブザー制御に関するパラメータの一覧です。

Channel: ブザーチャネル

DriveParameter: ブザー駆動設定パラメータ

メロディースピーカー

MelodySpeakerBuilder: メロディスピーカー（mC-Sound）に関するStarXpandCommandを生成するクラス

MelodySpeaker: MelodySpeakerBuilderで使用する、メロディスピーカー制御に関するパラメータ一覧です

SoundStorageArea: サウンド格納領域

DriveRegisteredSoundParameter: 登録サウンド再生設定パラメータ

DriveOneTimeSoundParameter: 受信データ再生設定パラメータ

ディスプレイ

DisplayBuilder: カスタマーディスプレイに関するStarXpandCommandを生成するクラス

Display: DisplayBuilderで使用する、カスタマーディスプレイ制御に関するパラメータ一覧です

CharacterEncodingType: 文字エンコーディング

Contrast: コントラスト値

CursorState: カーソル状態

InternationalCharacterType: 国際文字

ImageParameter: 画像設定パラメータ

PositionParameter: 位置パラメータ