Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


SendHapticBuffer(uint, byte[])

Sends a raw buffer of haptic data to the device.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine.XR
  • Assembly: UnityEngine.XRModule
public bool SendHapticBuffer(uint channel, byte[] buffer)

Parameters

channel

The channel to receive the data.

buffer

A raw byte buffer that contains the haptic data to send to the device.

Returns

Type

Description

boolReturns true if successful. Returns false otherwise.

Remarks

The buffered data plays at the sampleRate rate, represented by the frequencyHz value returned by a call to the TryGetCapabilities method, until it completes.
Note: Not all devices support playing haptic buffers. To determine whether buffered haptics are supported, call the InputDevice.TryGetHapticCapabilities method and inspect the HapticCapabilities.supportsBuffer property. Also, the size of the buffer sent to the InputDevice must never be greater than HapticCapabilities.bufferMaxSize.