RapportEvents | Rapport Documentation

Event Enums

TTSEvent

These events are triggered when the session is handling Text-to-Speech (TTS) audio.

Start: The TTS audio stream has begun playback.
End: The TTS audio stream has finished playing.

NetworkEvent

These events track the connection status of the session to the Rapport cloud platform.

Connecting: The session is attempting to establish a connection.
Connected: A connection has been successfully established.
Disconnected: The session has been disconnected.

LatencyEvent

These events provide real-time feedback on the session's performance by measuring the latency between the local application and the Rapport cloud. The DemoUIController script uses this event to update the latency signal UI.

Good: The session is operating with optimal latency.
Medium: The session is experiencing slightly elevated latency.
Failing: The session is experiencing a significant amount of latency, which may affect performance.

PlaybackControlEvent

These events are triggered when the microphone or speaker is muted or unmuted.

Speaker_Muted: The speaker has been muted.
Speaker_Unmuted: The speaker has been unmuted.
Microphone_Muted: The microphone has been muted.
Microphone_Unmuted: The microphone has been unmuted.

PlayerEvent

These events are related to the RapportPlayer component, which handles the real-time animation and audio playback for the digital character.

Created: The RapportPlayer object has been instantiated.
Loaded: The RapportPlayer has finished loading all necessary resources.
Rendering: The player is actively rendering animation.
Destroyed: The RapportPlayer object has been destroyed.

ErrorEvent

These events are triggered when various errors occur during a session.

API_Error: An error occurred with the Rapport API.
Conn_Error: An error occurred with the network connection.
Runtime_Error: An error occurred during the session's runtime.

ResourceEvent

This event is triggered when a resource (e.g., animation data) is ready.

Resource_Ready: A requested resource has been successfully loaded and is ready for use.

AnimationEvent

These events signal changes in the character's animation state.

AutoModeChanged: The character's animation mode has changed.
ModeChanged: The character's animation mode has changed.
ExpressionChanged: The character's facial expression has changed.
RoleChanged: The character's speaking role has changed.

Events

Name	Type	Description
OnTTSSignal	event TTSSignalDelegate	This event is triggered when a text-to-speech (TTS) process starts or ends. It provides information about the text being processed.
OnNetworkSignal	event NetworkSignalDelegate	This event signals changes in the network connection state, such as when the system is connecting, is fully connected, or has been disconnected.
OnLatencySignal	event LatencySignalDelegate	This event provides real-time updates on the session's latency status, indicating whether it is good, medium, or failing.
OnPlaybackControlSignal	event PlaybackControlEventDelegate	This event is triggered when the microphone or speaker mute status changes.
OnPlayerEvent	event PlayerEventDelegate	This event signals various stages in the lifecycle of a player object, including when it is created, loaded, starts rendering, or is destroyed.
OnErrorEvent	event ErrorEventDelegate	This event is sent whenever a runtime, API, or connection error occurs, providing details about the issue and whether it is unrecoverable.
OnResourceEvent	event ResourceEventDelegate	This event is triggered when a resource, such as animation or audio data, is successfully loaded and ready for use.
OnAnimationEvent	event AnimationEventDelegate	This event signals a change in the character's animation state, such as a change in mode, expression, or role.