Version: Unity 6 (6000.0)
LanguageEnglish
  • C#

InputDevice.SendHapticBuffer

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

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

bool Returns true if successful. Returns false otherwise.

Description

Sends a raw buffer of haptic data to the device.

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.