スクリプト

PixPinのスクリプトはJavaScriptで撮影、ピン留め、ウィンドウ操作を呼び出します。繰り返す手順をアクションに保存し、キー、トレイメニュー、コマンドラインから実行できます。「スクリプト」はマニュアルの説明章で、アプリ内の編集入口は設定 → ショートカット/アクションです。

スクリプトに適した用途Copy Anchor Link

キー変更、トレイ項目の調整、特定アプリの除外だけならショートカット／アクション設定を使えます。スクリプトは複数操作の組み合わせや引数指定に向いています。

最初のスクリプトを作って実行するCopy Anchor Link

pixpin.screenShot(ShotAction.Pin);

テストは実際の実行です。別のプリセットを選ぶと編集内容が上書きされ、ウィンドウをキャンセルしても実行済み操作は戻りません。組み込みスクリプトは変更できないため、別のカスタムアクションを作ってください。

コマンドラインで実行するCopy Anchor Link

-rの後にスクリプト文字列、-fの後にファイルパスを指定します。起動中なら既存のPixPinに渡し、初回起動時は初期化完了後に実行します。

Windows PowerShell： 実際のインストール先に置き換えてください。

& 'D:/Apps/PixPin/PixPin.exe' -r 'pixpin.screenShot(ShotAction.Copy);'
& 'D:/Apps/PixPin/PixPin.exe' -f 'D:/Scripts/capture.js'

macOSのターミナル： アプリケーションフォルダーにインストールした場合の例です。

"/Applications/PixPin.app/Contents/MacOS/PixPin" -r 'pixpin.screenShot(ShotAction.Copy);'
"/Applications/PixPin.app/Contents/MacOS/PixPin" -f '/Users/yourname/Scripts/capture.js'

ファイルにはJavaScriptだけを書き、コードブロックの記号は不要です。中国語を含む場合はBOM付きUTF-8を推奨します。長いスクリプトは-fを使うと、引用符、バックスラッシュ、$のエスケープを減らせます。空白のあるパスは引用符で囲みます。

コマンドの終了は撮影、認識、保存の完了を意味しません。最後の式の値を構造化結果として返す入口でもありません。macOSの自動呼び出しは対話撮影の権限案内を自動表示しないため、先にアプリ内で画面収録とアクセシビリティを許可してください。

対応構文と実行方法Copy Anchor Link

JavaScriptを入力できます。APIと定数名は大文字小文字を区別します。pixpin.screenShotをpixpin.screenshotに変えないでください。

現行環境はオプショナルチェーン?.とasync/awaitに対応せず、通常のスクリプトでimport / exportも使えません。空値判定はif、段階的操作はPixPinのAPIを使います。

ブラウザーのwindow、document、fetchやNode.jsのrequire、process、fsはなく、setTimeoutもありません。ウェブ、Node.js、外部パッケージ依存の例をそのまま貼らないでください。オブジェクト対応でも、通常のオブジェクトがAPIの矩形を代用できるわけではありません。

順次実行は手動操作を待たないCopy Anchor Link

文は順番に実行されますが、撮影ウィンドウを開く呼び出しは開始するだけで選択完了を待ちません。撮影後にピン留めするならpixpin.screenShot(ShotAction.Pin)を使い、撮影開始とクリップボードのピン留めを単純に2行並べないでください。

エンジンは再利用されます。繰り返し実行の干渉を避けるため、一時変数はできるだけ関数内に置きます。複数行の例は即時実行関数を使っています。

(function () {
  var width = 640;
  var height = 480;
  var rect = pixpin.genRectUnderCursor(width, height);
  pixpin.directScreenShot(rect, ShotAction.Copy);
})();

最後の()が即時実行を表します。無限ループで撮影完了を待つとUIスレッドを占有します。console.log(...)でログを出せますが、編集画面に対話コンソールはありません。

グローバルオブジェクト、引数、戻り値Copy Anchor Link

数値、真偽値、文字列は直接指定し、ファイル一覧は文字列配列にします。絶対パスを推奨します。JavaScriptのパスはD:/Images/example.png、バックスラッシュならD:\\Images\\example.pngと書きます。

矩形は次の3つのAPIで作り、そのまま後続のAPIへ渡してください。

位置とサイズは画面の論理座標です。幅と高さは正の値とし、マルチディスプレイの座標は負になることがあります。周囲が狭いとgenRectUnderCursorは比率を保って縮小します。出力ピクセル数は表示倍率と保存設定にも影響されます。矩形が必要なAPIへ{x: 100, y: 100, width: 640, height: 480}を渡しても、その値から撮影範囲は作られません。

trueは通常、要求の受付を表し、ユーザー操作の完了ではありません。各APIの戻り値は後の表を確認してください。戻り値のないAPIでは保存成功を判断できません。

書き換えて使える例Copy Anchor Link

アクティブウィンドウを撮影してコピーCopy Anchor Link

対象アプリを前面にし、グローバルショートカットで実行します。手動選択なしですぐに撮影します。

pixpin.directScreenShotSpRect(
  PixConst.SpRectActiveWindow,
  ShotAction.Copy
);

編集画面のスクリプトをテストでは設定ウィンドウがアクティブな場合があります。適用してから対象アプリで実行し、結果を確認してください。

範囲を固定してから手動調整Copy Anchor Link

通常の撮影を開始し、座標(100, 100)、サイズ640 × 480を指定します。ツールバーで注釈や範囲の調整もできます。

(function () {
  if (pixpin.screenShotAndEdit()) {
    pixpin.setScreenShotRect(100, 100, 640, 480);
    pixpin.setScreenShotRectRadius(4 / 3);
  }
})();

setScreenShotRectRadiusは名前と異なり、角丸半径ではなくアスペクト比を設定します。比率を固定しない場合は最後の行を削除します。

直接撮影し、日時付きで保存Copy Anchor Link

ポインターのある画面を直接撮影します。実行前に保存先を変更してください。macOSでは/Users/yourname/Pictures/...などを使えます。

(function () {
  var rect = pixpin.getSpRect(PixConst.SpRectScreenUnderMouse);
  pixpin.directScreenShotAndSaveTo(
    rect,
    "D:/Captures/PixPin_$yyyy-MM-dd_HH-mm-ss$.png"
  );
})();

時刻の変数は保存機能で展開されます。パスとファイル名の変数を参照してください。同名時は数字を追加し、保存通知は表示しません。保存先や成功フラグも返しません。

複数の参考ファイルを一度にピン留めCopy Anchor Link

配列内のパスを実在するファイルに置き換えます。同じ形式で追加できます。

(function () {
  var files = [
    "D:/Reference/layout.png",
    "D:/Reference/colors.png"
  ];
  if (!pixpin.pinFromFiles(files)) {
    throw new Error("没有找到可贴出的文件，请检查路径。");
  }
})();

存在しないファイルは飛ばし、空配列または全パスが存在しないとfalseを返します。trueは既存ファイルをピン機能へ渡した意味で、どの形式も画像として表示できる保証ではありません。

3秒待って撮影開始Copy Anchor Link

キャンセル可能なカウントダウンを出す最も簡単な書き方です。

pixpin.delayScreenShotWithTips(3);

位置とサイズを指定する場合は次のAPIを使います。左から秒数、位置指定の有無、x、y、サイズ指定の有無、幅、高さ、予約引数、アスペクト比です。

pixpin.delayScreenShot(3, true, 100, 100, true, 640, 480, 0, 4 / 3);

同じアクションで状態を切り替えるCopy Anchor Link

無効状態を反転します。有効時は他のグローバルショートカットを停止し、もう一度押すと再開します。

pixpin.disableShortcuts(!pixpin.isDisableShortcuts());

このキーは明示的な停止を解除できますが、除外リストやWindowsの全画面ゲーム状態による制限は残ります。

カスタムAPI早見表Copy Anchor Link

通常のアクションスクリプトで使えるユーザー操作APIです。rectは矩形生成API、actionはShotActionを使います。角括弧は省略可能な引数を示し、実際のコードには書きません。

撮影と範囲Copy Anchor Link

表ではpixpin.を省略しています。実際はpixpin.screenShotAndCopy()などと書きます。直接撮影にEdit、ImageEdit、LongShot、GifShotを渡しても編集・録画画面は開きません。必要な場合はscreenShot(action)か専用APIを使ってください。

遅延、長い撮影、画面録画Copy Anchor Link

delayScreenShotはhasPosとhasSizeが両方trueなら指定矩形を使います。hasSizeだけがtrueならポインター基準で指定サイズを作り、サイズ未指定なら手動選択です。radiusは未使用なので0、正のratioは比率指定で、不要なら-1にします。

これらは画面を開く／制御するAPIであり、自動スクロール完了や動画出力済みを意味しません。続きは各画面で操作します。

ピンと一括管理Copy Anchor Link

システムコマンドとその他の操作Copy Anchor Link

runSystemとrunSystemSyncはインタープリターを通さず直接起動します。パイプ、リダイレクト、シェル組み込みは自動では使えません。必要ならOSのインタープリターを明示します。空のコマンド文字列は使えません。

電卓を開くには、Windowsはpixpin.runSystem("calc")、macOSはpixpin.runSystem("/usr/bin/open -a Calculator")を使えます。次は同期結果の取得例です。実在するプログラムに置き換えてください。

(function () {
  var result = pixpin.runSystemSync("cmd /c ver"); // Windows 示例
  console.log(result.code, result.output, result.error);
})();

同期待機中はPixPinのUIを一時的に占有します。既定の待機上限は約30秒で、専用のタイムアウト項目は返しません。codeだけでは正常起動を判定できません。すぐ戻したい場合はrunSystemを使います。

範囲とアクションの定数Copy Anchor Link

PixConst：撮影する場所Copy Anchor Link

範囲は実行時のウィンドウ、ポインター、履歴に依存します。有効なウィンドウや履歴がなければ利用可能な範囲が得られるとは限りません。

ShotAction：選択後の操作Copy Anchor Link

ShotAction.QuickSaveのように、ShotAction.を付けて使います。

定数は既存機能を選ぶだけで、動作条件は変えません。コピー、保存、認識は設定や対話画面の影響を受けます。

エラー時の確認Copy Anchor Link

スクリプトエラーはtry / catchで捕捉できますが、falseや戻り値なしは自動的な例外ではありません。まず1操作から始め、引数や組み合わせを増やします。エラーがないことを完了の証拠にしないでください。

関連記事Copy Anchor Link