任意パラメータ

[任意パラメータ]

必須パラメータのあとに必要に応じて以下のパラメータを設定します。

パラメータ名	対象	デフォルト	設定値の例
copies	印刷部数 数値を設定します。	1	1
halftone	ハーフトーン 下記のいずれかを設定します。 threshold（単純二値） pattern_dither（ディザ） error_difusion（誤差拡散）	pattern_dither	pattern_dither
rjDensity	濃度 数値 -5（明るい）〜 5（暗い）の整数値を設定します。	0	2
rotate	印刷画像の回転 下記のいずれかを設定します。 Rotate0 Rotate90 Rotate180 Rotate270	Rotate0	Rotate0
peelMode	剥離モード 下記のいずれかの数値を設定します。 0（剥離モード OFF） 1（剥離モード ON）	0	1
printQuality	印刷品質 下記のいずれかを設定します。 normal（品質優先） double_speed（速度優先）	normal	normal
orientation	方向 下記のいずれかを設定します。 portrait（縦） landscape（横）	lbx ファイルは自身の設定に依存、lbx ファイル以外は landscape	portrait
printMode	印刷サイズ 下記のいずれかを設定します。 original（オリジナルサイズ） fit_to_page（ページに合わせる） scale（数字指定） fit_to_paper（用紙に合わせる）	fit_to_page	original
scaleValue	倍率数字指定（正の小数または整数） ※printMode が scale の場合有効 ※PDF 印刷の場合1以下を指定	1.0	1.0
text_オブジェクト名	テキストオブジェクトのテキスト 文字列を設定します。（単一レイアウト）	-	サンプル
barcode_オブジェクト名	バーコードオブジェクトのデータ 文字列を設定します。（単一レイアウト）	-	12345
image_オブジェクト名	画像オブジェクトの画像データを設定します。（単一レイアウト） ファイル形式：jpg、jpeg、bmp、png	-	Sample.png
text_filename連番.オブジェクト名	テキストオブジェクトのテキスト 文字列を設定します。（複数レイアウト）	-	サンプル
barcode_filename連番.オブジェクト名	バーコードオブジェクトのデータ 文字列を設定します。（複数レイアウト）	-	12345
image_filename連番.オブジェクト名	画像オブジェクトの画像データを設定します。（複数レイアウト） ファイル形式：jpg、jpeg、bmp、png	-	Sample.png
fileattach	テンプレートファイルとして base64 データを設定します。（単一レイアウト）	-	base64Data
sizeattach	用紙情報ファイルとして base64 データを設定します。	-	base64Data
fileattach_filename連番	テンプレートファイルとして base64 データを設定します。（複数レイアウト）	-	base64Data
formatarchiveupdate	ファイルを更新して保存します。 0（更新しない） 1（更新して保存する）	0	1
forceStretchPrintableArea	印刷範囲を下方向に拡張します。 数値を設定します。（単位はPixel）	0	1
feedMode	用紙排出モード 下記のいずれかを設定します。 NoFeed FixedPage EndOfPage EndOfPageRetract	NoFeed	NoFeed
rollCase	ロールプリンターケース用の排紙動作を設定します 下記のいずれかを設定します。 None PARC001_NoAntiCurl PARC001 PARC001_ShortFeed KeepPrinterSetting	KeepPrinterSetting	KeepPrinterSetting
imageFitMode	画像置換モードを設定する 下記のいずれかを設定します。 fitCurrentSize keepHeight	fitCurrentSize	fitCurrentSize

注1)　text_オブジェクト名と barcode_オブジェクト名の場合、オブジェクト名には、P-touch Editor でレイアウト上に作成したテキストやバーコードにそれぞれ設定したオブジェクト名を入力します。 例えば、"TEXT" というオブジェクト名のテキストに文字列を入力して印刷したい場合、パラメータ名は text_TEXT となります。

注2)　同じパラメータ名が複数定義されている場合、最後に定義されたパラメータ値が採用されます。 パラメータによるデータの変更指示は、オブジェクトタイプ（テキストまたはバーコード）およびオブジェクト名が一致する全てのオブジェクトに対して適用します。

注3)　RJ-2035B と RJ-3035B、TD-4T シリーズ、TJ シリーズで rotate を使用する場合、rotate0、rotate180 のみ有効です。

注4)　printQuality は QL シリーズ、TD-2 シリーズにおいて有効です。

注5)　URL スキームで指定する画像サイズは、P-touch Editor でテンプレートファイルに挿入した画像サイズと合わせてください。

注6)　プリンター本体が対応していないパラメータ/有効範囲外のパラメータ値を設定した場合、設定は無視されデフォルトで印刷されます。

注7)　複数レイアウトの text_filename連番.オブジェクト名、barcode_filename連番.オブジェクト名、image_filename連番.オブジェクト名のfilename連番は必須パラメータで記載したパラメータのことです。

注8)　複数レイアウトの場合 text_filename連番.オブジェクト名、barcode_filename連番.オブジェクト名、image_filename連番.オブジェクト名のfilename連番以外の設定はすべてのレイアウトで共通になります。

注9)　formatarchiveupdate を 1 に指定する時、fileattach と sizeattach、fileattach_filename連番の内容は保存済のファイルと更新日時を比較して、更新日時が新しければ上書き保存します。

注10) forceStretchPrintableArea 、feedMode、rollCase は PJ シリーズにおいて有効です。

注11) RJ-2035B、RJ-3035B、TD-4T シリーズ、TJ シリーズは halftone、printQuality、orientation、printMode、scaleValue に非対応です。

[任意パラメータ（用紙情報設定）]

URL スキームで用紙情報を設定したい場合に以下を設定します。

用紙情報設定パラメータを使用する場合、paperType は必須です

パラメータ名	対象	設定可能な値	デフォルト	設定値の例
paperType	用紙種類	roll dieCut markRoll custom typeB	-	roll
tapeWidth	用紙幅	0 以上	2	0
margin_top	上余白	0 以上	0	0
margin_left	左余白	0 以上	0	0
margin_bottom	下余白	0 以上	0	0
margin_right	右余白	0 以上	0	0
unit	単位	inch mm	inch	inch
tapeLength	用紙長さ （プレカット紙ラベル/マーク付きメディアのみ）	0 以上	0	0
gapLength	ラベル間の距離 （プレカット紙ラベルのみ）	0 以上	0	0
markVerticalOffset	用紙先端からマークまでの距離 （マーク付きメディアのみ）	0 以上	0	0
markLength	マーク長さ （マーク付きメディアのみ）	0 以上	0	0
conveying_offset	搬送のオフセット（mm）	-25.4 ～ 25.4	0	0

注1) paperType の roll、dieCut、markRoll は RJ シリーズ、TD-2 シリーズ、TD-4D シリーズにおいて有効です。

注2) paperType の custom は PJ シリーズにおいて有効です。paperType が custom の場合、tapeWidth、tapeLength の単位は dots です。

注3) paperType の typeB は TD-4T シリーズ、TJ シリーズにおいて有効です。paerType が typeB の場合、各設定値の単位は mm です。

注4) 用紙情報設定のパラメータが複数存在する場合、最後に設定されたパラメータの値が採用されます。

paperType ごとの対応設定値

○：対応、×：非対応

paperType	roll	dieCut	markRoll	custom	typeB
tapeWidth	○	○	○	○	○
margin_top	○	○	○	×	○
margin_left	○	○	○	×	○
margin_bottom	○	○	○	×	○
margin_right	○	○	○	×	○
unit	○	○	○	×	×
tapeLength	×	○	○	○	○
gapLength	×	○	×	×	×
markVerticalOffset	×	×	○	×	×
markLength	×	×	○	×	×
offset	×	×	×	×	○
sensor	×	×	×	×	○
conveying_offset	×	×	×	×	○

[任意パラメータ（コールバック用）]

利用者の WEB アプリ/ネイティブアプリで印刷結果を確認したい場合は、このコールバック用パラメータを使用してください。
このとき、印刷結果（印刷成功/失敗）は Smooth Print には表示されません。
コールバック用パラメータは両方指定する必要があります。各パラメータは & でつなげてください。片方のみ指定された場合は無視されます。

パラメータ名	対象	設定可能な値	値の例（URL エンコーディングされた値）	値の例（URL エンコーディング前の値）
successCallback	印刷成功時に起動する URL スキーム	URL 文字列	sendurlscheme%3A%2F%2FsuccessCallback%3Fresult%3D	sendurlscheme://successCallback?result=
failureCallback	印刷失敗時に起動する URL スキーム	URL 文字列 ※パラメータ名「param」に任意の値を設定ください。この例では「あいう」を設定しています。印刷ジョブの識別等に活用できます。	sendurlscheme%3A%2F%2FfailureCallback%3Fparam%3D%25E3%2581%2582%25E3%2581%2584%25E3%2581%2586%26result%3D	sendurlscheme://failureCallback?param=あいう&result=

上記の例では、WEB アプリ/ネイティブアプリが sendurlscheme というスキーム名での呼び出しに対応しているものとします。

注1）ただし WEB アプリ/ネイティブアプリの起動に失敗した場合、コールバック用パラメータが指定されていない場合と同じアラートが Smooth Print 側で表示されます。

注2）印刷成功時は、Smooth Print が呼び出す URL スキームは sendurlscheme://successCallback?result=SUCCESS となる。

印刷失敗時（例：プリンターが未選択）は、Smooth Print が呼び出す URL スキームは sendurlscheme://failureCallback?param=%E3%81%82%E3%81%84%E3%81%86&result=ERROR_PRINTER_NO_SETTING となる。

注3）コールバック指定時に使用可能なエラーコードはエラーコードをご確認ください。

URL エンコーディング

パラメータの値は UTF-8 で符号化し、コロンやスラッシュを含めて URL エンコードを行なう必要があります。 上記必須パラメータ - テンプレート - [インターネット上のパスの場合] の例では、エンコード前の値は http://example.com/サンプル.lbx となります。

注) ファイル名は大文字・小文字を区別します。ただし Android™ のローカルパスは大文字・小文字を区別しないため、大文字・小文字のみが異なるファイルが存在した場合、そのファイルを使用します