MirzaLibrary
パッケージ
com.nttqonoq.devices.android.mirzalibrary
クラス MirzaLibrary
継承ツリー
Object
com.nttqonoq.devices.android.mirzalibrary.MirzaLibrary
クラスの説明
public class MirzaLibrary
extends Object
MiRZAアプリの機能を外部に提供するライブラリクラス
MiRZAアプリ内のServiceと連携してデータの取得や変更通知イベントを受け取ります。
コンストラクタの概要
コンストラクタ
- MirzaLibrary()
コンストラクタ
メソッドの概要
コンストラクタの詳細
MirzaLibrary
public MirzaLibrary()
コンストラクタ
ログ管理クラス、コールバック管理クラス、サービス連携クラスを初期化します。 ログ出力はデフォルトで行いません。
メソッドの詳細
setLogEnable
public void setLogEnable(boolean enable)
ログ出力を変更する
パラメータ:
enable
- 出力有無。trueの場合は出力する、falseの場合は出力しない。
startMonitoring
public void startMonitoring(android.app.Activity activity)
MiRZAアプリとの連携を開始する
パラメータ:
activity
- 接続元のアクティビティ
stopMonitoring
public void stopMonitoring(android.app.Activity activity)
MiRZAアプリとの連携を解除する
パラメータ:
activity
- 接続元のアクティビティ
getVersion
public String getVersion()
ライブラリバージョンを返す
startMonitoring(Activity)メソッド実行後に取得可能になります。
戻り値:
- ライブラリバージョン
checkVersionConsistency
public Result<String> checkVersionConsistency()
バージョン整合性を確認する
戻り値:
- 確認結果オブジェクト。関連データとしてMiRZAアプリのサービスバージョンが返却されます。
getGlassStatus
public Result<GlassStatus> getGlassStatus()
グラスデバイス状態を取得する
戻り値:
- 取得結果オブジェクト。関連データとしてグラスデバイス状態が返却されます。
getGlassStatusAsync
public void getGlassStatusAsync(GlassStatusCallback callback)
グラスデバイス状態を取得する(非同期)
パラメータ:
callback
- グラスデバイス状態コールバック
getBatteryLevel
public Result<Integer> getBatteryLevel()
電池残量を取得する
戻り値:
- 取得結果オブジェクト。関連データとして電池残量(パーセンテージ)が返却されます。
getBatteryLevelAsync
public void getBatteryLevelAsync(BatteryLevelCallback callback)
電池残量を取得する(非同期)
コールバックメソッドで取得結果オブジェクトを受け取ります。関連データとして電池残量(パーセンテージ)が返却されます。
パラメータ:
callback
- 電池残量コールバック
getChargeStatus
public Result<ChargeStatus> getChargeStatus()
充電状態を取得する
戻り値:
- 取得結果オブジェクト。関連データとして充電状態が返却されます。
getChargeStatusAsync
public void getChargeStatusAsync(ChargeStatusCallback callback)
充電状態を取得する(非同期)
コールバックメソッドで取得結果オブジェクトを受け取ります。関連データとして充電状態が返却されます。
パラメータ:
callback
- コールバックメソッド
getSpacesModeStatus
public Result<SpacesModeStatus> getSpacesModeStatus()
MRモード状態を取得する
戻り値:
- 取得結果オブジェクト。関連データとしてMRモード状態を返却されます。
getSpacesModeStatusAsync
public void getSpacesModeStatusAsync(SpacesModeStatusCallback callback)
MRモード状態を取得する(非同期)
コールバックメソッドで取得結果オブジェクトを受け取ります。関連データとしてMRモード状態を返却されます。
パラメータ:
callback
- 電池残量コールバック
spacesModeOn
public Result<Integer> spacesModeOn()
MRモードを有効化する
戻り値:
- 有効化結果オブジェクト。関連データはなく問題があった場合はエラーメッセージが返却されます。
spacesModeOnAsync
public void spacesModeOnAsync(SpacesModeChangeRequestCallback callback)
MRモードを有効化する(非同期)
コールバックメソッドで有効化結果オブジェクトを受け取ります。
関連データは無く指示結果に問題があった場合はエラーメッセージが返却されます。
パラメータ:
callback
- MRモード変更指示コールバック
spacesModeOff
public Result<Integer> spacesModeOff()
MRモードを無効化する
戻り値:
- 無効化結果オブジェクト。関連データはなく問題があった場合はエラーメッセージが返却されます。
spacesModeOffAsync
public void spacesModeOffAsync(SpacesModeChangeRequestCallback callback)
MRモードを無効化する(非同期)
コールバックメソッドで有効化結果オブジェクトを受け取ります。
関連データは無く指示結果に問題があった場合はエラーメッセージが返却されます。
パラメータ:
callback
- MRモード変更指示コールバック
switchMicrophone
public Result<Integer> public Result<SwitchMicrophoneStatus> switchMicrophone(int wearingMicModeCode,int frontMicModeCode,int mixModeCode)
マイク切替を実行する
マイクモードの切替はグラスのソフトウェアがS240010以降でご利用可能です
パラメータ:
wearingMicModeCode
- マイクモード1コードfrontMicModeCode
- マイクモード2コードmixModeCode
- MIXモードの有無コード
戻り値:
- 切替結果オブジェクト。関連データとして切替後のマイク切替状態が返却されます。
コードは下記のルールに従って指定してください。
- wearingMicModeCode
- OFF(=0),WEARER(=1),AMBIENT(=2),FRONT(=3)のいずれか
- frontMicModeCode
- WearingMicModeCodeと同じ値
- mixModeCode
- OFF(=0)固定
※マイクモード1とマイクモード2は同じコードが指定されている必要があります。
※MIXモードはOFF(0x00)のみを指定してください。
上記以外の設定をした場合の動作は保証できません。
switchMicrophoneAsync
public void switchMicrophoneAsync(int wearingMicModeCode,int frontMicModeCode,int mixModeCode,SwitchMicrophoneCallback callback)
マイク切替を実行する(非同期)
コールバックメソッドで切替後のマイク切替状態オブジェクトを受け取ります。
マイクモードの切替はグラスのソフトウェアがS240010以降でご利用可能です
パラメータ:
wearingMicModeCode
- マイクモード1コードfrontMicModeCode
- マイクモード2コードmixModeCode
- MIXモードの有無コードcallback
- マイク切替変更指示コールバック
コードは下記のルールに従って指定してください。
- wearingMicModeCode
- OFF(=0),WEARER(=1),AMBIENT(=2),FRONT(=3)のいずれか
- frontMicModeCode
- WearingMicModeCodeと同じ値
- mixModeCode
- OFF(=0)固定
※マイクモード1とマイクモード2は同じコードが指定されている必要があります。
※MIXモードはOFF(0x00)のみを指定してください。
上記以外の設定をした場合の動作は保証できません。
transitionToMirzaAppInSpacesMode
public Result<SpacesModeStatus> transitionToMirzaAppInSpacesMode(android.content.Context context)
MiRZAアプリへ遷移する
パラメータ:
context
- アプリケーションコンテキスト
戻り値:
- 結果オブジェクト
setServiceStateCallback
public void setServiceStateCallback(ServiceStateCallback callback)
サービス状態のコールバックメソッドを設定する
パラメータ:
callback
- サービス状態のコールバックメソッド
setGlassStatusCallback
public void setGlassStatusCallback(GlassStatusCallback callback)
グラスデバイス状態のコールバックメソッドを設定す
パラメータ:
callback
- グラスデバイスのコールバックメソッド
setBatteryLevelCallback
public void setBatteryLevelCallback(BatteryLevelCallback callback)
電池残量のコールバックメソッドを設定する
パラメータ:
callback
- 電池残量のコールバックメソッド
setSpacesModeStatusCallback
public void setSpacesModeStatusCallback(SpacesModeStatusCallback callback)
MRモード状態のコールバックメソッドを設定する
パラメータ:
callback
- MRモードのコールバックメソッド
setSpaceModeChangeRequestCallback
public void setSpaceModeChangeRequestCallback(SpacesModeChangeRequestCallback callback)
MRモード変更指示のコールバックメソッドを設定する
パラメータ:
callback
- MRモード変更指示のコールバックメソッド
setDisplayStatusCallback
public void setDisplayStatusCallback(DisplayStatusCallback callback)
画面表示状態のコールバックメソッドを設定する
パラメータ:
callback
- 画面表示状態のコールバックメソッド
setPowerOffCallback
public void setPowerOffCallback(PowerOffCallback callback)
グラス電源OFFのコールバックメソッドを設定する
パラメータ:
callback
- グラス電源OFFのコールバックメソッド
setGlassTouchGestureStatusCallback
public void setGlassTouchGestureStatusCallback(GlassTouchGestureStatusCallback callback)
グラスのタッチパネル操作情報のコールバックメソッドを設定する
パラメータ:
callback
- グラスのタッチパネル操作情報のコールバックメソッド