Rapport Player Component
The Rapport Player Component should be created inside of the character’s blueprint and is used to drive the character’s animation.
Functions
Start(URapportSessionComponent* RapportSessionComponent)
Description - This should only be called after the Rapport Session Component has been started. It will begin receiving audio and animation data from the Rapport Session
Parameters
RapportSessionComponent - Reference to the Rapport Session component which you are using. Used to link the Player to the Session
Stop()
Description - Stops driving the character and receiving any data from the Rapport Session
SetMode(const FString& Mode)
Description - Sends a command to Rapport that will set the behaviour mode of the character to whichever mode is specified, assuming that it exists in the character
NOTE: This will only work when called after the OnConnectionEstablished event has been triggered
Parameters
Mode - The behaviour mode to switch the character to
SetEngineModifier(ERapportEngineModifier ModifierType, float Value)
Description - Sends a command to Rapport to set the value of a specified engine modifier
NOTE: This will only work when called after the OnConnectionEstablished event has been triggered
Parameters
ModifierType - The engine modifier which you would like to set the value of
Value - The desired value of the specified engine modifier
Events
Events are essentially triggers that you can bind to in order to carry out some logic when the event occurs.
On Auto Mode Changed - This is triggered when the character changes auto mode. It will return the auto mode that it has changed to as a string
On Mode Changed - This is triggered when the character changes mode. It will return the mode that it has changed to as a string
On Expression Changed - This is triggered when the character changes expression. It will return the expression that it has changed to as a string
On Role Changed - This is triggered when the character changes role; a character role can be either listen or speak. It will return the role that it has changed to as a string
On Audio Response Start - This is triggered when the character starts speaking
On Audio Response End - This is triggered when the character stops speaking
On Audio Input Detected - This is triggered when the speech-to-text processing is complete. It will return the audio that has been detected as a string
On AI Response - This is triggered when the text-to-speech processing is complete. It will return the AI’s response as a string
On Connection Established - This is triggered when the connection to Rapport has been successfully established
