つくる、をつなぐProject Linking

LinkingコアライブラリAPI仕様書 for Android

ver 1.0.0
目次

デバイスの検索

DeviceDiscovery

Linkingデバイスを探索するクラス

パッケージ

com.example.projectlinking.android.LinkingLibrary

コンストラクタ

DeviceDiscovery(Context context)

引数
Contextcontextアプリケーションのコンテキスト

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 start デバイス検索を開始します。
2 cancel デバイス検索を中止します。
3 getPairedList ペアリングした経歴があるデバイスの一覧を取得します。
4 removePairedDevice ペアリングした経歴があるデバイスを一覧から削除します。

メソッド詳細

start
boolean start(DeviceDiscoveryCallback callback)
デバイス検索を開始します。
引数
DeviceDiscoveryCallbackcallbackデバイス検索結果通知コールバック
戻り値
実行結果(true:成功/ false:失敗)
cancel
boolean cancel(DeviceDiscoveryCallback callback)
デバイス検索を中止します。
引数
DeviceDiscoveryCallbackcallbackデバイス検索結果通知コールバック
戻り値
実行結果(true:成功/ false:失敗)
getPairedList
ArrayList getPairedList()
ペアリングした経歴があるデバイスの一覧を取得します。
引数
なし
戻り値
ペアリング済みデバイスの一覧
removePairedDevice
boolean removePairedDevice(String addr)
ペアリングした経歴があるデバイスを一覧から削除します。
引数
Stringaddr削除するデバイスのアドレス
戻り値
実行結果(true:成功/ false:失敗)

DeviceDiscoveryCallback

Linkingデバイス検索のコールバック

パッケージ

com.example.projectlinking.android.LinkingLibrary

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 onDiscoveryStarted デバイス検索の開始を通知します。
2 onDiscoveryFinished デバイス検索の終了を通知します。
3 onDeviceFound デバイスを発見したことを通知します。

メソッド詳細

onDiscoveryStarted
void onDiscoveryStarted(int result)
デバイス検索の開始を通知します。
引数
intresultデバイス検索開始結果
戻り値
なし
onDiscoveryFinished
void onDiscoveryFinished()
デバイス検索の終了を通知します。
引数
なし
戻り値
なし
onDeviceFound
void onDeviceFound(LinkingDevicedevice)
デバイスを発見したことを通知します。
引数
LinkingDevicedeviceLinkingデバイス
戻り値
なし

PairedDevice

ペアリング済みデバイスへセンサーデータの取得開始/停止依頼を行うクラス

パッケージ

com.example.projectlinking.android.LinkingLibrary

コンストラクタ

PairedDevice(LinkingDevice linkingDevice, boolean paired)

引数
LinkingDevicedeviceLinkingデバイス
Booleanpairedペアリング状態

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 getLinkingDevice Linkingデバイスを取得します。
2 getPaired ペアリング状態を取得します。

メソッド詳細

getLinkingDevice
LinkingDevice getLinkingDevice()
Linkingデバイスを取得します。
引数
なし
戻り値
Linkingデバイス
getPaired
boolean getPaired()
ペアリング状態を取得します。
引数
なし
戻り値
true ペアリング接続中
false ペアリング解除中