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
GetMode(FRapportGetModeSignature GetModeCallback)
Description - Sends a command to Rapport that will get the current behaviour mode of the character
NOTE: This will only work when called after the OnConnectionEstablished event has been triggered
Parameters
GetModeCallback - A callback that will be triggered when the current mode is returned from Rapport
SetBreathConfig(float AnimationSpeed, float AnimationMagnitude)
Description - Sends a command to Rapport that will set the breath configuration of the character. See engine modifiers for more info
NOTE: This will only work when called after the OnConnectionEstablished event has been triggered
Parameters
AnimationSpeed - Adjusts speed and frequency of breath movements
AnimationMagnitude - Adjusts magnitude of all breaths
GetBreathConfig(FRapportGetBreathConfigSignature GetBreathConfigCallback)
Description - Sends a command to Rapport that will get the current breath configuration of the character. See engine modifiers for more info
NOTE: This will only work when called after the OnConnectionEstablished event has been triggered
Parameters
GetBreathConfigCallback - A callback that will be triggered when the current breath configuration is returned from Rapport
SetEyesConfig(float BlinkFrequency, float DartFrequency)
Description - Sends a command to Rapport that will set the eyes configuration of the character. See engine modifiers for more info
NOTE: This will only work when called after the OnConnectionEstablished event has been triggered
Parameters
BlinkFrequency - Adjusts frequency of blinks
DartFrequency - Adjusts frequency of eye microdarts
GetEyesConfig(FRapportGetEyesConfigSignature GetEyesConfigCallback)
Description - Sends a command to Rapport that will get the current eyes configuration of the character. See engine modifiers for more info
NOTE: This will only work when called after the OnConnectionEstablished event has been triggered
Parameters
GetEyesConfigCallback - A callback that will be triggered when the current eyes configuration is returned from Rapport
SetExpressionsConfig(float AnimationMagnitude, float AnimationSpeed, float ChangeFrequency)
Description - Sends a command to Rapport that will set the expressions configuration of the character. See engine modifiers for more info
NOTE: This will only work when called after the OnConnectionEstablished event has been triggered
Parameters
AnimationMagnitude - Adjusts magnitude of all nonverbal movements
AnimationSpeed - Adjusts speed of all nonverbal movements
ChangeFrequency - Adjusts frequency of expression changes
GetExpressionsConfig(FRapportGetExpressionsConfigSignature GetExpressionsConfigCallback)
Description - Sends a command to Rapport that will get the current expressions configuration of the character. See engine modifiers for more info
NOTE: This will only work when called after the OnConnectionEstablished event has been triggered
Parameters
GetExpressionsConfigCallback - A callback that will be triggered when the current expressions configuration is returned from Rapport
SetSpeechConfig(float AnimationMagnitude)
Description - Sends a command to Rapport that will set the speech configuration of the character. See engine modifiers for more info
NOTE: This will only work when called after the OnConnectionEstablished event has been triggered
Parameters
AnimationMagnitude - Adjusts magnitude of all speech movements
GetSpeechConfig(FRapportGetSpeechConfigSignature GetSpeechConfigCallback)
Description - Sends a command to Rapport that will get the current speech configuration of the character. See engine modifiers for more info
NOTE: This will only work when called after the OnConnectionEstablished event has been triggered
Parameters
GetSpeechConfigCallback - A callback that will be triggered when the current speech configuration is returned from Rapport
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
