Meta Developers

Uninitialized	The OVRTrackedKeyboard component has not yet been initialized.
NoTrackableKeyboard	Component is initialized but user has not selected a keyboard to track in the system settings.
Offline	Keyboard tracking has been stopped or has not yet started for current keyboard.
StartedNotTracked	Keyboard tracking has been started but no tracking data is yet available.
Stale	Keyboard tracking has been started but no tracking data has been available for a while.
Valid	Keyboard is currently being tracked and recent tracking data is available.
Error	An error occurred while initializing keyboard tracking.
ErrorExtensionFailed	Was unable to retrieve system keyboard info.

Enumeration KeyboardPresentation

Determines which visualization is used for the tracked keyboard.

PreferOpaque	The keyboard is rendered as an opaque model in VR and if the user's hands are placed over it, they are rendered using passthrough.
PreferMR	The keyboard and hands are rendered using a rectangular passthrough window around the keyboard.

Properties

float CurrentKeyboardAngleFromUp[Get]

Determines amount that keyboard is tilted from its ordinary horizontal position.

For internal use.

TrackedKeyboardState TrackingState[Get]

Current state of keyboard tracking.

OVRKeyboard.TrackedKeyboardInfo ActiveKeyboardInfo[Get]

Provides information about the keyboard currently being tracked by this OVRTrackedKeyboard component.

OVRKeyboard.TrackedKeyboardInfo SystemKeyboardInfo[Get]

Provides information about the keyboard currently selected for tracking in the system settings.

May not yet be tracked by this OVRTrackedKeyboard component.

KeyboardPresentation Presentation[Get]

Determines which visualization will be used to present the tracked keyboard to the user.

bool TrackingEnabled[Get]

Specifies whether or not the OVRTrackedKeyboard component will attempt to search for and track a keyboard.

If true, the component will continually search for a tracked keyboard. If one is detected it will be shown. If false, no keyboard is shown and the prefab is inactive. The keyboard can still be used to enter text into input fields even though it cannot be seen in VR.

bool ConnectionRequired[Get]

Specifies whether or not the keyboard must be connected via Bluetooth in order to be tracked.

If set to true, the keyboard must be connected to the headset via Bluetooth in order to be tracked. The keyboard will stop being tracked if it is powered off or disconnected from the headset. If set to false, the keyboard will be tracked as long as it is visible to the headset's cameras.

bool ShowUntracked[Get]

If true, will show the keyboard even if it is not currently connected or visible to the cameras.

This is mainly useful for testing the feature when you don't have access to a physical keyboard. The keyboard that appears will be based on which keyboard is selected in Settings on the headset. The keyboard will appear in front of the user at waist level.

bool RemoteKeyboard[Get]

OVRPlugin.TrackedKeyboardQueryFlags KeyboardQueryFlags[Get]

Specifies whether to search for local keyboards attached to the headset or for remote keyboards not attached to the headset.

OVROverlay PassthroughOverlay[Get]

Internal only.

The passthrough layer used to render the passthrough rectangle in opaque mode.

Fields

OVRTextureQualityFiltering textureFiltering[Get]

float mipmapBias[Get]

float PassthroughBorderMultiplier[Get]

How large of a passthrough area to show surrounding the keyboard when using MR presentation.

Shader keyboardModelShader[Get]

The shader used for rendering the keyboard model in opaque mode.

Shader keyboardModelAlphaBlendShader[Get]

The shader used for rendering transparent parts of the keyboard model in opaque mode.

Shader PassthroughShader[Get]

Internal only.

The shader used to render the passthrough rectangle in opaque mode.

OVRPassthroughLayer ProjectedPassthroughMR[Get]

Internal only.

The passthrough layer used to render the passthrough rectangle in MR mode.

Action< TrackedKeyboardSetActiveEvent > TrackedKeyboardActiveChanged[Get]

Event that is dispatched when the component starts or stops actively tracking the keyboard.

Action< TrackedKeyboardVisibilityChangedEvent > TrackedKeyboardVisibilityChanged[Get]

Event that is dispatched when the state of keyboard tracking changes (e.g.

tracking becomes stale or valid as keyboard passes in/out of camera view).

Transform ActiveKeyboardTransform[Get]

Transform that determines current position and rotation of the keyboard.

bool HandsOverKeyboard[Get]

Internal only.

Determines whether the hands are currently positioned over the keyboard. In opaque presentation mode, passthrough hands are only shown when this is true.

bool UseHeuristicRollback[Get]

Determines whether rolling average filter and keyboard angle filters are applied.

If true, keyboard will be shown in latest tracked position at all times.

Member Functions

float GetDistanceToKeyboard

( Vector3 point )

Returns the distance from the given point to the keyboard.

Parameters

point

A 3D vector coordinate to use as the reference point

Returns

A floating point value that is the distance to intersect within the keyboard bounds

void LaunchLocalKeyboardSelectionDialog ( )

Invokes an Android broadcast to launch a keyboard selection dialog for local keyboard type.

void LaunchRemoteKeyboardSelectionDialog ( )

Invokes an Android broadcast to launch a keyboard selection dialog for remote keyboard type.

void UpdateKeyboardVisibility ( )

Internal only.

Updates rendering of keyboard based on its current visibility.

void Dispose ( )

Stops keyboard tracking and cleans up associated resources.