Rapport Session Component
The Rapport Session Component can be created anywhere, but you should 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 Rapport, 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(URapportAudioSource* RapportAudioSource)
Description - This will attempt to initialise the connection to Rapport. Once the connection has been established, the component will then begin sending audio data received from the audio source to Rapport
Parameters
Rapport Audio Source - The source to use for input audio. There are some existing sources that you can use, or you can extend IRapportAudioSource and create your own
Stop()
Description - This will end the connection to Rapport. This should be called after the Rapport Player Component has been stopped
Restart()
Description - Stops the current session if it is active and then starts a new session. This is essentially Stop and Start in one function call
SetAudioInputMute(bool bMute)
Description - This will set whether input audio is sent to Rapport or not. If muted then silent audio data will be sent instead
Parameters
bMute - A boolean which determines the mute state. If true then the input will be muted, if false then it will be unmuted