sticktv 関数仕様書

void log(string mes)

暗号化ログへ出力（改行は自動付与）。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

備考

他 API との呼び出し順序の前提はない

サンプル

window.sticktv.log('');

void showMessage(string msg)

Windows はメッセージボックス、Android はトースト表示。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

備考

他 API との呼び出し順序の前提はない

サンプル

window.sticktv.showMessage('');

void exit()

アプリ終了。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

備考

他 API との呼び出し順序の前提はない

サンプル

window.sticktv.exit();

void finish()

ホストの終了処理を呼ぶ。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

備考

他 API との呼び出し順序の前提はない

サンプル

window.sticktv.finish();

void loadUrl(string url)

%APP% / %HOME% プレースホルダ可。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

備考

file:// URI も許容。他 API との呼び出し順序の前提はない

サンプル

window.sticktv.loadUrl('https://example.com/');

void openUrl(string url)

loadUrl の別名。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

備考

他 API との呼び出し順序の前提はない

サンプル

window.sticktv.openUrl('https://example.com/');

void settings()

Windows は設定ページを読み込み、Android は OS の設定アプリを起動。

• 対応プラットフォーム: Windows △ / Android △
• 戻り値: void

備考

他 API との呼び出し順序の前提はない

サンプル

window.sticktv.settings();

void loadMyHome()

トップページを読み込む。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

備考

他 API との呼び出し順序の前提はない

サンプル

window.sticktv.loadMyHome();

void goHome()

トップページに戻る。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

備考

他 API との呼び出し順序の前提はない

サンプル

window.sticktv.goHome();

void historyBack()

履歴を 1 つ戻る。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

備考

他 API との呼び出し順序の前提はない

サンプル

window.sticktv.historyBack();

void clearHistory()

閲覧履歴をクリア。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

備考

他 API との呼び出し順序の前提はない

サンプル

window.sticktv.clearHistory();

void nativeToJavascript(string func)

メイン WebView で JavaScript を実行。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

備考

他 API との呼び出し順序の前提はない

サンプル

window.sticktv.nativeToJavascript('');

void eval(string cmd)

メイン WebView で JavaScript を実行（nativeToJavascript と同等）。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

備考

他 API との呼び出し順序の前提はない

サンプル

window.sticktv.eval('');

void splashFinished()

Android のみ。

• 対応プラットフォーム: Windows × / Android ○
• 戻り値: void

前提・後続 API

Android のみ。スプラッシュ画面からホーム遷移を完了させる。ドメインチェックを行わない。Android スプラッシュ画面から呼び出すことを想定

サンプル

window.sticktv.splashFinished();

void setPreferenceString(string type, string key, string value)

文字列として AES 暗号化保存。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

文字列として AES 暗号化保存。Windows 第 3 引数は実装上 object 型（JS からは文字列を渡す）。対応する getPreferenceString は設定後に呼び出す

サンプル

window.sticktv.setPreferenceString('', '', '');

string getPreferenceString(string type, string key)

復号して取得。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

前提・後続 API

復号して取得。失敗時は生の値。未設定時は空文字。対応する setPreferenceString の後に呼び出す

サンプル

const result = await window.sticktv.getPreferenceString('', '');
console.log(result);

void setPreferenceInt(string type, string key, int value)

整数値を平文で保存。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

整数値を平文で保存。Windows 第 3 引数は実装上 object 型（JS からは数値を渡す）。対応する getPreferenceInt は設定後に呼び出す

サンプル

window.sticktv.setPreferenceInt('', '', 0);

string getPreferenceInt(string type, string key)

整数値の文字列表現を返す。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

前提・後続 API

整数値の文字列表現を返す。対応する setPreferenceInt の後に呼び出す

サンプル

const result = await window.sticktv.getPreferenceInt('', '');
console.log(result);

void setPreferenceBoolean(string type, string key, bool value)

真偽値を平文で保存。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

真偽値を平文で保存。Windows 第 3 引数は実装上 object 型（JS からは真偽値を渡す）。対応する getPreferenceBoolean は設定後に呼び出す

サンプル

window.sticktv.setPreferenceBoolean('', '', true);

string getPreferenceBoolean(string type, string key)

"true" / "false" を返す。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

前提・後続 API

"true" / "false" を返す。対応する setPreferenceBoolean の後に呼び出す

サンプル

const result = await window.sticktv.getPreferenceBoolean('', '');
console.log(result);

void initPreference()

設定を全てリセット。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

前提・後続 API

設定を全てリセット。getPreference* の前に呼び出すと保存済み値が失われるため注意

サンプル

window.sticktv.initPreference();

void setVar(string key, string value)

Windows は value に bool / int を渡すと文字列化して保存（それ以外の型は警告）。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

Windows は value に bool / int を渡すと文字列化して保存（それ以外の型は警告）。対応する getVar は設定後に呼び出す

サンプル

window.sticktv.setVar('', '');

string getVar(string key)

未登録キーは永続化領域から読み込み、通常は空文字。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

前提・後続 API

未登録キーは永続化領域から読み込み、通常は空文字。Windows 版では Preference 復号に失敗すると例外が発生する可能性がある。対応する setVar の後に呼び出す

サンプル

const result = await window.sticktv.getVar('');
console.log(result);

void removeVar(string key)

一時領域と永続化領域の両方から削除。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

一時領域と永続化領域の両方から削除。対応する setVar 実行後に呼び出す

サンプル

window.sticktv.removeVar('');

bool fileExists(string path)

path には file:// URI も許容。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

備考

他 API との呼び出し順序の前提はない

サンプル

const ok = await window.sticktv.fileExists('%APP%/data/file.txt');
if (!ok) console.error('fileExists 失敗');

void removeFile(string path)

path には file:// URI も許容。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

path には file:// URI も許容。fileExists で存在確認後に呼び出すことを推奨

サンプル

window.sticktv.removeFile('%APP%/data/file.txt');

void removeFolder(string path)

フォルダを再帰削除。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

フォルダを再帰削除。path には file:// URI も許容。getFolderTree 等で対象を確認後に呼び出すことを推奨

サンプル

window.sticktv.removeFolder('%APP%/data/file.txt');

void removeFolder2Day(string path)

作成から 2 日以上経過したファイルを削除。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

備考

path には file:// URI も許容。Android はバックグラウンドスレッドで実行し、呼び出しは即座に返る。他 API との呼び出し順序の前提はない

サンプル

window.sticktv.removeFolder2Day('%APP%/data/file.txt');

bool writeFile(string path, string text)

UTF-8 で上書き保存。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

備考

path には file:// URI も許容。親フォルダは自動作成。対象パスは getFilesDir 等で取得することが多い

サンプル

const ok = await window.sticktv.writeFile('%APP%/data/file.txt', '');
if (!ok) console.error('writeFile 失敗');

bool writeFileCSV(string path, string text)

BOM 付き UTF-8 で上書き保存。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

備考

path には file:// URI も許容。対象パスは getFilesDir 等で取得することが多い

サンプル

const ok = await window.sticktv.writeFileCSV('%APP%/data/file.txt', '');
if (!ok) console.error('writeFileCSV 失敗');

string getFolderList(string path)

Windows: サブフォルダも含む相対パスを改行区切りで返す。

• 対応プラットフォーム: Windows △ / Android △
• 戻り値: string

引数

戻り値

前提・後続 API

Windows: サブフォルダも含む相対パスを改行区切りで返す。Android: 直下ファイル名のみを改行区切りで返す。path には file:// URI も許容。removeFolder / writeFile の前に呼び出すことを推奨

サンプル

const result = await window.sticktv.getFolderList('%APP%/data/file.txt');
console.log(result);

string getFolderTree(string path)

サブフォルダを含む相対パス一覧（/ 区切り、改行区切り）。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

前提・後続 API

サブフォルダを含む相対パス一覧（/ 区切り、改行区切り）。path には file:// URI も許容。removeFolder / writeFile の前に呼び出すことを推奨

サンプル

const result = await window.sticktv.getFolderTree('%APP%/data/file.txt');
console.log(result);

string getDirList(string path)

ファイル・フォルダ名を改行区切りで返す。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

前提・後続 API

ファイル・フォルダ名を改行区切りで返す。path には file:// URI も許容。removeFolder / writeFile の前に呼び出すことを推奨

サンプル

const result = await window.sticktv.getDirList('%APP%/data/file.txt');
console.log(result);

string getFilesDir()

Windows はアプリ作業ディレクトリの絶対パス。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

戻り値

備考

Android はキャッシュディレクトリの絶対パス。writeFile / getUrl 等のパス取得に使うことが多い

サンプル

const result = await window.sticktv.getFilesDir();
console.log(result);

void unzipfile(string zipFilePath, string destinationPath, string password)

ZIP 解凍。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

ZIP 解凍。zipFilePath / destinationPath には file:// URI も許容。パスワード付き ZIP も両プラットフォームで対応。fileExists で対象 ZIP の存在を確認後に呼び出すことを推奨

サンプル

window.sticktv.unzipfile('', '', '');

string convAppUrl(string url)

%APP% / %HOME% を展開した URL を返す。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

前提・後続 API

%APP% / %HOME% を展開した URL を返す。getUrl / loadUrl 等の前に呼び出すことがある

サンプル

const result = await window.sticktv.convAppUrl('https://example.com/');
console.log(result);

string convAppPath(string path)

%APP% / %HOME% を展開したローカルパスを返す。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

前提・後続 API

%APP% / %HOME% を展開したローカルパスを返す。writeFile / getUrl 等の前に呼び出すことがある

サンプル

const result = await window.sticktv.convAppPath('%APP%/data/file.txt');
console.log(result);

void decodeLogs()

暗号化ログを復号してテキストファイルに保存（詳細は 2.25）。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

前提・後続 API

暗号化ログを復号してテキストファイルに保存（詳細は 2.25）。log 出力後に呼び出す

サンプル

window.sticktv.decodeLogs();

string pickFile(string optionsJson)

ファイル選択ダイアログを開く。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

optionsJson の JSON スキーマ

戻り値 JSON スキーマ

成功時:

{"uri":"file:///C:/path/to/file.jpg","name":"file.jpg"}

キャンセル時:

{"cancelled":true}

前提・後続 API

ファイル選択ダイアログを開く。戻り値は {"uri":"...", "name":"..."}。キャンセル時は {"cancelled":true}。Windows では file:///... URI、Android では content://... URI。取得した uri は getUrl 等の前に使う

サンプル

const result = await window.sticktv.pickFile(JSON.stringify({}));
console.log(result);

void asyncPickFile(string optionsJson, string callback)

pickFile の非同期版。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

optionsJson の JSON スキーマ

コールバック JSON スキーマ

成功時:

{"uri":"file:///C:/path/to/file.jpg","name":"file.jpg"}

キャンセル時:

{"cancelled":true}

前提・後続 API

pickFile の非同期版。完了時 callback(resultJson) を実行。コールバック関数名は事前に定義しておくこと

サンプル

function onResult(json) {
  const data = JSON.parse(json);
  console.log(data);
}

window.sticktv.asyncPickFile(JSON.stringify({}), 'onResult');

string pickFiles(string optionsJson)

複数ファイル選択。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

optionsJson の JSON スキーマ

戻り値 JSON スキーマ

成功時:

{"items":[{"uri":"...","name":"..."}]}

前提・後続 API

複数ファイル選択。戻り値は {"items":[{"uri":"...", "name":"..."}, ...]}. 取得した各 uri は getUrl 等の前に使う

サンプル

const result = await window.sticktv.pickFiles(JSON.stringify({}));
console.log(result);

void asyncPickFiles(string optionsJson, string callback)

pickFiles の非同期版。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

optionsJson の JSON スキーマ

コールバック JSON スキーマ

成功時:

{"items":[{"uri":"...","name":"..."}]}

前提・後続 API

pickFiles の非同期版。コールバック関数名は事前に定義しておくこと

サンプル

function onResult(json) {
  const data = JSON.parse(json);
  console.log(data);
}

window.sticktv.asyncPickFiles(JSON.stringify({}), 'onResult');

string pickFolder(string optionsJson)

フォルダ選択ダイアログを開く。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

optionsJson の JSON スキーマ

戻り値 JSON スキーマ

成功時:

{"uri":"file:///C:/path/to/file.jpg","name":"file.jpg"}

キャンセル時:

{"cancelled":true}

前提・後続 API

フォルダ選択ダイアログを開く。戻り値形式は pickFile と同じ。取得した uri は getFolderTree / writeFile 等の前に使う

サンプル

const result = await window.sticktv.pickFolder(JSON.stringify({}));
console.log(result);

void asyncPickFolder(string optionsJson, string callback)

pickFolder の非同期版。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

optionsJson の JSON スキーマ

コールバック JSON スキーマ

成功時:

{"uri":"file:///C:/path/to/file.jpg","name":"file.jpg"}

キャンセル時:

{"cancelled":true}

前提・後続 API

pickFolder の非同期版。コールバック関数名は事前に定義しておくこと

サンプル

function onResult(json) {
  const data = JSON.parse(json);
  console.log(data);
}

window.sticktv.asyncPickFolder(JSON.stringify({}), 'onResult');

string saveFile(string optionsJson)

保存先ファイル選択ダイアログを開く。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

optionsJson の JSON スキーマ

戻り値 JSON スキーマ

成功時:

{"uri":"file:///C:/path/to/file.jpg","name":"file.jpg"}

キャンセル時:

{"cancelled":true}

前提・後続 API

保存先ファイル選択ダイアログを開く。defaultFileName で初期ファイル名を指定可。戻り値の uri は writeFile の前に使う

サンプル

const result = await window.sticktv.saveFile(JSON.stringify({}));
console.log(result);

void asyncSaveFile(string optionsJson, string callback)

saveFile の非同期版。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

optionsJson の JSON スキーマ

コールバック JSON スキーマ

成功時:

{"uri":"file:///C:/path/to/file.jpg","name":"file.jpg"}

キャンセル時:

{"cancelled":true}

前提・後続 API

saveFile の非同期版。コールバック関数名は事前に定義しておくこと

サンプル

function onResult(json) {
  const data = JSON.parse(json);
  console.log(data);
}

window.sticktv.asyncSaveFile(JSON.stringify({}), 'onResult');

bool downloadPath(string path, string url)

同期的にダウンロードして待つ。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

前提・後続 API

同期的にダウンロードして待つ。path には file:// URI も許容。UI がブロックされることがある。ダウンロード後に getUrl / getDataBase64 等で内容を読むことが多い

サンプル

const ok = await window.sticktv.downloadPath('%APP%/data/file.txt', 'https://example.com/');
if (!ok) console.error('downloadPath 失敗');

void asyncDownloadPath(string path, string url)

Windows も真に非同期（Task.Run）。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

備考

path には file:// URI も許容。完了を待たない。完了検知は個別に実装する必要がある

サンプル

window.sticktv.asyncDownloadPath('%APP%/data/file.txt', 'https://example.com/');

bool asyncDownloadPath(string path, string url, bool overwrite)

開始可否を返す。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

備考

path には file:// URI も許容。ダウンロード完了は待たない。overwrite=false で既存ファイル時はスキップ

サンプル

const ok = await window.sticktv.asyncDownloadPath('%APP%/data/file.txt', 'https://example.com/', true);
if (!ok) console.error('asyncDownloadPath 失敗');

string getUrl(string url)

指定 URL / file パスの内容を文字列で取得。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

前提・後続 API

指定 URL / file パスの内容を文字列で取得。file:// URI も許容。pickFile / downloadPath / convAppUrl の後に呼び出すことが多い

サンプル

const result = await window.sticktv.getUrl('https://example.com/');
console.log(result);

void asyncGetUrl(string url, string callback)

非同期取得。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

非同期取得。url には file:// URI も許容。callback('エスケープ済み文字列') で通知。コールバック関数名は事前に定義しておくこと

サンプル

function onResult(json) {
  const data = JSON.parse(json);
  console.log(data);
}

window.sticktv.asyncGetUrl('https://example.com/', 'onResult');

void shrinkPhoto(string path, int width, int height, bool reverseUpDown, bool reverseLeftRight)

リサイズして JPEG 上書き保存。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

リサイズして JPEG 上書き保存。path には file:// URI も許容。Windows 版は reverseUpDown / reverseLeftRight を無視（Android のみ反転が有効）。getDataBase64 / openaiChatImage の前に呼び出すことを推奨

サンプル

window.sticktv.shrinkPhoto('%APP%/data/file.txt', 0, 0, true, true);

string getPhotoSize(string path)

画像の実サイズを "幅x高さ" で返す。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

前提・後続 API

画像の実サイズを "幅x高さ" で返す。path には file:// URI も許容。shrinkPhoto / getDataBase64 の前に呼び出すことがある

サンプル

const result = await window.sticktv.getPhotoSize('%APP%/data/file.txt');
console.log(result);

void saveJpeg(string filePath, string data)

Base64 画像を JPEG として保存。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

Base64 画像を JPEG として保存。filePath には file:// URI も許容。保存後に getDataBase64 / getUrl 等で読み出す

サンプル

window.sticktv.saveJpeg('%APP%/data/file.txt', 'data:image/png;base64,...');

string getDataBase64(string path)

PNG に変換した data:image/png;base64,... を返す。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

前提・後続 API

PNG に変換した data:image/png;base64,... を返す。path には file:// URI も許容。失敗時は空文字。openaiChatImage / asyncOpenaiChatImage / getUrlBase64 の前に呼び出すことが多い

サンプル

const result = await window.sticktv.getDataBase64('%APP%/data/file.txt');
console.log(result);

string getUrlBase64(string url)

data:<mime>;base64,... または file:// URI から取得。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

前提・後続 API

data:<mime>;base64,... または file:// URI から取得。失敗時は空文字。openaiChatImage の前に呼び出すことがある

サンプル

const result = await window.sticktv.getUrlBase64('https://example.com/');
console.log(result);

string getFileBytes(string filename)

ファイル内容を Base64 文字列で返す。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

備考

filename には file:// URI も許容。他 API との呼び出し順序の前提はない

サンプル

const result = await window.sticktv.getFileBytes('%APP%/data/file.txt');
console.log(result);

int printPngUrl(string url)

Windows は PNG を既定プリンタへ印刷。

• 対応プラットフォーム: Windows △ / Android △
• 戻り値: int

引数

戻り値

備考

url には file:// URI も許容。戻り値は 原則 0（内部の印刷失敗は握りつぶされ、JsObject レベルで外部例外が発生した場合のみ -1）。Android は未実装で通常 固定値 -999999 を返す。許可ドメイン外では -1。他 API との呼び出し順序の前提はない

サンプル

const result = await window.sticktv.printPngUrl('https://example.com/');
console.log(result);

string scanTwainListDevices()

[{"id":"...","name":"..."}] 形式。

• 対応プラットフォーム: Windows ○ / Android ×
• 戻り値: string

戻り値

戻り値 JSON スキーマ

[{"id":"...","name":"..."}]

前提・後続 API

[{"id":"...","name":"..."}] 形式。失敗時は "[]"。取得後、得た id を使って scanTwainImage() / asyncScanTwainImage() を呼び出す

サンプル

const result = await window.sticktv.scanTwainListDevices();
console.log(result);

string scanTwainImage(string optionsJson)

成功時は {"success":true,"base64":"data:image/png;base64,...","width":...,"height":...,"dpi":...,"colorMode":"..."}。

• 対応プラットフォーム: Windows ○ / Android ×
• 戻り値: string

引数

戻り値

optionsJson の JSON スキーマ

戻り値 JSON スキーマ

成功時:

{"success":true,"base64":"data:image/png;base64,...","width":...,"height":...,"dpi":...,"colorMode":"..."}

失敗時:

{"success":false,"error":"..."}

前提・後続 API

成功時は {"success":true,"base64":"data:image/png;base64,...","width":...,"height":...,"dpi":...,"colorMode":"..."}。失敗時は {"success":false,"error":"..."}。実際にスキャンする前に scanTwainListDevices() で対象 id を取得しておくこと

サンプル

const result = await window.sticktv.scanTwainImage(JSON.stringify({}));
console.log(result);

void asyncScanTwainImage(string optionsJson, string callback)

非同期版。

• 対応プラットフォーム: Windows ○ / Android ×
• 戻り値: void

引数

optionsJson の JSON スキーマ

コールバック JSON スキーマ

成功時:

{"success":true,"base64":"data:image/png;base64,...","width":...,"height":...,"dpi":...,"colorMode":"..."}

失敗時:

{"success":false,"error":"..."}

前提・後続 API

非同期版。完了時に callback(resultJson) を実行。呼び出し前に scanTwainListDevices() で対象 id を取得しておくこと

サンプル

function onResult(json) {
  const data = JSON.parse(json);
  console.log(data);
}

window.sticktv.asyncScanTwainImage(JSON.stringify({}), 'onResult');

bool printWrite(string base64Bytes, string optionsJson)

Base64 エンコードされた ESC/POS バイト列を印刷。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

optionsJson の JSON スキーマ

接続タイプ共通:

usb-serial:

usb-print:

tcp:

usb（Android USB ホスト）:

bluetooth-spp:

前提・後続 API

Base64 エンコードされた ESC/POS バイト列を印刷。接続は毎回オープン・書き込み・クローズ。呼び出し前に printListDevices() で対象 port / devicePath / address などを確認し、optionsJson に含めることを推奨

サンプル

const ok = await window.sticktv.printWrite('', JSON.stringify({}));
if (!ok) console.error('printWrite 失敗');

string printListDevices()

利用可能な印刷デバイスの JSON 配列。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

戻り値

戻り値 JSON スキーマ

[
  {"type":"usb-serial","name":"COM3","port":"COM3"},
  {"type":"usb-print","name":"USB 印刷","devicePath":"\\?\usb#..."},
  {"type":"tcp","name":"192.168.1.10:9100","host":"192.168.1.10","port":9100},
  {"type":"usb","name":"USB Device","vendorId":1305,"productId":1},
  {"type":"bluetooth-spp","name":"Printer","address":"AA:BB:CC:DD:EE:FF"}
]

前提・後続 API

利用可能な印刷デバイスの JSON 配列。Windows は COM ポート、USB-Print デバイス、ペアリング済み Bluetooth SPP デバイスを列挙。Android は USB ホストデバイスとペアリング済み Bluetooth SPP デバイスを列挙。取得結果をもとに printWrite() / printReceipt() を呼び出す

サンプル

const result = await window.sticktv.printListDevices();
console.log(result);

bool printReceipt(string receiptLineMarkup, string optionsJson)

sticktv_stub.js 提供のヘルパー。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

optionsJson の JSON スキーマ

接続タイプ共通:

usb-serial:

usb-print:

tcp:

usb（Android USB ホスト）:

bluetooth-spp:

receiptline フィールドの JSON スキーマ

{ "command": "escpos", "encoding": "shiftjis", "cpl": 32 }

前提・後続 API

sticktv_stub.js 提供のヘルパー。ReceiptLine マークアップを変換して printWrite を実行。ネイティブ JsObject には存在しない。printListDevices() で対象を確認してから呼び出すことを推奨

サンプル

const ok = await window.sticktv.printReceipt('', JSON.stringify({}));
if (!ok) console.error('printReceipt 失敗');

void openSubFrameVideo(int x, int y, int w, int h, float scale, string url)

動画サブフレームを開く。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

動画サブフレームを開く。url には file:// URI も許容。開いた後に setSubFrameVideo() / setSubFrameVideoVisibility() を使う。終了時は closeSubFrameVideo() を呼び出すこと

サンプル

window.sticktv.openSubFrameVideo(0, 0, 0, 0, 1.0, 'https://example.com/');

void closeSubFrameVideo()

開いた動画サブフレームを閉じる。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

前提・後続 API

開いた動画サブフレームを閉じる。openSubFrameVideo() の後に対となるように呼び出すこと

サンプル

window.sticktv.closeSubFrameVideo();

void setSubFrameVideo(string url)

再生中サブフレームの URL を変更。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

再生中サブフレームの URL を変更。url には file:// URI も許容。openSubFrameVideo() 後に呼び出すこと

サンプル

window.sticktv.setSubFrameVideo('https://example.com/');

void setSubFrameVideoVisibility(bool visible)

表示/非表示を切り替える。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

表示/非表示を切り替える。openSubFrameVideo() 後に呼び出すこと

サンプル

window.sticktv.setSubFrameVideoVisibility(true);

備考（Windows 版）: 終了時やエラー時にはリプレイ用オーバーレイ画像が表示され、動画サブフレームはマウス左クリックで先頭から再生し直せます。

void openSubFrameWindow(int x, int y, int w, int h, float scale, string url)

子ウィンドウを開く。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

子ウィンドウを開く。url には file:// URI も許容。Windows はサイズ・倍率が有効な場合のみ開始。Android は url を指定して即座に読み込む。開いた後に evalSubFrameWindow() / setSubFrameWindowVisibility() を使う。終了時は closeSubFrameWindow() を呼び出すこと

サンプル

window.sticktv.openSubFrameWindow(0, 0, 0, 0, 1.0, 'https://example.com/');

void closeSubFrameWindow()

子ウィンドウを閉じる（動画サブフレームも同時に閉じる）。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

前提・後続 API

子ウィンドウを閉じる（動画サブフレームも同時に閉じる）。openSubFrameWindow() の後に対となるように呼び出すこと

サンプル

window.sticktv.closeSubFrameWindow();

void setSubFrameWindowVisibility(bool visible)

表示/非表示を切り替える。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

表示/非表示を切り替える。openSubFrameWindow() 後に呼び出すこと

サンプル

window.sticktv.setSubFrameWindowVisibility(true);

void evalSubFrameWindow(string exp)

サブフレーム（本節の子ウィンドウ）内で JavaScript を評価（結果は取得できない）。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

サブフレーム（本節の子ウィンドウ）内で JavaScript を評価（結果は取得できない）。openSubFrameWindow() で開いた対象に対して使用する。終了時は closeSubFrameWindow() を呼び出すこと

サンプル

window.sticktv.evalSubFrameWindow('');

void startFaceDetect(string callback, bool isFlipY)

カメラを開始して検出。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

カメラを開始して検出。callback は呼び出し前に定義しておくこと。停止時は対となる stopFaceDetect() を呼び出すこと

サンプル

function onResult(json) {
  const data = JSON.parse(json);
  console.log(data);
}

window.sticktv.startFaceDetect('onResult', true);

void stopFaceDetect()

カメラと顔検出を停止。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

前提・後続 API

カメラと顔検出を停止。startFaceDetect() の後に対となるように呼び出すこと

サンプル

window.sticktv.stopFaceDetect();

bool enableFaceDetect()

設定（useFaceDetect / FACEDETECT）の値を返す。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

戻り値

備考

機能が有効になってから startFaceDetect() を使うことを推奨

サンプル

const ok = await window.sticktv.enableFaceDetect();
if (!ok) console.error('enableFaceDetect 失敗');

bool startObjectDetect(string callback, string modelPath, string labelsJson, double confidence)

Windows は起動失敗時に false。

• 対応プラットフォーム: Windows ○ / Android △
• 戻り値: bool

引数

戻り値

labelsJson の JSON スキーマ

空文字の場合は既定ラベル（YOLO 系は COCO 80 クラス、Faster R-CNN は torchvision COCO 91 クラス）を使用します。カスタムラベルを指定する場合は以下のいずれかの形式を使用します。

["person", "car", "dog"]

または、クラス ID からラベル名へのマップ:

{"0":"person","1":"car","2":"dog"}

コールバック JSON スキーマ

成功時:

[{ "label": "person", "score": 0.85, "x": 10, "y": 20, "w": 100, "h": 200 }]

失敗時:

{"error":"エラーメッセージ"}

前提・後続 API

Windows は起動失敗時に false。Android は受け付け次第 true を返す。callback は呼び出し前に定義しておくこと。modelPath は有効な ONNX ファイルを指定。停止時は対となる stopObjectDetect() を呼び出すこと

サンプル

function onResult(json) {
  const data = JSON.parse(json);
  console.log(data);
}

const ok = await window.sticktv.startObjectDetect('onResult', '%APP%/models/yolov8n.onnx', '', 0.5);
if (!ok) console.error('startObjectDetect 失敗');

備考

• confidence: 信頼度しきい値（0.0〜1.0）。このスコア以上の検出のみ返します。
• modelPath は ONNX モデルのパス（例: %APP%/models/model.onnx）。
• startObjectDetect の callback(json) は 3 フレーム連続で同一物体と判定された後、かつ検出ラベル・個数のシグネチャに変化があったとき に呼ばれます（フレーム毎の連続通知ではありません）。
• 顔検出（startFaceDetect）と同時にはカメラを共有できません（排他運用）。
• 旧称 yoloDetect* / getYoloDeviceInfo / setYoloGpuDevice は stub 環境でのみ存在する互換エイリアスです。ネイティブ JsObject には存在しません。新規実装では objectDetect* / getObjectDetectDeviceInfo / setObjectDetectGpuDevice を使用してください。

bool stopObjectDetect()

Windows は動作中以降 true。

• 対応プラットフォーム: Windows ○ / Android △
• 戻り値: bool

戻り値

前提・後続 API

Windows は動作中以降 true。**Android は常に true**。startObjectDetect()` の後に対となるように呼び出すこと

サンプル

const ok = await window.sticktv.stopObjectDetect();
if (!ok) console.error('stopObjectDetect 失敗');

string objectDetectImage(string imagePath, string modelPath, string labelsJson, double confidence)

静止画を 1 回検出。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

labelsJson の JSON スキーマ

空文字の場合は既定ラベル（YOLO 系は COCO 80 クラス、Faster R-CNN は torchvision COCO 91 クラス）を使用します。カスタムラベルを指定する場合は以下のいずれかの形式を使用します。

["person", "car", "dog"]

または、クラス ID からラベル名へのマップ:

{"0":"person","1":"car","2":"dog"}

戻り値 JSON スキーマ

成功時:

[{ "label": "person", "score": 0.85, "x": 10, "y": 20, "w": 100, "h": 200 }]

失敗時:

{"error":"エラーメッセージ"}

備考

imagePath には file:// URI も許容。結果 JSON を返す。getObjectDetectDeviceInfo() / setObjectDetectGpuDevice() でデバイスを確認・選択してから使うことを推奨

サンプル

const result = await window.sticktv.objectDetectImage('', '%APP%/models/yolov8n.onnx', '', 0.5);
console.log(result);

string objectDetectBase64(string base64, string modelPath, string labelsJson, double confidence)

Base64（data: URL 可）画像を 1 回検出。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

labelsJson の JSON スキーマ

空文字の場合は既定ラベル（YOLO 系は COCO 80 クラス、Faster R-CNN は torchvision COCO 91 クラス）を使用します。カスタムラベルを指定する場合は以下のいずれかの形式を使用します。

["person", "car", "dog"]

または、クラス ID からラベル名へのマップ:

{"0":"person","1":"car","2":"dog"}

戻り値 JSON スキーマ

成功時:

[{ "label": "person", "score": 0.85, "x": 10, "y": 20, "w": 100, "h": 200 }]

失敗時:

{"error":"エラーメッセージ"}

備考

ファイル保存なし。getObjectDetectDeviceInfo() / setObjectDetectGpuDevice() でデバイスを確認・選択してから使うことを推奨

サンプル

const result = await window.sticktv.objectDetectBase64('', '%APP%/models/yolov8n.onnx', '', 0.5);
console.log(result);

string getObjectDetectDeviceInfo()

Windows はプロバイダ/GPU 一覧 JSON。

• 対応プラットフォーム: Windows ○ / Android △
• 戻り値: string

戻り値

戻り値 JSON スキーマ

{ "provider": "...", "deviceId": 0, "gpu": "GPU名",
  "adapters": [{ "id": 0, "name": "GPU名", "vramMB": 8128 }] }

getObjectDetectDeviceInfo() は Android では CPU 固定の固定 JSON を返します。 |

前提・後続 API

Windows はプロバイダ/GPU 一覧 JSON。Android は CPU 固定の固定 JSON。objectDetectImage() / objectDetectBase64() の前に確認してから、setObjectDetectGpuDevice() を使うことを推奨

サンプル

const result = await window.sticktv.getObjectDetectDeviceInfo();
console.log(result);

bool setObjectDetectGpuDevice(int deviceId)

Android は常に false（CPU 固定）。

• 対応プラットフォーム: Windows ○ / Android ×
• 戻り値: bool

引数

戻り値

前提・後続 API

Android は常に false（CPU 固定）。getObjectDetectDeviceInfo() 後に、objectDetectImage() / objectDetectBase64() 前に呼び出すことを推奨

サンプル

const ok = await window.sticktv.setObjectDetectGpuDevice(0);
if (!ok) console.error('setObjectDetectGpuDevice 失敗');

bool bleScanStart(int seconds)

seconds 秒間スキャン。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

前提・後続 API

seconds 秒間スキャン。失敗時 false。スキャン後は必ず bleScanResult() を呼び出して結果を取得すること

サンプル

const ok = await window.sticktv.bleScanStart(5);
if (!ok) console.error('bleScanStart 失敗');

bool bleScanStop()

bleScanStart() 中のスキャンを停止。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

戻り値

前提・後続 API

bleScanStart() 中のスキャンを停止。通常はスキャン時間が経過しても結果を取るため bleScanResult() を呼び出すこと

サンプル

const ok = await window.sticktv.bleScanStop();
if (!ok) console.error('bleScanStop 失敗');

string bleScanResult()

[{"address":"...","name":"...","rssi":-52, "deviceType":"..."}, ...]。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

戻り値

戻り値 JSON スキーマ

[{"address":"aa:bb:cc:dd:ee:ff","name":"SwitchBot","rssi":-52,"deviceType":"..."}]

前提・後続 API

[{"address":"...","name":"...","rssi":-52, "deviceType":"..."}, ...]。なければ "[]"。bleScanStart() 後に必ず呼び出すこと。取得した address をもとに各種 switchBot* を呼び出す。スキャン完了までに時間がかかることがあるため、bleScanStart(seconds) の完了後、1 秒程度の間隔を空けてから bleScanResult() を呼び出し、空配列の場合は数回に分けて再取得することを推奨する

サンプル

const result = await window.sticktv.bleScanResult();
console.log(result);

bool switchBotOn(string address)

Bot を ON（押し込んだ状態を保持）。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

前提・後続 API

Bot を ON（押し込んだ状態を保持）。呼び出し前に bleScanStart() → bleScanResult() で対象 address を取得しておくこと

サンプル

const ok = await window.sticktv.switchBotOn('AA:BB:CC:DD:EE:FF');
if (!ok) console.error('switchBotOn 失敗');

bool switchBotOff(string address)

Bot を OFF（押し戻しを保持）。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

前提・後続 API

Bot を OFF（押し戻しを保持）。呼び出し前に bleScanStart() → bleScanResult() で対象 address を取得しておくこと

サンプル

const ok = await window.sticktv.switchBotOff('AA:BB:CC:DD:EE:FF');
if (!ok) console.error('switchBotOff 失敗');

bool switchBotPress(string address)

押してすぐ戻す。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

前提・後続 API

押してすぐ戻す。呼び出し前に bleScanStart() → bleScanResult() で対象 address を取得しておくこと

サンプル

const ok = await window.sticktv.switchBotPress('AA:BB:CC:DD:EE:FF');
if (!ok) console.error('switchBotPress 失敗');

bool switchBotPlugMiniOn(string address)

プラグミニ ON。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

前提・後続 API

プラグミニ ON。呼び出し前に bleScanStart() → bleScanResult() で対象 address を取得しておくこと

サンプル

const ok = await window.sticktv.switchBotPlugMiniOn('AA:BB:CC:DD:EE:FF');
if (!ok) console.error('switchBotPlugMiniOn 失敗');

bool switchBotPlugMiniOff(string address)

プラグミニ OFF。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

前提・後続 API

プラグミニ OFF。呼び出し前に bleScanStart() → bleScanResult() で対象 address を取得しておくこと

サンプル

const ok = await window.sticktv.switchBotPlugMiniOff('AA:BB:CC:DD:EE:FF');
if (!ok) console.error('switchBotPlugMiniOff 失敗');

bool switchBotPlugMiniToggle(string address)

プラグミニ トグル。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

前提・後続 API

プラグミニ トグル。呼び出し前に bleScanStart() → bleScanResult() で対象 address を取得しておくこと

サンプル

const ok = await window.sticktv.switchBotPlugMiniToggle('AA:BB:CC:DD:EE:FF');
if (!ok) console.error('switchBotPlugMiniToggle 失敗');

bool setSwitchBotRemoteCallback(string callback)

Remote Button 等のイベントを callback(json) で通知。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

コールバック JSON スキーマ

{"event":"remoteButtonPressed","mac":"AA:BB:CC:DD:EE:FF","button":"upper|lower","source":"sniffer|peripheral","timestamp":"..."}

前提・後続 API

Remote Button 等のイベントを callback(json) で通知。callback は呼び出し前に定義しておくこと。受信を開始する前に呼び出すこと

サンプル

function onResult(json) {
  const data = JSON.parse(json);
  console.log(data);
}

const ok = await window.sticktv.setSwitchBotRemoteCallback('onResult');
if (!ok) console.error('setSwitchBotRemoteCallback 失敗');

備考

• Windows は Windows 10 以降 + Bluetooth LE アダプタ、Android は Bluetooth LE 対応端末が必要。Android 12 (API 31) 以降では BLUETOOTH_SCAN / BLUETOOTH_CONNECT のランタイム権限が必要です（起動時に要求）。
• setSwitchBotRemoteCallback のコールバックは JSON 文字列 1 引数。Remote Button 押下は {"event":"remoteButtonPressed","mac":"...","button":"upper|lower","source":"sniffer|peripheral","timestamp":"..."} 形式で通知されます。
• switchBotGetDeviceInfo の主なフィールド: Address, Name, Rssi, DeviceType, State, PowerW, Overload。
• 制御対象のデバイスやファームウェアによっては暗号化が必要です。

string switchBotGetDeviceInfo(string address)

デバイス詳細を JSON で返す。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

戻り値 JSON スキーマ

{"Address":"AA:BB:CC:DD:EE:FF","Name":"SwitchBot","Rssi":-52,"DeviceType":"Bot","State":true,"PowerW":0.0,"Overload":false}

失敗時:

{"error":"..."}

前提・後続 API

デバイス詳細を JSON で返す。失敗時は {"error":"..."}。呼び出し前に bleScanStart() → bleScanResult() で対象 address を取得しておくこと

サンプル

const result = await window.sticktv.switchBotGetDeviceInfo('AA:BB:CC:DD:EE:FF');
console.log(result);

bool usbSerialScanStart(int seconds)

NUS デバイスを seconds 秒間スキャン。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

前提・後続 API

NUS デバイスを seconds 秒間スキャン。失敗時 false。スキャン後は必ず usbSerialScanResult() を呼び出して結果を取得すること

サンプル

const ok = await window.sticktv.usbSerialScanStart(5);
if (!ok) console.error('usbSerialScanStart 失敗');

bool usbSerialScanStop()

usbSerialScanStart() 中のスキャンを停止。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

戻り値

前提・後続 API

usbSerialScanStart() 中のスキャンを停止。通常はスキャン時間が経過しても結果を取るため usbSerialScanResult() を呼び出すこと

サンプル

const ok = await window.sticktv.usbSerialScanStop();
if (!ok) console.error('usbSerialScanStop 失敗');

string usbSerialScanResult()

[{"address":"...","name":"...","rssi":-52}, ...]。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

戻り値

戻り値 JSON スキーマ

usbSerialScanResult() の配列要素:

前提・後続 API

[{"address":"...","name":"...","rssi":-52}, ...]。なければ "[]"。usbSerialScanStart() 後に必ず呼び出すこと。取得した address をもとに usbSerialConnect() を行う

サンプル

const result = await window.sticktv.usbSerialScanResult();
console.log(result);

bool usbSerialConnect(string address)

NUS デバイスに接続。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

前提・後続 API

NUS デバイスに接続。呼び出し前に usbSerialScanStart() → usbSerialScanResult() で対象 address を取得しておくこと。接続後に usbSerialWrite() / usbSerialSetReadCallback() / usbSerialSetEventCallback() を使う

サンプル

const ok = await window.sticktv.usbSerialConnect('AA:BB:CC:DD:EE:FF');
if (!ok) console.error('usbSerialConnect 失敗');

備考

• NUS Service UUID: 6E400001-B5A3-F393-E0A9-E50E24DCCA9E
• RX Characteristic UUID（送信先）: 6E400002-B5A3-F393-E0A9-E50E24DCCA9E
• TX Characteristic UUID（受信元）: 6E400003-B5A3-F393-E0A9-E50E24DCCA9E
• usbSerialConnect で接続を確立し、明示的に usbSerialDisconnect を呼ぶまで維持します。

bool usbSerialDisconnect(string address)

接続を切断。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

前提・後続 API

接続を切断。usbSerialConnect() の後に対となるように呼び出すこと

サンプル

const ok = await window.sticktv.usbSerialDisconnect('AA:BB:CC:DD:EE:FF');
if (!ok) console.error('usbSerialDisconnect 失敗');

bool usbSerialWrite(string address, string base64Data)

Base64 データを RX characteristic へ Write。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

前提・後続 API

Base64 データを RX characteristic へ Write。usbSerialConnect() 成功後に呼び出すこと

サンプル

const ok = await window.sticktv.usbSerialWrite('AA:BB:CC:DD:EE:FF', btoa('hello'));
if (!ok) console.error('usbSerialWrite 失敗');

bool usbSerialSetReadCallback(string address, string callback)

TX Notify 受信時に callback(json) を実行。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

コールバック JSON スキーマ

{"address":"...","base64":"..."}

前提・後続 API

TX Notify 受信時に callback(json) を実行。callback は呼び出し前に定義しておくこと。usbSerialConnect() 後に呼び出すことを推奨

サンプル

function onResult(json) {
  const data = JSON.parse(json);
  console.log(data);
}

const ok = await window.sticktv.usbSerialSetReadCallback('AA:BB:CC:DD:EE:FF', 'onResult');
if (!ok) console.error('usbSerialSetReadCallback 失敗');

bool usbSerialSetEventCallback(string address, string callback)

接続/切断/エラー時に callback(json) を実行。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

コールバック JSON スキーマ

{"address":"...","event":"connected|disconnected|error","message":"..."}

前提・後続 API

接続/切断/エラー時に callback(json) を実行。callback は呼び出し前に定義しておくこと。usbSerialConnect() 前または直後に設定しておくことを推奨

サンプル

function onResult(json) {
  const data = JSON.parse(json);
  console.log(data);
}

const ok = await window.sticktv.usbSerialSetEventCallback('AA:BB:CC:DD:EE:FF', 'onResult');
if (!ok) console.error('usbSerialSetEventCallback 失敗');

bool usbSerialIsConnected(string address)

接続状態を確認。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

前提・後続 API

接続状態を確認。usbSerialConnect() 後に usbSerialWrite() 等を呼び出す前に確認することが多い

サンプル

const ok = await window.sticktv.usbSerialIsConnected('AA:BB:CC:DD:EE:FF');
if (!ok) console.error('usbSerialIsConnected 失敗');

備考:

• NUS Service UUID: 6E400001-B5A3-F393-E0A9-E50E24DCCA9E
• RX Characteristic UUID（送信先）: 6E400002-B5A3-F393-E0A9-E50E24DCCA9E
• TX Characteristic UUID（受信元）: 6E400003-B5A3-F393-E0A9-E50E24DCCA9E

bool usbSerialStartPeripheral()

NUS サービスを登録し BLE アドバタイズを開始。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

戻り値

前提・後続 API

NUS サービスを登録し BLE アドバタイズを開始。既に開始済みの場合は false。開始後に usbSerialGetPeripheralInfo() / usbSerialSetPeripheralReadCallback() / usbSerialSetPeripheralEventCallback() を使い、通信開始後は usbSerialPeripheralWrite() を使う。停止時は usbSerialStopPeripheral() を呼び出すこと

サンプル

const ok = await window.sticktv.usbSerialStartPeripheral();
if (!ok) console.error('usbSerialStartPeripheral 失敗');

備考

• 使用する UUID は Central（セントラル）側と同じ NUS UUID です。
• Android では BLUETOOTH_ADVERTISE 権限（Android 12 以降はランタイム権限）が必要です。
• Windows では Bluetooth LE アダプタが必要です。アドバタイズ名は PC 名（Environment.MachineName）を使用します。

bool usbSerialStopPeripheral()

ペリフェラル停止。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

戻り値

前提・後続 API

ペリフェラル停止。接続中のセントラルも切断する。usbSerialStartPeripheral() の後に対となるように呼び出すこと

サンプル

const ok = await window.sticktv.usbSerialStopPeripheral();
if (!ok) console.error('usbSerialStopPeripheral 失敗');

string usbSerialGetPeripheralInfo()

{"address":"...","name":"...","advertising":true/false,"serviceUuid":"..."} 形式。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

戻り値

戻り値 JSON スキーマ

{"address":"...","name":"...","advertising":true,"serviceUuid":"..."}

前提・後続 API

{"address":"...","name":"...","advertising":true/false,"serviceUuid":"..."} 形式。MAC アドレス取得できない場合は "address":""。usbSerialStartPeripheral() 後に呼び出して自機の MAC やアドバタイズ状態を確認すること

サンプル

const result = await window.sticktv.usbSerialGetPeripheralInfo();
console.log(result);

bool usbSerialIsPeripheralConnected(string address)

指定 MAC のセントラルが接続中か確認。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

前提・後続 API

指定 MAC のセントラルが接続中か確認。空文字なら接続中があれば true。usbSerialStartPeripheral() 後に usbSerialPeripheralWrite() の前に確認することが多い

サンプル

const ok = await window.sticktv.usbSerialIsPeripheralConnected('AA:BB:CC:DD:EE:FF');
if (!ok) console.error('usbSerialIsPeripheralConnected 失敗');

bool usbSerialPeripheralWrite(string address, string base64Data)

指定セントラルへ TX Notify で Base64 データを送信。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

前提・後続 API

指定セントラルへ TX Notify で Base64 データを送信。空文字なら最初に見つかった接続先へ送信。usbSerialStartPeripheral() 実行後、セントラルから接続された状態で呼び出すこと

サンプル

const ok = await window.sticktv.usbSerialPeripheralWrite('AA:BB:CC:DD:EE:FF', btoa('hello'));
if (!ok) console.error('usbSerialPeripheralWrite 失敗');

bool usbSerialSetPeripheralReadCallback(string address, string callback)

RX 受信時に callback(json) を実行。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

コールバック JSON スキーマ

{"address":"...","base64":"..."}

前提・後続 API

RX 受信時に callback(json) を実行。address は無視され全セントラルで共有。callback は呼び出し前に定義しておくこと。usbSerialStartPeripheral() 後に設定しておくことを推奨

サンプル

function onResult(json) {
  const data = JSON.parse(json);
  console.log(data);
}

const ok = await window.sticktv.usbSerialSetPeripheralReadCallback('AA:BB:CC:DD:EE:FF', 'onResult');
if (!ok) console.error('usbSerialSetPeripheralReadCallback 失敗');

bool usbSerialSetPeripheralEventCallback(string address, string callback)

接続/切断/エラー時に callback(json) を実行。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: bool

引数

戻り値

コールバック JSON スキーマ

{"address":"...","event":"connected|disconnected|error","message":"..."}

前提・後続 API

接続/切断/エラー時に callback(json) を実行。address は無視され全セントラルで共有。callback は呼び出し前に定義しておくこと。usbSerialStartPeripheral() 後に設定しておくことを推奨

サンプル

function onResult(json) {
  const data = JSON.parse(json);
  console.log(data);
}

const ok = await window.sticktv.usbSerialSetPeripheralEventCallback('AA:BB:CC:DD:EE:FF', 'onResult');
if (!ok) console.error('usbSerialSetPeripheralEventCallback 失敗');

void startCommandServer(int port, string callback)

指定ポートで待ち受け開始。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

コールバック JSON スキーマ

{ "id": "...", "cmd": "foo", "payload": "...", "from": "192.168.1.10:52345" }

前提・後続 API

指定ポートで待ち受け開始。受信時 callback(commandJson) を実行。callback は呼び出し前に定義しておくこと。受信・応答を行うには先に呼び出すこと。停止時は stopCommandServer() を使うこと

サンプル

function onResult(json) {
  const data = JSON.parse(json);
  console.log(data);
}

window.sticktv.startCommandServer(0, 'onResult');

void stopCommandServer()

待ち受けを停止し、接続を解放。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

前提・後続 API

待ち受けを停止し、接続を解放。startCommandServer() の後に対となるように呼び出すこと

サンプル

window.sticktv.stopCommandServer();

string sendCommand(string target, string commandJson, int timeoutMs)

target は "ip:port" または "ble:<MAC>" 形式。 Windows 版は Task<T> のため JS 側で await が必要。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: string

引数

戻り値

commandJson の JSON スキーマ

{ "id": "...", "cmd": "foo", "payload": "..." }

responseJson の JSON スキーマ

{ "id": "...", "replyTo": "受信コマンドのid", "payload": "..." }

前提・後続 API

target は "ip:port" または "ble:<MAC>" 形式。応答 JSON を返す。Windows 版は Task<string> なので JS 側で await が必要。BLE 経由で送信する場合は事前に usbSerialConnect(mac) または usbSerialStartPeripheral() で接続しておくこと

サンプル

const result = await window.sticktv.sendCommand('192.168.1.5:9001', JSON.stringify({ cmd: 'ping' }), 5000);
console.log(result);

void asyncSendCommand(string target, string commandJson, string callback, int timeoutMs)

非同期版。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

commandJson の JSON スキーマ

{ "id": "...", "cmd": "foo", "payload": "..." }

コールバック JSON スキーマ

{ "id": "...", "replyTo": "受信コマンドのid", "payload": "..." }

前提・後続 API

非同期版。完了時 callback(responseJson) を実行。callback は呼び出し前に定義しておくこと。BLE 経由の場合は事前に usbSerialConnect(mac) / usbSerialStartPeripheral() で接続しておくこと

サンプル

function onResult(json) {
  const data = JSON.parse(json);
  console.log(data);
}

window.sticktv.asyncSendCommand('192.168.1.5:9001', JSON.stringify({ cmd: 'ping' }), 'onResult', 5000);

void sendCommandReply(string replyTo, string responseJson)

受信コマンドの id を replyTo に指定して応答を返す。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

responseJson の JSON スキーマ

{ "id": "...", "replyTo": "受信コマンドのid", "payload": "..." }

前提・後続 API

受信コマンドの id を replyTo に指定して応答を返す。startCommandServer() でコマンドを受信した後に呼び出すこと

サンプル

window.sticktv.sendCommandReply(cmd.id, '');

void setVolume(int volume)

0〜100。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

0〜100。必要に応じて getVolume() / getDefaultVolume() 後に呼び出すこと

サンプル

window.sticktv.setVolume(0);

int getVolume()

現在の音量を取得（取得失敗時 -1）。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: int

戻り値

前提・後続 API

現在の音量を取得（取得失敗時 -1）。取得後に setVolume() を調整することが多い

サンプル

const result = await window.sticktv.getVolume();
console.log(result);

int getDefaultVolume()

既定音量を取得。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: int

戻り値

前提・後続 API

既定音量を取得。取得後に setVolume() を調整することがある

サンプル

const result = await window.sticktv.getDefaultVolume();
console.log(result);

int getCallVolume()

Windows は常に 0（未対応）。

• 対応プラットフォーム: Windows △ / Android ○
• 戻り値: int

戻り値

備考

Windows は常に 0（未対応）

サンプル

const result = await window.sticktv.getCallVolume();
console.log(result);

int getTalkVolume()

Windows は常に 0（未対応）。

• 対応プラットフォーム: Windows △ / Android ○
• 戻り値: int

戻り値

備考

Windows は常に 0（未対応）

サンプル

const result = await window.sticktv.getTalkVolume();
console.log(result);

void setSpeakerPhone(bool mode)

Windows 未対応。

• 対応プラットフォーム: Windows × / Android ○
• 戻り値: void

引数

備考

Android では通話音声のスピーカー出力を切り替える

サンプル

window.sticktv.setSpeakerPhone(true);

void setKeepScreen(bool on)

画面の常時点灯を有効/無効にする。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

備考

解除時は false を指定するか、setKeepScreenBacklight(false) を使う

サンプル

window.sticktv.setKeepScreen(true);

void setKeepScreenBacklight(bool onOff)

setKeepScreen と同等。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

備考

常時点灯を有効/無効にする

サンプル

window.sticktv.setKeepScreenBacklight(true);

void setBacklight(float value)

Windows は未実装（何もしない）。

• 対応プラットフォーム: Windows × / Android ○
• 戻り値: void

引数

前提・後続 API

Windows は未実装（何もしない）。Android は輝度 0.0〜1.0 を設定。設定前に getBacklight() / getScreenBrightness() で現在値を確認することがある

サンプル

window.sticktv.setBacklight(1.0);

float getBacklight()

Windows は未対応で常に 0（ドメイン拒否時も 0）。

• 対応プラットフォーム: Windows △ / Android ○
• 戻り値: float

戻り値

前提・後続 API

Windows は未対応で常に 0（ドメイン拒否時も 0）。Android は現在の輝度（0.0〜1.0）。取得後に setBacklight() を使うことがある

サンプル

const value = await window.sticktv.getBacklight();

float getScreenBrightness()

Windows は未対応で常に 0（ドメイン拒否時も 0）。

• 対応プラットフォーム: Windows △ / Android ○
• 戻り値: float

戻り値

前提・後続 API

Windows は未対応で常に 0（ドメイン拒否時も 0）。Android は現在の輝度。取得後に setScreenBrightness() を使うことがある

サンプル

const value = await window.sticktv.getScreenBrightness();

void setScreenBrightness(float val)

Windows 未実装。

• 対応プラットフォーム: Windows × / Android ○
• 戻り値: void

引数

前提・後続 API

Windows 未実装。Android は輝度を設定。getScreenBrightness() 後に呼び出すことがある

サンプル

window.sticktv.setScreenBrightness(1.0);

void showLoading()

ローディング表示を開始。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

前提・後続 API

ローディング表示を開始。長時間処理の前に呼び出し、完了後に hideLoading() を呼び出すこと

サンプル

window.sticktv.showLoading();

void hideLoading()

ローディング非表示。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

前提・後続 API

ローディング非表示。showLoading() の後に対となるように呼び出すこと

サンプル

window.sticktv.hideLoading();

void setZoomEnable(bool enable)

false でズーム解除（Windows は ZoomFactor を 1.0 にリセット）。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

false でズーム解除（Windows は ZoomFactor を 1.0 にリセット）。通常はページ読み込み後に呼び出す

サンプル

window.sticktv.setZoomEnable(true);

void showTaskbar(bool show)

Windows 専用。

• 対応プラットフォーム: Windows ○ / Android ×
• 戻り値: void

引数

備考

タスクバー表示/非表示を切り替える

サンプル

window.sticktv.showTaskbar(true);

void showTopmost(bool topmost)

Windows 専用。

• 対応プラットフォーム: Windows ○ / Android ×
• 戻り値: void

引数

備考

最前面表示の切り替え

サンプル

window.sticktv.showTopmost(true);

void startLockTask()

キオスク（ロックタスク）開始。

• 対応プラットフォーム: Windows × / Android ○
• 戻り値: void

前提・後続 API

キオスク（ロックタスク）開始。Windows 未対応。終了時は stopLockTask() を呼び出すこと

サンプル

window.sticktv.startLockTask();

void stopLockTask()

キオスク解除。

• 対応プラットフォーム: Windows × / Android ○
• 戻り値: void

前提・後続 API

キオスク解除。Windows 未対応。startLockTask() の後に対となるように呼び出すこと

サンプル

window.sticktv.stopLockTask();

void startTTS(string talktext)

Windows は System.Speech（日本語音声を優先選択）、Android は TTS エンジンで発話を開始。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

Windows は System.Speech（日本語音声を優先選択）、Android は TTS エンジンで発話を開始。連続して発話する場合は stopTTS() 後に次の startTTS() を呼び出すことを推奨

サンプル

window.sticktv.startTTS('');

void stopTTS()

発話を停止。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

前提・後続 API

発話を停止。startTTS() の後に対となるように呼び出すこと

サンプル

window.sticktv.stopTTS();

void startSTT(string sttCallback, int interval)

音声認識を開始。

• 対応プラットフォーム: Windows ○ / Android ○
• 戻り値: void

引数

前提・後続 API

音声認識を開始。認識結果は sttCallback('音声認識:...')、エラーは sttCallback('音声認識エラー:...') で通知。sttCallback は呼び出し前に定義しておくこと。Windows は System.Speech.Recognition を使用。停止時は stopSTT() を呼び出すこと

サンプル

window.sticktv.startSTT('', 0);

void stopSTT()