Google.XR.Cardboard.Api

CardboardXR Plugin API.

Summary

Properties

IsCloseButtonPressed
static bool
Gets a value indicating whether the close button is pressed this frame.
IsGearButtonPressed
static bool
Gets a value indicating whether the gear button is pressed this frame.
IsTriggerHeldPressed
static bool
Gets a value indicating whether Cardboard trigger button is held pressed.
IsTriggerPressed
static bool
Gets a value indicating whether the Cardboard trigger button is pressed this frame.
MinTriggerHeldPressedTime
static double
Gets or sets the amount of time the trigger must be held active to be held pressed.

Public static functions

HasDeviceParams()
bool
Evaluates whether or not device params are saved in the storage.
HasNewDeviceParams()
bool
Evaluates if device parameters changed from last time they were reloaded.
Recenter()
void
Recenters the head tracker.
ReloadDeviceParams()
void
Enables device parameter reconfiguration on next frame update.
SaveDeviceParams(string uri)
void
Saves the encoded device parameters provided by an URI.
ScanDeviceParams()
void
Starts QR Code scanning activity.
UpdateScreenParams()
void
Updates screen parameters.

Properties

IsCloseButtonPressed

static bool IsCloseButtonPressed

Gets a value indicating whether the close button is pressed this frame.

IsGearButtonPressed

static bool IsGearButtonPressed

Gets a value indicating whether the gear button is pressed this frame.

IsTriggerHeldPressed

static bool IsTriggerHeldPressed

Gets a value indicating whether Cardboard trigger button is held pressed.

IsTriggerPressed

static bool IsTriggerPressed

Gets a value indicating whether the Cardboard trigger button is pressed this frame.

MinTriggerHeldPressedTime

static double MinTriggerHeldPressedTime

Gets or sets the amount of time the trigger must be held active to be held pressed.

Public static functions

HasDeviceParams

bool HasDeviceParams()

Evaluates whether or not device params are saved in the storage.

Details
Returns
Whether or not device parameters are found.

HasNewDeviceParams

bool HasNewDeviceParams()

Evaluates if device parameters changed from last time they were reloaded.

Details
Returns
true when device parameters changed.

Recenter

void Recenter()

Recenters the head tracker.

ReloadDeviceParams

void ReloadDeviceParams()

Enables device parameter reconfiguration on next frame update.

SaveDeviceParams

void SaveDeviceParams(
  string uri
)

Saves the encoded device parameters provided by an URI.

Expected URI format for:

Redirection is also supported up to a maximum of 5 possible redirects before reaching the proper pattern.

Only URIs using HTTPS protocol are supported.

Details
Parameters
uri
The URI string. See above for supported formats.

ScanDeviceParams

void ScanDeviceParams()

Starts QR Code scanning activity.

UpdateScreenParams

void UpdateScreenParams()

Updates screen parameters.

This method must be called at framerate to ensure the current screen orientation is properly taken into account by the head tracker. This method also ensures that the safe area size is properly set on iOS devices (see note below).

Note: The safe area size check is a workaround for Issue #1288515 in Unity.