Wikitude SDK APIリファレンス

バージョン: 8.1.0
表示:

hardwareクラス

モジュール: AR

hardwareには、デバイス自体とやり取りできる一般的な関数が含まれます。

このクラスのシングルトンインスタンスはWorldスタートアップ時に自動的に作成され、AR.hardware経由でアクセスできます。

例:
AR.hardware.camera.position = AR.CONST.CAMERA_POSITION.FRONT

メソッド

camera.setExposurePointOfInterest

(
  • point
)

カメラが露出するスクリーン座標を設定します。 手動露出ポイントを設定すると、プラットフォームとカメラの基本機能に応じて、アクティブ露出モードが1回に変更されることがあります。

このプロパティの入力値は、手動または例えば "AR.context.onScreenClick"コールバックの結果として定義されます。これは、必ずしもユーザーがタップした位置である必要はないということを意味します。 パラメータセットは、例えば {x：100、y：100} のようなxおよびyプロパティを含むオブジェクトでなければならない。xとyの値は、0,0から screen.width / screen.height までの範囲のスクリーンのピクセル座標です。

パラメーター:

  • point Object

    例えば、 {x：100、y：100} のようにx座標とy座標を含むオブジェクトを設定します。

camera.setFocusPointOfInterest

(
  • point
)

カメラがフォーカスするスクリーン座標を設定します。 手動でフォーカスポイントを設定すると、アクティブなフォーカスモードがiOSで1回に変更され、Androidではフォーカスモードが1回の場合のみ機能します。

このプロパティの入力値は、手動または例えば "AR.context.onScreenClick"コールバックの結果として定義されます。これは、必ずしもユーザーがタップした位置である必要はないということを意味します。 パラメータセットは、例えば {x：100、y：100} のようなxおよびyプロパティを含むオブジェクトでなければならない。xとyの値は、0,0から screen.width / screen.height までの範囲のスクリーンのピクセル座標です。

パラメーター:

  • point Object

    例えば、 {x：100、y：100} のようにx座標とy座標を含むオブジェクトを設定します。

smart.isPlatformAssistedTrackingSupported

()

プラットフォーム独自のトラッキング機能がサポートされているかどうかを判断する照会プロセスを開始します。 現在のステータスは、定期的に onPlatformAssistedTrackingAvailabilityChanged で報告されます。

悪影響を与えずにこの関数を複数回呼び出すことができます。 onPlatformAssistedTrackingAvailabilityChanged コールバック関数は、1回のインターバルサイクルでのみ呼び出されます。 この問い合わせプロシージャのiOS実装は、すぐに決定的な結果を返します。 Androidの実装では、プラットフォーム追跡のサポートが利用可能かどうかの結論に達するまでに数サイクルの間隔がかかる場合があります。

プロパティ

camera.enabled

Boolean

カメラがアクティブかどうかを制御します。

カメラビューが表示され、Wikitude SDKがアクティブになります。このプロパティがfalseに設定されている場合、カメラは無効になり、黒の背景が表示されて、Wikitude SDKは非アクティブになります。

全画面HTMLが表示されるときはカメラを一時的に非アクティブにすることを推奨します。これにより、バッテリーの消費を抑え、パフォーマンスを向上させることができます。

デフォルト値: true

camera.features

Object

デバイスカメラの機能を取得します。最小および最大ズームレベル、サポートされているカメラの位置、フォーカスモードに関する情報が返されます。

camera.flashlight

Boolean

デバイスのフラッシュをオンまたはオフにします。デバイスにフラッシュが装備されているかどうかをチェックするには、isFlashlightAvailableプロパティを使用します。デバイスにフラッシュが装備されていない場合は、このプロパティをtrueに設定しても効果はありません。

デフォルト値: false

camera.flashlightAvailable

Boolean

デバイスにフラッシュが装備されている場合はtrue。それ以外の場合はfalse。

Androidでは以下の権限が必要です。

<uses-permission android:name="android.permission.FLASHLIGHT"/>
<uses-feature android:name="android.hardware.camera.flash" />

デフォルト値: false

camera.focusDistance

Number

カメラのフォーカス距離を設定します。 0と100の間の値を使用してください。ここで、0は無限遠焦点、100はレンズの最前面から最短距離であり、鮮明な焦点にすることができます。

デフォルト値: 0

camera.focusMode

Object

カメラのオートフォーカスモードを設定します。有効な値はONCE（ワンショットオートフォーカスを開始する）またはCONTINUOUS（フォーカスを自動調整し続ける）です。

デフォルト値: AR.CONST.CAMERA_FOCUS_MODE.CONTINUOUS

camera.manualFocusAvailable

Boolean

現在のカメラが手動フォーカスをサポートしている場合はtrue、そうでない場合はfalse。

デフォルト値: false

camera.onError

Function

onErrorは、カメラ設定を適用できなかったときにトリガーされます。

このトリガーのデフォルト値ではnullであり、トリガーが発生したとき何もアクションは実行されません。開発者は、カスタム関数をonErrorに割り当てることにより、カスタム機能を追加できます。

camera.position

Object

アクティブなカメラの位置を設定します。有効な値はFRONTまたはBACKです。

デフォルト値: AR.CONST.CAMERA_POSITION.BACK

camera.zoom

Number

カメラのズームレベルを設定します。ズームなしにする場合は1を指定します。特定の値がサポートされていない場合は、"best match"が使用されます。

デフォルト値: 1

sensors.compass.correctionAngle

Number

コンパスの時計回りの角度（度単位）を定義します。値には360の剰余が適用されます。つまり、361°を設定した場合と1°を設定した場合は同じ結果になります。

デフォルト値: 0

sensors.enabled

Boolean

センサーがアクティブかどうかを制御します。センサーには、GPS、磁力計、加速度計、ジャイロスコープなどがあります。

このプロパティがtrueに設定されている場合、GeoObjectやActionRangeなどロケーションベース型ARで使用するオブジェクトがアクティブになります。このプロパティがfalseに設定されている場合、それらはカメラビューに表示されず、トリガーも発生しません。

画像認識型ARのみを使用する場合はセンサーを無効にすることを推奨します。これにより、バッテリーの消費を抑え、パフォーマンスを向上させることができます。

デフォルト値: true

smart.onPlatformAssistedTrackingAvailabilityChanged

Function

このコールバック関数は、 isPlatformAssistedTrackingSupported を呼び出してクエリ処理が開始された後、一定間隔で呼び出されます。 決定的な状態になると、もはや呼び出されません。

SmartAvailability

Object

プラットフォーム独自のトラッキング機能がサポートされているかの照会プロセスの現在の状態は、次のいずれかの値を使用して通信されます:

  • INDETERMINATE_QUERY_FAILED - 何らかの理由でクエリが失敗しました。再試行するか、プラットフォーム独自のトラッキング機能を使用せずに実行することができます。コールバックは再び呼び出されません。
  • CHECKING_QUERY_ONGOING - クエリは現在進行中です。じっくりとコールバックが再び呼び出されるのを待ちます。一方で、進行中のプロセスについてユーザーに通知するのも良いアイデアかもしれません。
  • UNSUPPORTED - クエリが結論に達しました。プラットフォーム独自のトラッキング機能はサポートされていません。要件に応じて、プラットフォームによるトラッキングを有効または無効にして続行します。 コールバックは再び呼び出されません。
  • SUPPORTED_UPDATE_REQUIRED - クエリが結論に達しました。プラットフォーム独自のトラッキング機能はサポートされていますが、更新が必要です。アップデートをインストールするために、プラットフォーム独自のトラッキング機能を有効にしてトラッカーを作成します。コールバックは SUPPORTED で再度呼び出すことができます。 トラッカーを複数回作成しないように注意してください。
  • SUPPORTED - クエリが結論に達しました。 プラットフォーム独自のトラッキング機能がサポートされています。 コールバックは再び呼び出されません。