端末制御モジュール共通の機能一覧

 

 

Biz/Browser HTと外部サービスを連携する機能「ExternalService」クラスを用いて使用することができるメソッドの一覧です。
本項では、端末制御モジュール共通で使用可能な機能を説明します。

 

目次

 

メソッド名 概要
playBuzzer 端末に内蔵されているブザー音を鳴らします。
stopBuzzer 再生中のブザーの再生を停止します。
setBuzzerVolume ブザーの音量を設定します。このメソッドは、端末の設定を直接書き換えます。
getBuzzerVolume ブザーの音量を取得します。
startVibration バイブレーターを振動させます。
stopVibration バイブレーターの振動を停止します。
setEnabledWLAN 無線LANモジュールの電源をオン、またはオフにします。
getWLANStatus Wi-Fi接続の接続状態を取得します。
getWLANLevel Wi-Fi接続の電波状態を取得します。
getBatteryLevel バッテリー残量を取得します。
getMobileNetworkStatus モバイルネットワークが有効かどうかを取得します。
getVersion 本モジュールのバージョンを取得します。

 

playBuzzerメソッド

説明

端末に内蔵されているブザー音を鳴らします。すでに鳴っている場合は前の音を停止してから再生します。

鳴らせるブザー音の種類は端末によって異なります。あらかじめ鳴るかどうかを確認してから使用してください。

 

任意の音声ファイル(wav形式等)を再生したい場合は、本メソッドの代わりにRuntime.PlaySoundメソッドが使用可能です。

 

呼出形式

extsv.invoke("playBuzzer", toneType, durationMs);

 

戻り値

なし

 

引数

integer toneType

 

 

integer durationMs

音の種類。ToneGenerator(android.media.ToneGenerator)クラスで指定できる音の種類と同じです。

ToneGeneratorに関する詳細な情報はAndroid Developers(Android開発者向けサイト)のリファレンスマニュアルをご参照ください。

 

ブザー音を鳴らす時間。ミリ秒単位で指定します。

 

 

stopBuzzerメソッド

説明

再生中のブザーの再生を停止します。

ブザーが再生されていない場合は何もしません。

 

呼出形式

extsv.invoke("stopBuzzer");

 

戻り値

なし

 

引数

なし

 

 

setBuzzerVolumeメソッド

説明

ブザーの音量を設定します。このメソッドは、端末の設定を直接書き換えます。

 

呼出形式

extsv.invoke("setBuzzerVolume", volume);

 

戻り値

なし

 

引数

integer volume

音量。0~100[%]の間で指定します。
設定値はOSによって解釈されて設定されるため、実際にはある程度近い、異なる値が設定されることがあります。

 

 

getBuzzerVolumeメソッド

説明

ブザーの音量を取得します。

 

呼出形式

var vol = extsv.invoke("getBuzzerVolume");

 

戻り値

端末に設定されている音量。0~100[%]の値で取得されます。

 

引数

なし

 

 

startVibrationメソッド

説明

バイブレーターを振動させます。

 

呼出形式

extsv.invoke("startVibration", time);

 

戻り値

なし

 

引数

integer time

振動する時間。ミリ秒単位で指定します。

 

 

stopVibrationメソッド

説明

バイブレーターの振動を停止します。

振動していない場合は何もしません。

 

呼出形式

extsv.invoke("stopVibration");

 

戻り値

なし

 

引数

なし

 

 

setEnabledWLANメソッド

説明

無線LANモジュールの電源をオン、またはオフにします。
※ Androidの制限により Android10 以降では使用できません。

 

呼出形式

extsv.invoke("setEnabledWLAN", enabled);

 

戻り値

なし

 

引数

enabled

オンにするならtrue、オフならfalseを指定します。
 

 

getWLANStatusメソッド

説明

Wi-Fi接続の接続状態を取得します。

 

呼出形式

var ret = extsv.invoke("getWLANStatus");

 

戻り値

接続中ならtrue、そうでなければfalse

 

引数

なし

 

 

getWLANLevelメソッド

説明

Wi-Fi接続の電波状態を取得します。

 

呼出形式

var ret = extsv.invoke("getWLANLevel");

 

戻り値

電波強度(0~4)

 

電波強度-55[dBm]を最大値、電波強度-100[dBm]を最小値とした上で、最大値以上である場合は4、最小値以下である場合は0、そうでなければ等間隔で1〜3を返します。

引数

なし

 

 

getBatteryLevelメソッド

説明

バッテリー残量を取得します。

 

呼出形式

var ret = extsv.invoke("getBatteryLevel");

 

戻り値

バッテリー残量(%)

 

引数

なし

 

 

getMobileNetworkStatusメソッド

説明

モバイルネットワークが有効かどうかを取得します。

 

呼出形式

var ret = extsv.invoke("getMobileNetworkStatus");

 

戻り値

モバイルネットワークで通信していればtrue、そうでなければ(Wifiで通信している場合も含む)falseを返します。

 

引数

なし

 

 

getVersionメソッド

説明

本モジュールのバージョンを取得します。

 

呼出形式

var ret = extsv.invoke("getVersion");

 

戻り値

本モジュールのバージョン情報を示す文字列。
バージョン番号、リビジョン番号、その他のモジュールを区別する情報で構成されます。

戻り値(例)

String

1.0.0_r123

 

引数

なし