API reference
API reference
Select your platform
No SDKs available
No versions available

OVRHaptics Class

Plays tactile effects on a tracked VR controller.

Static Fields

Channels : readonly OVRHapticsChannel[]
Signature 
readonly OVRHapticsChannel [] OVRHaptics.Channels
LeftChannel : readonly OVRHapticsChannel
Signature 
readonly OVRHapticsChannel OVRHaptics.LeftChannel
RightChannel : readonly OVRHapticsChannel
Signature 
readonly OVRHapticsChannel OVRHaptics.RightChannel

Static Methods

Process ()
The system calls this each frame to update haptics playback.
Signature 
static void OVRHaptics.Process()
Returns
void

Inner Classes

Config Class

Determines the target format for haptics data on a specific device.

Properties

MaximumBufferSamplesCount : int
[Get]
Signature 
int OVRHaptics.Config.MaximumBufferSamplesCount
MinimumBufferSamplesCount : int
[Get]
Signature 
int OVRHaptics.Config.MinimumBufferSamplesCount
MinimumSafeSamplesQueued : int
[Get]
Signature 
int OVRHaptics.Config.MinimumSafeSamplesQueued
OptimalBufferSamplesCount : int
[Get]
Signature 
int OVRHaptics.Config.OptimalBufferSamplesCount
SampleRateHz : int
[Get]
Signature 
int OVRHaptics.Config.SampleRateHz
SampleSizeInBytes : int
[Get]
Signature 
int OVRHaptics.Config.SampleSizeInBytes

Static Methods

Load ()
Signature 
static void OVRHaptics.Config.Load()
Returns
void

OVRHapticsChannel Class

A track of haptics data that can be mixed or sequenced with another track.

Constructors

OVRHapticsChannel ( outputIndex )
Constructs a channel targeting the specified output.
Signature 
OVRHaptics.OVRHapticsChannel.OVRHapticsChannel(uint outputIndex)
Parameters
outputIndex: uint

Methods

Clear ()
Cancels any currently-playing clips.
Signature 
void OVRHaptics.OVRHapticsChannel.Clear()
Returns
void
Mix ( clip )
Adds the specified clip to play simultaneously to the currently-playing clip(s).
Signature 
void OVRHaptics.OVRHapticsChannel.Mix(OVRHapticsClip clip)
Parameters
clip: OVRHapticsClip
Returns
void
Preempt ( clip )
Cancels any currently-playing clips and immediatly plays the specified clip instead.
Signature 
void OVRHaptics.OVRHapticsChannel.Preempt(OVRHapticsClip clip)
Parameters
clip: OVRHapticsClip
Returns
void
Queue ( clip )
Enqueues the specified clip to play after any currently-playing clips finish.
Signature 
void OVRHaptics.OVRHapticsChannel.Queue(OVRHapticsClip clip)
Parameters
clip: OVRHapticsClip
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta