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

TTSEventAnimator Class

A base class for performing audio event based animations
Meta::WitAi::TTS::Integrations::TTSEventAnimator extends MonoBehaviour.

Overview

Properties

ITTSEventPlayer
Player[Get]
The audio event player being used for playback
List< TEvent >
Events[Get]
The current events being used for animation

Data Fields

bool
Whether easing should be skipped & values should just be set
AnimationCurve
The easing curve to be used for event lerping

Object Data

void
Awake ( )
On awake, generate min and max events
void
Finds player if needed, adds delegates and refreshes events
void
Current events updated, refresh event list if needed
void
OnSampleUpdated
( int newSample )
Current sample updated, refresh event if needed
void
Remove player delegates on disable
void
Safely set player while adjusting event handling
void
SetPlayerDelegates
( ITTSEventPlayer player,
bool add )
Setter for player delegates
void
RefreshEvents
( bool force )
Updates animation event list
List< TEvent >
Getter method for events, can be overwritten if needed
bool
ShouldUpdateEvents
( List< TEvent > newEvents )
Getter method for events, can be overwritten if needed
void
RefreshSample
( bool force )
Updates currently set sample and lerps between events as specified
abstract void
LerpEvent
( TEvent fromEvent,
TEvent toEvent,
float percentage )
Performs a lerp from an event to another event

Details

Properties

ITTSEventPlayer Meta.WitAi.TTS.Integrations.TTSEventAnimator< TEvent, TData >.Player
The audio event player being used for playback
List<TEvent> Meta.WitAi.TTS.Integrations.TTSEventAnimator< TEvent, TData >.Events
The current events being used for animation

Fields

bool Meta.WitAi.TTS.Integrations.TTSEventAnimator< TEvent, TData >.easeIgnored
Whether easing should be skipped & values should just be set
AnimationCurve Meta.WitAi.TTS.Integrations.TTSEventAnimator< TEvent, TData >.easeCurve
The easing curve to be used for event lerping

Object Data

virtual void Meta.WitAi.TTS.Integrations.TTSEventAnimator< TEvent, TData >.Awake ( )
On awake, generate min and max events
virtual void Meta.WitAi.TTS.Integrations.TTSEventAnimator< TEvent, TData >.OnEnable ( )
Finds player if needed, adds delegates and refreshes events
virtual void Meta.WitAi.TTS.Integrations.TTSEventAnimator< TEvent, TData >.OnEventsUpdated
( TTSEventContainer eventContainer )
Current events updated, refresh event list if needed
virtual void Meta.WitAi.TTS.Integrations.TTSEventAnimator< TEvent, TData >.OnSampleUpdated
( int newSample )
Current sample updated, refresh event if needed
virtual void Meta.WitAi.TTS.Integrations.TTSEventAnimator< TEvent, TData >.OnDisable ( )
Remove player delegates on disable
virtual void Meta.WitAi.TTS.Integrations.TTSEventAnimator< TEvent, TData >.SetPlayer
( ITTSEventPlayer player )
Safely set player while adjusting event handling
virtual void Meta.WitAi.TTS.Integrations.TTSEventAnimator< TEvent, TData >.SetPlayerDelegates
( ITTSEventPlayer player,
bool add )
Setter for player delegates
Parameters
add
Add if true, remove if false
virtual void Meta.WitAi.TTS.Integrations.TTSEventAnimator< TEvent, TData >.RefreshEvents
( bool force )
Updates animation event list
virtual List<TEvent> Meta.WitAi.TTS.Integrations.TTSEventAnimator< TEvent, TData >.GetEvents ( )
Getter method for events, can be overwritten if needed
virtual bool Meta.WitAi.TTS.Integrations.TTSEventAnimator< TEvent, TData >.ShouldUpdateEvents
( List< TEvent > newEvents )
Getter method for events, can be overwritten if needed
virtual void Meta.WitAi.TTS.Integrations.TTSEventAnimator< TEvent, TData >.RefreshSample
( bool force )
Updates currently set sample and lerps between events as specified
Parameters
force
If true, will force the sample set & lerping between events. If false the sample will only be set if it has changed.
abstract void Meta.WitAi.TTS.Integrations.TTSEventAnimator< TEvent, TData >.LerpEvent
( TEvent fromEvent,
TEvent toEvent,
float percentage )
Performs a lerp from an event to another event
Parameters
fromEvent
The event starting point
toEvent
The event ending point
percentage
0 to 1 value with 0 meaning previous event & 1 meaning next event
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2025 Meta