Scripting reference

Reference for the Convai Unity SDK C# scripting APIs — events, transcripts, audio control, and async operation patterns.

The Convai Unity SDK exposes two complementary approaches for C# integration. ConvaiSessionEventRelay, ConvaiCharacterEventRelay, and ConvaiTranscriptEventRelay are MonoBehaviours that wire events directly in the Inspector — no code required. For scripted reactions and programmatic control, the ConvaiEvents typed event hub and each component's C# API give full access from any script. Both approaches observe the same underlying SDK events and can be combined freely.

Session events Connection state, errors, idle warnings, and participant changes via relay component or typed C# hub.

Character events Speech, emotion, transcript, turn lifecycle, and action events via relay component or typed C# hub.

Transcript API Pull-based facade for querying and subscribing to the live in-memory transcript timeline.

Character & Player API Full method, property, and event reference for ConvaiCharacter and ConvaiPlayer.

ConvaiManager API SDK entry point — connection control, facade accessors, conversation ownership, and service discovery.

Audio API Microphone muting, per-character audio control, audio playback unlock, and listening state.

Operation & stream types Type reference for IConvaiOperation<T>, IConvaiStream<T>, ConvaiError, Unit, and status enums.

Async patterns Six patterns for consuming SDK async types: async/await, coroutines, chaining, progress, cancellation, and streams.

Next steps

Start with Session Events and Character Events to wire SDK events to your scene logic, then explore the ConvaiManager API for connection control and the Async Patterns page for consumption guidance.