XR8

概要

8th WallのJavascript APIのエントリーポイントです。

関数

関数	説明
addCameraPipelineModule	カメラパイプラインの各ステージのイベントコールバックを受信するモジュールを追加します。
addCameraPipelineModules	複数のカメラパイプラインモジュールを追加します。 これは、addCameraPipelineModuleを入力配列の各要素に対して順番に呼び出す便利なメソッドです。
clearCameraPipelineModules	カメラループからすべてのカメラパイプラインモジュールを取り外します。
initialize	AR EngineのWebAssemblyが初期化されたときに解決されるPromiseを返します。
isInitialized	ARエンジンのWebAssemblyが初期化されているかどうかを示します。
isPaused	XRセッションが一時停止しているかどうかを示します。
pause	現在のXRセッションを一時停止します。 一時停止中はカメラフィードが停止し、デバイスの動きもトラッキングしません。
resume	現在のXRセッションを再開します。
removeCameraPipelineModule	カメラパイプラインからモジュールを削除します。
removeCameraPipelineModules	複数のカメラパイプラインモジュールを削除します。 これは、removeCameraPipelineModule を入力配列の各要素に対して順番に呼び出す便利なメソッドです。
requiredPermissions	アプリケーションが必要とする権限のリストを返します。
run	カメラを開き、カメラランループの実行を開始します。
runPreRender	レンダリング前に発生するすべてのライフサイクルアップデートを実行します。
runPostRender	レンダリング後に発生するすべてのライフサイクルアップデートを実行します。
stop	現在のXRセッションを停止します。 停止中はカメラフィードが停止し、デバイスの動きは追跡されません。
version	8th Wall Webエンジンのバージョンを取得します。

イベント

発生するイベント	説明
xrloaded	XR8が読み込まれた時点で、このイベントが発生します。

モジュール

モジュール	説明
AFrame	A-Frameの8th Wall Webとの統合エントリーポイントです。
Babylonjs	Babylon.jsの8th Wall Webとの統合エントリーポイントです。
CameraPixelArray	カメラデータをグレースケールまたはカラーのuint8配列としてアクセスできるカメラパイプラインモジュールを提供します。
CanvasScreenshot	現在のシーンのスクリーンショットを生成可能なカメラパイプラインモジュールを提供します。
FaceController	顔検出とメッシング、およびトラッキングを設定するためのインターフェイスを提供します。
GlTextureRenderer	カメラフィードをキャンバスに描画するカメラパイプラインモジュールと、GL描画処理のための追加ユーティリティを提供します。
HandController	手の検出とメッシュ化、トラッキングを設定するためのインターフェイスを提供する。
LayersController	セマンティックレイヤー検出を可能にするカメラパイプラインモジュールと、レイヤーレンダリングを設定するためのインターフェースを提供します。
MediaRecorder	MP4形式の動画を記録できるカメラパイプラインモジュールを提供します。
PlayCanvas	PlayCanvasの8th Wall Webとの統合エントリーポイントです。
Threejs	three.jsのカメラを操作して仮想オーバーレイを行うカメラパイプラインモジュールを提供します。
Vps	VPSサービスと通信するユーティリティです。
XrConfig	パイプラインモジュールが動作するデバイスやカメラのクラスを指定します。
XrController	XrControllerは、6DoFカメラトラッキングとトラッキングを設定するためのインターフェイスを提供します。
XrDevice	デバイスの互換性と特性に関する情報を提供します。
XrPermissions	パイプラインモジュールに必要なパーミッションを指定するためのユーティリティです。