Meta Developers

Unreal-haptics v67 Reference Guide

Unity

Select your SDK

Overview

MetaXRHapticClip.h

MetaXRHapticsFunctionLibrary.h

MetaXRHapticsPlayerComponent.h

UMetaXRHapticClip

UMetaXRHapticsFunctionLibrary

UMetaXRHapticsPlayerComponent

Code samples

Downloads

Release notes

UMetaXRHapticsPlayerComponent Class

UMetaXRHapticsPlayerComponent extends UActorComponent.

Overview

Public Member Functions

	UMetaXRHapticsPlayerComponent ( )
void	Play ( )
void	PlayOnController ( const EMetaXRHapticController InController )
void	PlayWithInputs ( const EMetaXRHapticController InController, const int32 InPriority, const float InAmplitude, const float InFrequencyShift, const bool bInIsLooping )
void	Stop ( )
void	SetHapticClip ( UMetaXRHapticClip * InHapticClip )
UMetaXRHapticClip *	GetHapticClip ( )
void	SetController ( const EMetaXRHapticController & InController )
EMetaXRHapticController	GetController ( )
void	SetPriority ( const int32 InPriority )
int32	GetPriority ( )
void	SetAmplitude ( const float InAmplitude )
float	GetAmplitude ( )
void	SetFrequencyShift ( const float InFrequencyShift )
float	GetFrequencyShift ( )
void	SetLooping ( const bool bInIsLooping )
bool	GetLooping ( )
float	GetClipDuration ( )

Details

Detailed Description

Component for playing back haptic clips.

After setting a haptic clip with the HapticClip property, playback can be started with Play() or PlayWithInputs().

The properties Amplitude, FrequencyShift, Priority and bIsLooping control playback.

Member Functions

UMetaXRHapticsPlayerComponent::UMetaXRHapticsPlayerComponent ( )
No description available.

void UMetaXRHapticsPlayerComponent::Play ( )
Start playback of the haptic clip set with the HapticClip property.

void UMetaXRHapticsPlayerComponent::PlayOnController ( const EMetaXRHapticController InController )
Start playback of the haptic clip set with the HapticClip property on the specified controller. Does not set the Controller property. Parameters InController Which controller should play the haptic clip.

void UMetaXRHapticsPlayerComponent::PlayWithInputs ( const EMetaXRHapticController InController, const int32 InPriority, const float InAmplitude, const float InFrequencyShift, const bool bInIsLooping )
Start playback of the haptic clip with custom inputs. This is a convenience method that sets the properties corresponding to the input parameters, and then starts playback. Parameters InController Which Controller should play the haptic clip. InPriority Playback Priority, ranging from 0 (low priority) to 1024 (high priority). InAmplitude Amplitude scale, ranging from 0.0 to infinite. InFrequencyShift FrequencyShift, ranging from -1.0 to 1.0. bInIsLooping Whether playback should loop, see bIsLooping

void UMetaXRHapticsPlayerComponent::PlayWithInputs
( const EMetaXRHapticController InController,
const int32 InPriority,
const float InAmplitude,
const float InFrequencyShift,
const bool bInIsLooping )

Start playback of the haptic clip with custom inputs.

This is a convenience method that sets the properties corresponding to the input parameters, and then starts playback.

Parameters

InController

Which Controller should play the haptic clip.

InPriority

Playback Priority, ranging from 0 (low priority) to 1024 (high priority).

InAmplitude

Amplitude scale, ranging from 0.0 to infinite.

InFrequencyShift

FrequencyShift, ranging from -1.0 to 1.0.

bInIsLooping

Whether playback should loop, see bIsLooping

void UMetaXRHapticsPlayerComponent::Stop ( )
Stops playback.

void UMetaXRHapticsPlayerComponent::SetHapticClip ( UMetaXRHapticClip * InHapticClip )
Setter for the HapticClip property. Parameters InHapticClip The haptic clip to set.

*UMetaXRHapticClip UMetaXRHapticsPlayerComponent::GetHapticClip ( )**
Getter for the HapticClip property.

void UMetaXRHapticsPlayerComponent::SetController ( const EMetaXRHapticController & InController )
Setter for the Controller property. Parameters InController The controller to set.

EMetaXRHapticController UMetaXRHapticsPlayerComponent::GetController ( )
Getter for the Controller property.

void UMetaXRHapticsPlayerComponent::SetPriority ( const int32 InPriority )
Setter for the Priority property. When multiple players are playing at the same time on the same controller, only the player with the highest priority will trigger vibrations. If multiple players have the same priority level, then the player that was started most recently will trigger vibrations. The priority can be any integer value between 0 (low priority) and 1024 (high priority). The default value is 512. The player's priority can be changed before and during playback. Parameters InPriority The priority to set, can be any integer value between 0 (low priority) and 1024 (high priority).

void UMetaXRHapticsPlayerComponent::SetPriority
( const int32 InPriority )

Setter for the Priority property.

When multiple players are playing at the same time on the same controller, only the player with the highest priority will trigger vibrations.

If multiple players have the same priority level, then the player that was started most recently will trigger vibrations.

The priority can be any integer value between 0 (low priority) and 1024 (high priority). The default value is 512.

The player's priority can be changed before and during playback.

Parameters

InPriority

The priority to set, can be any integer value between 0 (low priority) and 1024 (high priority).

int32 UMetaXRHapticsPlayerComponent::GetPriority ( )
Getter for the Priority property. See SetPriority() for more details

void UMetaXRHapticsPlayerComponent::SetAmplitude ( const float InAmplitude )
Setter for the Amplitude property. The amplitude scale controls the vibration intensity during playback. During playback, the individual amplitudes in the clip will be multiplied by the player's amplitude. This changes how strong the vibration is. Amplitude values in a clip range from 0.0 to 1.0, and the result after applying the amplitude scale will be clipped to that range. An amplitude of 0.0 means that no vibration will be triggered, and an amplitude of 0.5 will result in the clip being played back at half of its amplitude. Example: if you apply amplitude of 5.0 to a haptic clip and the following amplitudes are in the clip: [0.2, 0.5, 0.1], the initial amplitude calculation would produce these values: [1.0, 2.5, 0.5] which will then be clamped like this: [1.0, 1.0, 0.5] The property can be changed during active playback, in which case the amplitude is applied immediately, with a small delay in the tens of milliseconds. Parameters InAmplitude The amplitude to set, has to be higher or equal to zero.

void UMetaXRHapticsPlayerComponent::SetAmplitude
( const float InAmplitude )

Setter for the Amplitude property.

The amplitude scale controls the vibration intensity during playback.

During playback, the individual amplitudes in the clip will be multiplied by the player's amplitude. This changes how strong the vibration is. Amplitude values in a clip range from 0.0 to 1.0, and the result after applying the amplitude scale will be clipped to that range.

An amplitude of 0.0 means that no vibration will be triggered, and an amplitude of 0.5 will result in the clip being played back at half of its amplitude.

Example: if you apply amplitude of 5.0 to a haptic clip and the following amplitudes are in the clip: [0.2, 0.5, 0.1], the initial amplitude calculation would produce these values: [1.0, 2.5, 0.5] which will then be clamped like this: [1.0, 1.0, 0.5]

The property can be changed during active playback, in which case the amplitude is applied immediately, with a small delay in the tens of milliseconds.

Parameters

InAmplitude

The amplitude to set, has to be higher or equal to zero.

float UMetaXRHapticsPlayerComponent::GetAmplitude ( )
Getter for the Amplitude property. See SetAmplitude() for more details

void UMetaXRHapticsPlayerComponent::SetFrequencyShift ( const float InFrequencyShift )
Setter for the FrequencyShift property. The frequency shift controls the vibration frequency during playback. During playback, the individual frequencies in the clip will be shifted up or down. The acceptable range of values is -1.0 to 1.0 inclusive. Once the frequencies in a clip have been shifted, they will be clamped to the playable range of frequency values, i.e. zero to one. Setting this property to 0.0 means that the frequencies will not be changed. Example: if you apply a frequency shift of 0.8 to a haptic clip and the following frequencies are in the clip: [0.1, 0.5, 0.0], the initial frequency shift calculation will produce these frequencies: [0.9, 1.3, 0.8] which will then be clamped like this: [0.9, 1.0, 0.8] The property can be changed during active playback, in which case the frequency shift is applied immediately, with a small delay in the tens of milliseconds. Parameters InFrequencyShift The frequency shift to set, acceptable range of values is -1.0 to 1.0 inclusive

void UMetaXRHapticsPlayerComponent::SetFrequencyShift
( const float InFrequencyShift )

Setter for the FrequencyShift property.

The frequency shift controls the vibration frequency during playback.

During playback, the individual frequencies in the clip will be shifted up or down. The acceptable range of values is -1.0 to 1.0 inclusive. Once the frequencies in a clip have been shifted, they will be clamped to the playable range of frequency values, i.e. zero to one. Setting this property to 0.0 means that the frequencies will not be changed.

Example: if you apply a frequency shift of 0.8 to a haptic clip and the following frequencies are in the clip: [0.1, 0.5, 0.0], the initial frequency shift calculation will produce these frequencies: [0.9, 1.3, 0.8] which will then be clamped like this: [0.9, 1.0, 0.8]

The property can be changed during active playback, in which case the frequency shift is applied immediately, with a small delay in the tens of milliseconds.

Parameters

InFrequencyShift

The frequency shift to set, acceptable range of values is -1.0 to 1.0 inclusive

float UMetaXRHapticsPlayerComponent::GetFrequencyShift ( )
Getter for the FrequencyShift property. See SetFrequencyShift() for more details

void UMetaXRHapticsPlayerComponent::SetLooping ( const bool bInIsLooping )
Setter for the bIsLooping property. When looping is enabled, clip playback will be repeated indefinitely. Looping can be enabled or disabled during playback. Parameters bInIsLooping whether playback is looped.