実装ソフトウェアから Lyrics Master の検索機能を起動する#

Windows 環境においては、「外部ソフトウェアサポート」(Lyrics Master に同梱)を経由することで Lyrics Master を操作することができます。

用語の定義#

  • 外部ソフトウェアサポート

    • Lyrics Master for Windows と実装ソフトウェアが連携する際に必要になるファイルです。現バージョンでは、「ExtSupport.js」という名前ですが、将来的に変更される場合もあります。Lyrics Master に同梱されています。

  • 設定パス

    • 外部ソフトウェアサポートまでのパスに引数を加えた文字列です(Lyrics Master アプリケーションへのパスではありませんのでご注意ください)。Lyrics Master for Windows の「外部ソフトウェアの設定...」から入手することができます(Lyrics Master for Mac では、設定パスを利用することはできません)。

必要な環境#

Lyrics Master の動作条件に加え、「Windows Scripting Host」または「Windows Based Script Host」がインストールされている必要があります (\Windows\system32\wscript.exe が存在していて、JScript に対応していれば、問題ありません)。 通常、このプログラムはシステムのインストールと同時にセットアップされます。

連携の流れ#

  1. ユーザはあらかじめ Lyrics Master から設定パスを入手し、実装ソフトウェアに設定しておきます。

  2. 連携を起動する場合、実装ソフトウェアは設定パスの引数を適切に置換し(以下の「置換記号について」を参照)、シェルに渡します。

置換記号について#

設定パスに含まれる可能性のある置換記号には、以下の 4 種類があります。

  • [title]

    • 曲名

  • [artist]

    • アーティスト名

  • [lyrics]

    • 歌いだし

  • [tv]

    • テレビ番組名

置換先のテキストにメタ文字(「"」等)が含まれる場合は、その文字をエスケープする必要があります。

設定パスの例#

  • C:\WINDOWS\system32\wscript.exe "C:\Program Files\Lyrics Master\ExtSupport.js" multi "[title]" "[artist]"

  • C:\WINDOWS\system32\wscript.exe "C:\Program Files\Lyrics Master\ExtSupport.js" lyrics "[lyrics]"

  • C:\WINDOWS\system32\wscript.exe "C:\Program Files\Lyrics Master\ExtSupport.js"

部分対応について#

例えば、「曲のタイトルとアーティストには対応するが、歌いだしとテレビ番組名には対応しない」といった形式で、実装ソフトウェアを設計することも可能です。その場合、対応しない値(この例では「[lyrics]」と「[tv]」)については空文字列で置き換えてください。

ユーザが行う必要のある設定#

ユーザは、「外部ソフトウェアを使用する」設定(環境設定画面の「その他」から「外部ソフトウェアの設定...」ボタンをクリックすることで変更できます)を有効にする必要があります。

ユーザが設定パスを入手する方法#

ユーザは、環境設定画面の「その他」から「外部ソフトウェアの設定...」ボタンをクリックし、「コピー」ボタンをクリックすることで設定パスをクリップボードにコピーできます。以下の画像を参照してください。

../_images/external_setup.png

スクリーンショット画像は、ユーザへの説明に必要な範囲内で、自由に改変してご利用いただいて構いません。

互換性#

上記の仕様は、Lyrics Master 1.x の上位互換となります。 但し、一部の用語と、「ユーザが行う必要のある設定」および「ユーザが設定パスを入手する方法」については変更があります。 詳しくは 移行ガイド をご覧ください。