useEnsureSession
function useEnsureSession(session?): UseSessionReturn;Defined in: packages/react/src/hooks/session/useEnsureSession.ts:38
Note. This feature is under active development and may change based on developer feedback and real-world usage. Ensures that a session is provided, either via context or explicitly as a parameter. If no session is provided, an
Parameters
| Parameter | Type |
|---|---|
session? | UseSessionReturn |
Returns
UseSessionReturn
Example
// Basic — require a session from props or context.
const session = useEnsureSession();
// Advanced — provide an ensured session to agent UI.
function SessionAgentPanel({ session }: { session?: UseSessionReturn }) {
const ensuredSession = useEnsureSession(session);
const agent = useAgent(ensuredSession);
return (
<SessionProvider session={ensuredSession}>
{agent ? <VoiceAssistantControlBar /> : <span>Waiting for session</span>}
<RoomAudioRenderer />
</SessionProvider>
);
}