Wikitude SDK APIリファレンス

バージョン: 8.1.0
表示:

CloudRecognitionServiceクラス

継承元: ARchitectObject
モジュール: AR

CloudRecognitionServiceはWikitude Studio Managerで作成され、Wikitudeクラウドサービスによってホストされるターゲットコレクションを表します。
ターゲットのバイナリであるwtcターゲットを含める必要があり、clientTokenとtargetCollectionIdを介して参照する必要があります。

Example:
// create the cloud recognition service and pass setup parameters
World.cloudRecognitionService = new AR.CloudRecognitionService("b277eeadc6183ab57a83b07682b3ceba", "54e4b9fe6134bb74351b2aa3", {
    onInitialized: function() { alert("initialized"); },
    onError: function() { alert("error"); }
});

コンストラクター

CloudRecognitionService

(
  • clientToken
  • targetCollectionId
  • options
)

Parameters:

  • clientToken String

    ユニークなクライアントトークン

  • targetCollectionId String

    使用するターゲットコレクションのID

  • options Object オプション

    追加のオブジェクトプロパティをカスタマイズするためのパラメーター。

    設定可能なプロパティは以下のとおりです。

    • onInitialized Function オプション
    • onError Function オプション
    • cloudRecognitionServerURL String オプション

メソッド

destroy

()

継承元: ARchitectObject

オブジェクトを破棄します。

recognize

(
  • onRecognized
  • onError
)

認識プロセスを1回開始します。
この関数が呼び出されると、現在のカメラフレームがサーバーに送信され、処理されます。 サーバーが作業を終えると、onRecognizedCallbackが呼び出されます。

パラメーター:

  • onRecognized Function

    SDKがサーバー応答を受け取ったときに呼び出されるコールバック関数。
    このコールバックには2つのパラメータがあります。

    • recognized True if a reference image could be found in the current camera image, false otherwise
    • recognitionData targetInfoオブジェクトとオプションのmetadata オブジェクトを含むJSONオブジェクト。
      • targetInfo  targetNameを含むJSONオブジェクト。星印でオプションです。物理的な高さはmmです。
      • metadata 作成中にターゲットイメージに割り当てられたカスタムメタデータJSONオブジェクト。
  • onError Function オプション

    SDKがCloud Recognitionサーバーに接続できなかったとき、または認識中にサーバーでエラーが発生したときに呼び出されるコールバック関数。
    このコールバックには2つのパラメータがあります。

    • code 発生したエラーの種類を表す数値。
    • errorObject 何が失敗したか詳細情報を含むJSONオブジェクト。

startContinuousRecognition

(
  • interval
  • onInterruptionCallback
  • onRecognizedCallback
  • onErrorCallback
)

Starts a continuous recognition session.
連続して認識セッションを開始します。
アクティブに連続する認識セッションは、指定された間隔で新しいカメラフレームをサーバーにアップロードします。

パラメーター:

  • interval Number

    新しい認識を開始する間隔。最小値は500ミリ秒です。

  • onInterruptionCallback Function オプション

    間隔が現在のネットワーク条件に適合しない数値に設定されているときに呼び出されるコールバック関数。
    このコールバックには1つのパラメータがあります。: suggestedInterval 現在のネットワーク条件で使用できる間隔を表す数値。

  • onRecognizedCallback Function

    SDKがサーバー応答を受け取ったときに呼び出されるコールバック関数。詳細については、CloudTracker / recognition：メソッドを参照してください。

  • onErrorCallback Function オプション

    SDKがCloud Recognitionサーバーに接続できなかったとき、または認識中にサーバーでエラーが発生したときに呼び出されるコールバック関数。このコールバックには2つのパラメータがあります。:

    • code 発生したエラーの種類を表す数字。
    • errorObject 何が失敗したか詳細情報を含むJSONオブジェクト。

stopContinuousRecognition

()

アクティブな連続する認識セッションを停止します。

パラメーター:

clientToken

String

ターゲットコレクションが属するユーザーアカウントを識別するクライアントトークン。このプロパティは読み取り専用で、作成時にのみ設定できます。

destroyed

Boolean

継承元: ARchitectObject

オブジェクトがすでに破棄されているかどうかを示します。

groupId

String

ターゲットコレクションが属するユーザーアカウントを識別するgroupId プロパティは読み取り専用で、作成時にのみ設定できます。

クラウド認識サービスが、グループIDを明示的に指定していないAPIで作成された場合、groupIdは空の文字列です。

targetCollectionId

String

特定のイメージターゲットコレクションを識別するターゲットコレクションID。このプロパティは読み取り専用で、作成時にのみ設定できます。

イベント

onError

Wikitude Cloud Serviceサーバーへの接続が確立できなかったときにトリガーが発生します。これにはネットワークに接続できない問題が含まれている可能性があります。

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

onInitialized

Wikitude Cloud Serviceサーバーへの接続が確立されると、トリガーが発生します。

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