public class IRKit
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static interface |
IRKit.IRKitConnectWifiListener
IRKitデバイスのセットアップ状況の通知を受けるためのリスナです。
Listener to be notified the setup status of IRKit device.
|
static interface |
IRKit.IRKitWifiScanResultListener |
static interface |
IRKit.WifiConnectionChangeListener
Wi-Fiの接続状況の変化を受け取るリスナインタフェースです。
Listener to be notified Wi-Fi state changes.
|
Modifier and Type | Field and Description |
---|---|
IRPeripherals |
peripherals
既存のIRPeripheralインスタンスが格納されたIRPeripheralsインスタンスです。
IRPeripherals instance which holds existing IRPeripheral instances.
|
static java.lang.String |
PREF_KEY_BONJOUR_HOSTNAME |
static java.lang.String |
PREF_KEY_BONJOUR_RESOLVED_AT |
static java.lang.String |
PREFS_KEY_CLIENTKEY |
static java.lang.String |
SERVICE_TYPE |
IRSignals |
signals
既存のIRSignalインスタンスが格納されたIRSignalsインスタンスです。
IRSignals instance which holds existing IRSignal instances.
|
java.lang.String |
TAG |
Modifier and Type | Method and Description |
---|---|
void |
addExampleDataIfEmpty()
peripheralsとsignalsが空の場合にテスト用データを追加します。
Add example data to peripherals and signals if they are empty.
|
void |
addExamplePeripheral()
peripheralsにテストデータを追加します。
Add example data to peripherals.
|
void |
addExampleSignal()
signalsにテストデータを追加します。
Add example data to signals.
|
void |
cancelIRKitSetup()
デバイスのセットアップをキャンセルします。セットアップが進行中でない場合は何もしません。
Cancel IRKit device setup.
|
void |
clearIRKitWifiConfigurations()
Androidに保存されたネットワークからIRKit Wi-Fiのものを削除します。
Remove configured networks that are IRKit Wi-Fi from Android.
|
int |
connectToIRKitWifi(IRWifiInfo irWifiInfo,
IRKit.WifiConnectionChangeListener listener)
IRKit Wi-Fiへの接続を試みます。
Connect to IRKit Wi-Fi.
|
void |
connectToNormalWifi(android.net.wifi.WifiConfiguration wifiConfig,
IRKit.WifiConnectionChangeListener listener)
家のWi-Fi(IRKit Wi-FiではないWi-Fi)に接続します。
Connect to home Wi-Fi (Wi-Fi that is not an IRKit Wi-Fi).
|
void |
disconnectFromCurrentWifi()
現在接続済みのWi-Fiネットワークから切断します。
Disconnect from current Wi-Fi network.
|
void |
forceIRKitWifi(IRCallback callback)
Lollipop以上の環境において、以降の通信にモバイルデータ接続ではなくWi-Fiを使うよう強制します。 IRKit Wi-Fiはインターネット接続がないため、Device HTTP APIを確実にWi-Fi経由で送信するために使います。 Lollipop未満の環境では何も実行されずにcallbackのonSuccess()が呼ばれます。 制限を解除するにはunforceIRKitWifi()を呼んでください。 |
android.content.Context |
getContext()
Contextを返します。
Return the context.
|
android.net.wifi.WifiConfiguration |
getCurrentWifiConfiguration()
現在使用しているWi-FiネットワークのWifiConfigurationを返します。
Return the WifiConfiguration for the current Wi-Fi.
|
android.net.wifi.WifiInfo |
getCurrentWifiInfo()
現在接続済みのWi-FiネットワークのWifiInfoを返します。
Return the WifiInfo instance of current Wi-Fi.
|
java.lang.String |
getDebugInfo()
デバッグ用の情報をJSON文字列にして返します。
Return JSON string that contains debug info.
|
IRHTTPClient |
getHTTPClient() |
java.lang.String |
getIRKitAPIKey()
現在セットされているIRKit SDKのapikeyを返します。
Returns the current IRKit apikey.
|
IRKitEventListener |
getIRKitEventListener()
irkitEventListenerを返します。
Return irkitEventListener.
|
java.lang.String |
getPreference(java.lang.String key)
SharedPreferencesから文字列データを読み込みます。
Fetch data from SharedPreferences.
|
static int |
getRegDomainForDefaultLocale()
Androidのロケール設定に該当するregdomainを返します。
Return regdomain for the default locale of this Android.
|
static int |
getRegDomainForLocale(java.util.Locale locale)
localeに該当するregdomainを返します。
Return regdomain for the locale.
|
android.net.wifi.WifiConfiguration |
getWifiConfigurationBySSID(java.lang.String ssid)
ssidに該当するWifiConfigurationを返します。
Return WifiConfiguration that matches the ssid.
|
java.net.InetAddress |
getWifiIPv4Address()
Wi-FiインタフェースのIPv4アドレスを返します。
Return IPv4 address of Wi-Fi interface.
|
void |
init(android.content.Context context)
contextをセットし、またIRKitインスタンスが初期化されていない場合は初期化します。 |
boolean |
isDataLoaded()
データをロード済みかどうかを返します。
Return whether the data has been loaded.
|
boolean |
isInitialized()
初期化が完了しているかどうかを返します。
Return whether the initialization has been done.
|
boolean |
isWifiConnected()
Wi-Fiに接続済みかどうかを返します。
Return whether Android is connected to Wi-Fi.
|
boolean |
isWifiEnabled()
Wi-Fiが有効になっているかどうかを返します。
Return whether Wi-Fi is enabled.
|
void |
loadData()
SharedPreferencesからデータをロードします。
Load data from SharedPreferences.
|
void |
registerClient()
clientkeyが未取得の場合は取得します。
Fetch clientkey if we have not received it yet.
|
void |
registerClient(java.lang.String apikey)
clientkeyが未取得の場合はapikeyを使って取得します。apikeyがnullの場合は
AndroidManifest.xmlで指定されたapikeyを使用します。
If we have not received clientkey yet, fetch it using apikey.
|
void |
registerWifiStateChangeListener()
Wi-Fi状態の変化を監視し、Wi-Fiが有効になったらBonjour検索を
開始し、Wi-Fiが無効になったらBonjour検索を停止します。
Watch Wi-Fi state change.
|
void |
removeWifiConfiguration(int networkId)
networkIdに一致するネットワーク認証情報をAndroidから削除します。
Remove network auth data that matches networkId from Android.
|
void |
requestBackup()
Androidバックアップサービスにバックアップをリクエストします。
Request backup to Android backup service.
|
void |
savePreference(java.lang.String key,
java.lang.String value)
SharedPreferencesに文字列データを保存します。
Store data in SharedPreferences.
|
void |
scanIRKitWifi(IRKit.IRKitWifiScanResultListener listener)
IRKit Wi-Fiをスキャンして探します。
Scan for IRKit Wi-Fi.
|
void |
sendSignal(IRSignal signal,
IRAPIResult callback)
IRKitから赤外線信号を送信します。ローカルネットワーク内でIRKitに接続できる場合はDevice HTTP APIが使われ、 Device HTTP APIが利用できない場合はInternet HTTP APIで送信します。sendSignal()が短時間に複数回 呼ばれた際は、IRKitがパニックを起こさないよう1個ずつ順に送信されます。 |
void |
setContext(android.content.Context c)
Contextをセットします。
Set the context.
|
void |
setIRKitEventListener(IRKitEventListener listener)
IRKitEventListenerをセットします。nullが渡された場合はリスナを解除します。
Set an IRKitEventListener to this instance.
|
void |
setupIRKit(java.lang.String apiKey,
IRWifiInfo connectDestination,
java.lang.String irkitWifiPassword,
IRKit.IRKitConnectWifiListener listener)
IRKitデバイスのセットアップを開始します。すでにセットアップが進行中の場合はlistenerの更新だけを行います。 |
void |
setWifiEnabled(boolean set)
Wi-Fiを有効にします。
Enable Wi-Fi.
|
static IRKit |
sharedInstance()
singletonのインスタンスを返します。
Returns a singleton instance.
|
void |
startBonjourDiscovery()
mDNSでの検索を開始します。
Start mDNS discovery.
|
void |
startServiceDiscovery()
mDNSによるIRKitの検索を開始します。
Start IRKit discovery by mDNS.
|
void |
stopBonjourDiscovery()
mDNSでの検索を停止します。
Stop mDNS discovery.
|
void |
stopServiceDiscovery()
mDNSによるIRKitの検索を停止します。
Stop IRKit discovery.
|
void |
stopWifiScan()
Wi-Fiのスキャンを停止します。
Stop Wi-Fi scan.
|
void |
stopWifiStateListener()
Wi-Fi状態の監視を停止します。
Stop watching for Wi-Fi state change.
|
void |
unforceIRKitWifi()
forceIRKitWifi() で行われたネットワークの限定を解除します。 |
void |
unregisterWifiStateChangeListener()
Wi-Fi状態の監視を停止します。
Unwatch Wi-Fi state change.
|
public java.lang.String TAG
public static final java.lang.String SERVICE_TYPE
public static final java.lang.String PREF_KEY_BONJOUR_HOSTNAME
public static final java.lang.String PREF_KEY_BONJOUR_RESOLVED_AT
public static final java.lang.String PREFS_KEY_CLIENTKEY
public IRPeripherals peripherals
public IRSignals signals
public static IRKit sharedInstance()
public IRHTTPClient getHTTPClient()
public void loadData()
public void cancelIRKitSetup()
public void setupIRKit(java.lang.String apiKey, IRWifiInfo connectDestination, java.lang.String irkitWifiPassword, IRKit.IRKitConnectWifiListener listener)
IRKitデバイスのセットアップを開始します。すでにセットアップが進行中の場合はlistenerの更新だけを行います。
Begin IRKit device setup. If a setup is already started, it only updates the listener.
apiKey
- apikeyconnectDestination
- IRKitを接続させるWi-Fi。 Wi-Fi which will be connected by IRKit.irkitWifiPassword
- IRKit Wi-Fiのパスワード。 IRKit Wi-Fi password.listener
- IRKitConnectWifiListener instancepublic void forceIRKitWifi(IRCallback callback)
Lollipop以上の環境において、以降の通信にモバイルデータ接続ではなくWi-Fiを使うよう強制します。 IRKit Wi-Fiはインターネット接続がないため、Device HTTP APIを確実にWi-Fi経由で送信するために使います。 Lollipop未満の環境では何も実行されずにcallbackのonSuccess()が呼ばれます。 制限を解除するにはunforceIRKitWifi()を呼んでください。
On Lollipop or later, force network connection to use Wi-Fi instead of mobile network. Because IRKit Wi-Fi has no internet access, use this method to make sure that Device HTTP API requests will be sent over Wi-Fi. On earlier than Lollipop, onSuccess() method of callback will be called with doing nothing. To lift the restriction, use unforceIRKitWifi().
callback
- 成功した場合はonSuccess()、時間内に成功しなかった場合はonTimeout()が呼ばれる。
When success, onSuccess() will be called. Otherwise onTimeout() will be called.unforceIRKitWifi()
public void unforceIRKitWifi()
forceIRKitWifi() で行われたネットワークの限定を解除します。
Stop restricting network which is caused by forceIRKitWifi().
forceIRKitWifi(IRCallback)
public void registerWifiStateChangeListener()
public void unregisterWifiStateChangeListener()
public void startServiceDiscovery()
public void stopServiceDiscovery()
public boolean isInitialized()
public void addExampleDataIfEmpty()
public void addExamplePeripheral()
public void addExampleSignal()
public void init(android.content.Context context)
contextをセットし、またIRKitインスタンスが初期化されていない場合は初期化します。
Set context, and initialize IRKit instance if it is not initialized yet.
context
- Context objectpublic void savePreference(java.lang.String key, java.lang.String value)
key
- Keyvalue
- Valuepublic java.lang.String getPreference(java.lang.String key)
key
- Keypublic void requestBackup()
public java.lang.String getIRKitAPIKey()
public void registerClient(java.lang.String apikey)
public void registerClient()
public void removeWifiConfiguration(int networkId)
networkId
- Network ID used by WifiManagerpublic void disconnectFromCurrentWifi()
public android.net.wifi.WifiConfiguration getCurrentWifiConfiguration()
public android.net.wifi.WifiInfo getCurrentWifiInfo()
public void stopWifiStateListener()
public void setWifiEnabled(boolean set)
set
- Wi-Fiを有効にするにはtrue。 To enable Wi-Fi, true.public boolean isWifiEnabled()
public void scanIRKitWifi(IRKit.IRKitWifiScanResultListener listener)
listener
- 通知を受け取るリスナ。 Listener to be notified.public void stopWifiScan()
public void clearIRKitWifiConfigurations()
public android.net.wifi.WifiConfiguration getWifiConfigurationBySSID(java.lang.String ssid)
ssid
- SSIDpublic void connectToNormalWifi(android.net.wifi.WifiConfiguration wifiConfig, IRKit.WifiConnectionChangeListener listener)
wifiConfig
- 接続先のWifiConfiguration。 WifiConfiguration to use.listener
- WifiConnectionChangeListenerpublic int connectToIRKitWifi(IRWifiInfo irWifiInfo, IRKit.WifiConnectionChangeListener listener)
irWifiInfo
- IRKit Wi-Fiの情報。 IRKit Wi-Fi info.listener
- 通知を受け取るリスナ。 Listener to be notified state changes.public java.lang.String getDebugInfo()
public static int getRegDomainForDefaultLocale()
public static int getRegDomainForLocale(java.util.Locale locale)
locale
- Localepublic java.net.InetAddress getWifiIPv4Address()
public void startBonjourDiscovery()
public void stopBonjourDiscovery()
public void sendSignal(IRSignal signal, IRAPIResult callback)
IRKitから赤外線信号を送信します。ローカルネットワーク内でIRKitに接続できる場合はDevice HTTP APIが使われ、 Device HTTP APIが利用できない場合はInternet HTTP APIで送信します。sendSignal()が短時間に複数回 呼ばれた際は、IRKitがパニックを起こさないよう1個ずつ順に送信されます。
Send signal via IRKit device. When sendSignal() is called multiple times in a short period of time, it will be sent one by one to prevent IRKit device panic. NOTE: IRKit panics when received parallel requests from local network.
signal
- 送信する赤外線信号。 IR signal to be sent.callback
- 結果を受け取るコールバック。 Callback for receiving the result.public boolean isWifiConnected()
public IRKitEventListener getIRKitEventListener()
public void setIRKitEventListener(IRKitEventListener listener)
listener
- IRKitEventListenerインスタンス。あるいはリスナを解除するにはnull。
IRKitEventListener instance, or null to remove the listener.public void setContext(android.content.Context c)
c
- Context objectpublic android.content.Context getContext()
public boolean isDataLoaded()