Class DebugXR

A tool that can be used to record and playback any XR data. Useful for debugging and reproducing issues.

Index

Constructors

Properties

player recorder recording xrDevice

Methods

captureFrame loadCapture loadLocalStorageCapture printToConsole saveToFile saveToLocalStorage startPlayback startRecording stopPlayback stopRecording createPlayer createRecorder

Constructors

constructor

new DebugXR(
    playbackMode?: boolean,
    xrSession: XRSession,
    refSpace: XRReferenceSpace,
): DebugXR
Parameters
- playbackMode: boolean = false
- xrSession: XRSession
- refSpace: XRReferenceSpace
Returns DebugXR
- Defined in Source/XR/DebugXR.ts:11

Properties

player

player: any

recorder

recorder: ActionRecorder

recording

recording: boolean = false

xrDevice

xrDevice: XRDevice

Methods

captureFrame

captureFrame(xrFrame: XRFrame): void
Records all inputs and transforms for the given frame
Parameters
- xrFrame: XRFrame
  the frame to capture
Returns void
- Defined in Source/XR/DebugXR.ts:35

loadCapture

loadCapture(refSpace: any, captureLocalFilename: string): void
Loads a file with recorded data and initializes the player for playback.
Parameters
- refSpace: any
  The reference space to use
- captureLocalFilename: string
  The name or full path of the JSON file that has recorded data.
Returns void
- Defined in Source/XR/DebugXR.ts:47

loadLocalStorageCapture

loadLocalStorageCapture(refSpace: any, overrideLocalStorageName?: string): void
Loads recorded data from local storage and initializes the player for playback.
Parameters
- refSpace: any
  The reference space to use
- overrideLocalStorageName: string = "XR-Recording"
  Option for overriding the name of the local storage property, if desired
Returns void
- Defined in Source/XR/DebugXR.ts:63

printToConsole

printToConsole(): void
Prints data that has been recorded so far.

Returns void
- Defined in Source/XR/DebugXR.ts:76

saveToFile

saveToFile(fileName: string): void
Saves and downloads data that has been recorded so far to a text file.
Parameters
- fileName: string
  Desired name of the file
Returns void
- Defined in Source/XR/DebugXR.ts:86

saveToLocalStorage

saveToLocalStorage(): void
Saves data that has been recorded to local storage. Not recommended for very large recordings, use saveToFile instead.

Returns void
- Defined in Source/XR/DebugXR.ts:121

startPlayback

startPlayback(): void
Returns void
- Defined in Source/XR/DebugXR.ts:145

startRecording

startRecording(): void
Returns void
- Defined in Source/XR/DebugXR.ts:135

stopPlayback

stopPlayback(): void
Returns void
- Defined in Source/XR/DebugXR.ts:152

stopRecording

stopRecording(): void
Returns void
- Defined in Source/XR/DebugXR.ts:140

`Static`createPlayer

createPlayer(): DebugXR
Returns DebugXR
- Defined in Source/XR/DebugXR.ts:27

`Static`createRecorder

createRecorder(xrSession: XRSession, refSpace: XRReferenceSpace): DebugXR
Parameters
- xrSession: XRSession
- refSpace: XRReferenceSpace
Returns DebugXR
- Defined in Source/XR/DebugXR.ts:23