RUV Components
Rapport Session Component
The Rapport Session Component can be created anywhere, but you must ensure that it is started before any Player Components are started, and stopped after all Player Components have been stopped. The Session Component handles the connection to the Rapport project, as well as the sending and receiving of data. Received animation and audio data will be passed to the Rapport Player Component, if active.
Configuration
The deploy token is required to specify the Rapport project to connect to. This can be found under your Rapport project on the website.
Functions
Start - This will attempt to initialise the connection to Rapport. Once the connection has been established, it will then begin capturing the microphone audio and sending it to Rapport. Note: The default Windows microphone will be used
Stop - This will end the connection to Rapport and will stop capturing microphone audio. This should be called after the Rapport Player Component has been stopped
Restart - Stops the current session if it is active and then starts a new session. This is essentially Stop and Start in one function call
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 - 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
Stop - Stops driving the character and receiving any data from the Rapport Session
Events
Events are essentially triggers that you can bind to in order to carry out some logic when the event occurs. There are currently a few events available on the Rapport Player Component.
On Mode Changed - This is triggered when the character changes modes. It will pass the mode that it has changed to as a string
On Expression Changed - This is triggered when the character changes expressions. It will pass the expression that it has changed to as a string
On Role Changed - This is triggered when the character changes roles; a character role can be either listen or speak. It will pass the role that it has changed to as a string
