Skip to content

@vowel.to/client v0.1.2-393


@vowel.to/client / index / SessionConfig

Interface: SessionConfig

Defined in: lib/vowel/managers/SessionManager.ts:59

Session configuration options

Properties

PropertyTypeDescriptionDefined in
appId?stringApp ID (optional if using direct token via voiceConfig.token)lib/vowel/managers/SessionManager.ts:61
routesVowelRoute[]Available routeslib/vowel/managers/SessionManager.ts:63
toolManagerToolManagerTool manager for executing toolslib/vowel/managers/SessionManager.ts:65
audioManagerAudioManagerAudio manager for audio handlinglib/vowel/managers/SessionManager.ts:67
voiceConfig?VowelVoiceConfigVoice configurationlib/vowel/managers/SessionManager.ts:69
instructions?stringCustom system instructions for the AI agentlib/vowel/managers/SessionManager.ts:71
systemInstructionOverride?stringDeprecated Use 'instructions' instead Legacy alias for instructions (backward compatibility)lib/vowel/managers/SessionManager.ts:76
onMessage?MessageHandlerMessage handler callbacklib/vowel/managers/SessionManager.ts:78
onStatusUpdate?StatusUpdateHandlerStatus update callbacklib/vowel/managers/SessionManager.ts:80
onOpen?() => voidConnection opened callbacklib/vowel/managers/SessionManager.ts:82
onClose?(reason) => voidConnection closed callbacklib/vowel/managers/SessionManager.ts:84
onError?(error) => voidError callbacklib/vowel/managers/SessionManager.ts:86
convexUrl?stringCustom Convex platform URL (base URL)lib/vowel/managers/SessionManager.ts:88
tokenEndpoint?stringCustom token endpoint URLlib/vowel/managers/SessionManager.ts:90
tokenProvider?(config) => Promise<{ tokenName: string; model: string; provider: "gemini" | "openai" | "vowel-prime"; expiresAt: string; systemInstructions?: string; }>Custom token provider functionlib/vowel/managers/SessionManager.ts:92
onUserSpeakingChange?(isSpeaking) => voidUser speaking state change callbacklib/vowel/managers/SessionManager.ts:100
onAIThinkingChange?(isThinking) => voidAI thinking state change callbacklib/vowel/managers/SessionManager.ts:102
onToolExecutingChange?(isExecuting) => voidTool execution state change callbacklib/vowel/managers/SessionManager.ts:104
onAISpeakingChange?(isSpeaking) => voidAI speaking state change callback (already handled by AudioManager)lib/vowel/managers/SessionManager.ts:106
typingSoundManager?TypingSoundManagerTyping sound manager instancelib/vowel/managers/SessionManager.ts:108
onTranscriptEvent?(event) => voidTranscript event callback (for caption system)lib/vowel/managers/SessionManager.ts:110