OVRHapticsClip Class Reference

A PCM buffer of data for a haptics effect. More...

Public Member Functions

 OVRHapticsClip ()
 
 OVRHapticsClip (int capacity)
 Creates a clip with the specified capacity. More...
 
 OVRHapticsClip (byte[] samples, int samplesCount)
 Creates a clip with the specified data. More...
 
 OVRHapticsClip (OVRHapticsClip a, OVRHapticsClip b)
 Creates a clip by mixing the specified clips. More...
 
 OVRHapticsClip (AudioClip audioClip, int channel=0)
 Creates a haptics clip from the specified audio clip. More...
 
void WriteSample (byte sample)
 Adds the specified sample to the end of the clip. More...
 
void Reset ()
 Clears the clip and resets its size to 0. More...
 

Properties

int Count [get]
 The current number of samples in the clip. More...
 
int Capacity [get]
 The maximum number of samples the clip can store. More...
 
byte [] Samples [get]
 The raw haptics data. More...
 

Detailed Description

A PCM buffer of data for a haptics effect.

Constructor & Destructor Documentation

◆ OVRHapticsClip() [1/5]

OVRHapticsClip.OVRHapticsClip ( )

◆ OVRHapticsClip() [2/5]

OVRHapticsClip.OVRHapticsClip ( int  capacity)

Creates a clip with the specified capacity.

◆ OVRHapticsClip() [3/5]

OVRHapticsClip.OVRHapticsClip ( byte []  samples,
int  samplesCount 
)

Creates a clip with the specified data.

◆ OVRHapticsClip() [4/5]

OVRHapticsClip.OVRHapticsClip ( OVRHapticsClip  a,
OVRHapticsClip  b 
)

Creates a clip by mixing the specified clips.

◆ OVRHapticsClip() [5/5]

OVRHapticsClip.OVRHapticsClip ( AudioClip  audioClip,
int  channel = 0 
)

Creates a haptics clip from the specified audio clip.

Member Function Documentation

◆ Reset()

void OVRHapticsClip.Reset ( )

Clears the clip and resets its size to 0.

◆ WriteSample()

void OVRHapticsClip.WriteSample ( byte  sample)

Adds the specified sample to the end of the clip.

Property Documentation

◆ Capacity

int OVRHapticsClip.Capacity
get

The maximum number of samples the clip can store.

◆ Count

int OVRHapticsClip.Count
get

The current number of samples in the clip.

◆ Samples

byte [] OVRHapticsClip.Samples
get

The raw haptics data.


The documentation for this class was generated from the following file: