@vowel.to/client / index / SessionConfig
Interface: SessionConfig
Defined in: lib/vowel/managers/SessionManager.ts:59
Session configuration options
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
appId? | string | App ID (optional if using direct token via voiceConfig.token) | lib/vowel/managers/SessionManager.ts:61 |
routes | VowelRoute[] | Available routes | lib/vowel/managers/SessionManager.ts:63 |
toolManager | ToolManager | Tool manager for executing tools | lib/vowel/managers/SessionManager.ts:65 |
audioManager | AudioManager | Audio manager for audio handling | lib/vowel/managers/SessionManager.ts:67 |
voiceConfig? | VowelVoiceConfig | Voice configuration | lib/vowel/managers/SessionManager.ts:69 |
instructions? | string | Custom system instructions for the AI agent | lib/vowel/managers/SessionManager.ts:71 |
systemInstructionOverride? | string | Deprecated Use 'instructions' instead Legacy alias for instructions (backward compatibility) | lib/vowel/managers/SessionManager.ts:76 |
onMessage? | MessageHandler | Message handler callback | lib/vowel/managers/SessionManager.ts:78 |
onStatusUpdate? | StatusUpdateHandler | Status update callback | lib/vowel/managers/SessionManager.ts:80 |
onOpen? | () => void | Connection opened callback | lib/vowel/managers/SessionManager.ts:82 |
onClose? | (reason) => void | Connection closed callback | lib/vowel/managers/SessionManager.ts:84 |
onError? | (error) => void | Error callback | lib/vowel/managers/SessionManager.ts:86 |
convexUrl? | string | Custom Convex platform URL (base URL) | lib/vowel/managers/SessionManager.ts:88 |
tokenEndpoint? | string | Custom token endpoint URL | lib/vowel/managers/SessionManager.ts:90 |
tokenProvider? | (config) => Promise<{ tokenName: string; model: string; provider: "gemini" | "openai" | "vowel-prime"; expiresAt: string; systemInstructions?: string; }> | Custom token provider function | lib/vowel/managers/SessionManager.ts:92 |
onUserSpeakingChange? | (isSpeaking) => void | User speaking state change callback | lib/vowel/managers/SessionManager.ts:100 |
onAIThinkingChange? | (isThinking) => void | AI thinking state change callback | lib/vowel/managers/SessionManager.ts:102 |
onToolExecutingChange? | (isExecuting) => void | Tool execution state change callback | lib/vowel/managers/SessionManager.ts:104 |
onAISpeakingChange? | (isSpeaking) => void | AI speaking state change callback (already handled by AudioManager) | lib/vowel/managers/SessionManager.ts:106 |
typingSoundManager? | TypingSoundManager | Typing sound manager instance | lib/vowel/managers/SessionManager.ts:108 |
onTranscriptEvent? | (event) => void | Transcript event callback (for caption system) | lib/vowel/managers/SessionManager.ts:110 |