MirzaLibrary

パッケージ

---

com.nttqonoq.devices.android.mirzalibrary

クラス MirzaLibrary

継承ツリー

---

Object
 com.nttqonoq.devices.android.mirzalibrary.MirzaLibrary

クラスの説明

---

public class MirzaLibrary
extends Object

MiRZAアプリの機能を外部に提供するライブラリクラス
MiRZAアプリ内のServiceと連携してデータの取得や変更通知イベントを受け取ります。

コンストラクタの概要

---

コンストラクタ

• MirzaLibrary()
  コンストラクタ

メソッドの概要

修飾子とタイプ	メソッド	説明
Result<String>	checkVersionConsistency()	バージョン整合性を確認する
Result<Integer>	getBatteryLevel()	電池残量を取得する
void	getBatteryLevelAsync(BatteryLevelCallback callback)	電池残量を取得する（非同期）
Result<ChargeStatus>	getChargeStatus()	充電状態を取得する
void	getChargeStatusAsync(ChargeStatusCallback callback)	充電状態を取得する（非同期）
Result<GlassStatus>	getGlassStatus()	グラスデバイス状態を取得する
void	getGlassStatusAsync(GlassStatusCallback callback)	グラスデバイス状態を取得する（非同期）
Result<GlassWifiBandStatus>	getGlassWifiBand()	グラスとのWi-Fi通信における接続バンド情報を取得する
void	getGlassWifiBandAsync(GlassWifiBandStatusCallback callback)	グラスとのWi-Fi通信における接続バンド情報を取得する（非同期）
Result<GlassWifiRssiStatus>	getGlassWifiRssi()	グラスとのWi-Fi通信におけるRSSIレベル情報を取得する
void	getGlassWifiRssiAsync(GlassWifiRssiStatusCallback callback)	グラスとのWi-Fi通信におけるRSSIレベル情報を取得する（非同期）
Result<SpacesModeStatus>	getSpacesModeStatus()	MRモード状態を取得する
void	getSpacesModeStatusAsync(SpacesModeStatusCallback callback)	MRモード状態を取得する（非同期）
String	getVersion()	ライブラリバージョンを返す
void	setBatteryLevelCallback(BatteryLevelCallback callback)	電池残量のコールバックメソッドを設定する
void	setDisplayStatusCallback(DisplayStatusCallback callback)	画面表示状態のコールバックメソッドを設定する
void	setGlassPwrKeyDblPressCallback(GlassPwrKeyDblPressCallback callback)	グラスの電源ボタンを2回押ししたイベントを受け取るコールバックメソッドを設定する
void	setGlassStatusCallback(GlassStatusCallback callback)	グラスデバイス状態のコールバックメソッドを設定する
void	setGlassTouchGestureStatusCallback(GlassTouchGestureStatusCallback callback)	グラスのタッチパネル操作情報のコールバックメソッドを設定する
void	setGlassWifiBandStatusCallback(GlassWifiBandStatusCallback callback)	グラスとのWi-Fi通信における接続バンド情報のコールバックメソッドを設定する
void	setGlassWifiRssiStatusCallback(GlassWifiRssiStatusCallback callback)	グラスとのWi-Fi通信におけるRSSIレベル情報のコールバックメソッドを設定する
void	setLogEnable(boolean enable)	ログ出力を変更する
void	setPowerOffCallback(PowerOffCallback callback)	グラス電源OFFのコールバックメソッドを設定する
void	setServiceStateCallback(ServiceStateCallback callback)	サービス状態のコールバックメソッドを設定する
void	setSpaceModeChangeRequestCallback(SpacesModeChangeRequestCallback callback)	MRモード変更指示のコールバックメソッドを設定する
void	setSpacesModeStatusCallback(SpacesModeStatusCallback callback)	MRモード状態のコールバックメソッドを設定する
Result<Integer>	spacesModeOff()	MRモードを無効化する
void	spacesModeOffAsync(SpacesModeChangeRequestCallback callback)	MRモードを無効化する（非同期）
Result<Integer>	spacesModeOn()	MRモードを有効化する
void	spacesModeOnAsync(SpacesModeChangeRequestCallback callback)	MRモードを有効化する（非同期）
void	startGlassMicRecordAsync(android.app.Activity activity, boolean batchMode, int samplingRate, int channel, int bitDepth,GlassMicAudioCallback callback)	グラスのマイクを使用して録音を開始（非同期））
void	startMonitoring(android.app.Activity activity)	MiRZAアプリとの連携を開始する
void	stopGlassMicRecord()	グラスのマイクを使用した録音を停止する
void	stopMonitoring(android.app.Activity activity)	MiRZAアプリとの連携を解除する
Result<SwitchMicrophoneStatus>	switchMicrophone(int wearingMicModeCode, int frontMicModeCode, int mixModeCode)	マイクモードの切替を実行する
void	switchMicrophoneAsync(int wearingMicModeCode, int frontMicModeCode, int mixModeCode, SwitchMicrophoneCallback callback)	マイク切替を実行する（非同期）
Result<SpacesModeStatus>	transitionToMirzaAppInSpacesMode(android.content.Context context)	MiRZAアプリへ遷移する

コンストラクタの詳細

---

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モードを有効化する

戻り値:

• 有効化結果オブジェクト。関連データはなく問題があった場合はエラーメッセージが返却されます。

MRモード切り替えタイミング

MRモードの起動・終了時はモード切り替えの前後に10秒以上のタイマーを設定してください

---

spacesModeOnAsync

public void spacesModeOnAsync(SpacesModeChangeRequestCallback callback)
MRモードを有効化する（非同期）

コールバックメソッドで有効化結果オブジェクトを受け取ります。

関連データは無く指示結果に問題があった場合はエラーメッセージが返却されます。

パラメータ:

• callback - MRモード変更指示コールバック

MRモード切り替えタイミング

MRモードの起動・終了時はモード切り替えの前後に10秒以上のタイマーを設定してください

---

spacesModeOff

public Result<Integer> spacesModeOff()
MRモードを無効化する

戻り値:

• 無効化結果オブジェクト。関連データはなく問題があった場合はエラーメッセージが返却されます。

MRモード切り替えタイミング

MRモードの起動・終了時はモード切り替えの前後に10秒以上のタイマーを設定してください

---

spacesModeOffAsync

public void spacesModeOffAsync(SpacesModeChangeRequestCallback callback)
MRモードを無効化する（非同期）

コールバックメソッドで有効化結果オブジェクトを受け取ります。

関連データは無く指示結果に問題があった場合はエラーメッセージが返却されます。

パラメータ:

• callback - MRモード変更指示コールバック

MRモード切り替えタイミング

MRモードの起動・終了時はモード切り替えの前後に10秒以上のタイマーを設定してください

---

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)のみを指定してください。

上記以外の設定をした場合の動作は保証できません。

利用環境の注意

装着者と前方音/周囲音の距離が極端に近いと期待動作が得られない場合がございます。 目安として、グラス装着者と前方/周囲音源(話者)の間は1m程度距離を離してのご利用を推奨致します。

---

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)のみを指定してください。

上記以外の設定をした場合の動作は保証できません。

利用環境の注意

装着者と前方音/周囲音の距離が極端に近いと期待動作が得られない場合がございます。 目安として、グラス装着者と前方/周囲音源(話者)の間は1m程度距離を離してのご利用を推奨致します。

---

startGlassMicRecordAsync

public void startGlassMicRecordAsync(android.app.Activity activity, boolean batchMode, int samplingRate, int channel, int bitDepth, GlassMicAudioCallback callback)
グラスのマイクを使用して録音を開始（非同期）
Spaces SDKを組み込んだUnityアプリからの実行のみをサポートしています。

• パラメータ: activity - アプリケーションのコンテキストとなるアクティビティ
• パラメータ: batchMode - 一括録音モードを有効にする場合true、無効にする場合falseを指定

一括録音モードでのメモリ確保

一括録音モードを有効にすると、最大で10分間録音可能なメモリを確保し、録音終了時に一つのまとまった音声データをコールバックで返却します。
確保するメモリサイズの計算例:

// 条件: 44.1kHz, ステレオ(2ch), 16bit, 10分(600秒)の場合
44100 * 2 * (16 / 8) * 600 = 105,840,000 bytes (約101MB)

• パラメータ: samplingRate - 録音する音声のサンプリングレート(例： 44100, 48000)
• パラメータ: channel - 録音する音声のチャンネル構成
  • 1: モノラル (AudioFormat.CHANNEL_IN_MONO)
  • 2: ステレオ (AudioFormat.CHANNEL_IN_STEREO)
• パラメータ: bitDepth - 録音する音声のビット数
  • 16: 16bit (AudioFormat.ENCODING_PCM_16BIT)
  • 24: 24bit (AudioFormat.ENCODING_PCM_24BIT_PACKED)
• パラメータ: callback - グラスのマイクを使用した録音音声データのコールバック

---

stopGlassMicRecord()

public void stopGlassMicRecord()
グラスのマイクを使用した録音を停止

---

transitionToMirzaAppInSpacesMode

public Result<SpacesModeStatus> transitionToMirzaAppInSpacesMode(android.content.Context context)
MiRZAアプリへ遷移する

パラメータ:

• context - アプリケーションコンテキスト

戻り値:

• 結果オブジェクト

---

getGlassWifiRssi

public Result<GlassWifiRssiStatus> getGlassWifiRssi()
グラスとのWi-Fi通信におけるRSSIレベル情報を取得

• 戻り値: 連携結果オブジェクト (グラスとのWi-Fi通信におけるRSSIレベル情報を返却)

---

getGlassWifiRssiAsync

public void getGlassWifiRssiAsync(GlassWifiRssiStatusCallback callback)
グラスとのWi-Fi通信におけるRSSIレベル情報を取得（非同期）
コールバックメソッドで取得結果オブジェクトを受け取り (グラスとのWi-Fi通信におけるRSSIレベル情報を返却)

• パラメータ: callback - コールバックメソッド

---

getGlassWifiBand

public Result<GlassWifiBandStatus> getGlassWifiBand()
グラスとのWi-Fi通信における接続バンド情報を取得

• 戻り値: 連携結果オブジェクト (グラスとのWi-Fi通信における接続バンド情報を返却)

---

getGlassWifiBandAsync

public void getGlassWifiBandAsync(GlassWifiBandStatusCallback callback)
グラスとのWi-Fi通信における接続バンド情報を取得（非同期）
コールバックメソッドで取得結果オブジェクト受け取り (グラスとのWi-Fi通信における接続バンド情報を返却)

• パラメータ: callback - コールバックメソッド

---

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 - グラスのタッチパネル操作情報のコールバックメソッド

---

setGlassWifiRssiStatusCallback

public void setGlassWifiRssiStatusCallback(GlassWifiRssiStatusCallback callback)
グラスとのWi-Fi通信におけるRSSIレベル情報のコールバックメソッドを設定

• パラメータ: callback - グラスとのWi-Fi通信におけるRSSIレベル情報のコールバックメソッド

---

setGlassWifiBandStatusCallback

public void setGlassWifiBandStatusCallback(GlassWifiBandStatusCallback callback)
グラスとのWi-Fi通信における接続バンド情報のコールバックメソッドを設定

• パラメータ: callback - グラスとのWi-Fi通信における接続バンド情報のコールバックメソッド

---

setGlassPwrKeyDblPressCallback

public void setGlassPwrKeyDblPressCallback(GlassPwrKeyDblPressCallback callback)
グラスの電源ボタンを2回押ししたイベントを受け取るコールバックメソッドを設定

• パラメータ: callback - グラスの電源ボタンを2回押ししたイベントを受け取るコールバック