useEnsureRoom
function useEnsureRoom(room?): unknown;Defined in: packages/react/src/hooks/room/useEnsureRoom.ts:29
Ensures that a room is provided, either via context or explicitly as a parameter. If no room is provided, an error is thrown.
Parameters
| Parameter | Type |
|---|---|
room? | unknown |
Returns
unknown
Example
// Basic — require a room from props or context.
const room = useEnsureRoom();
// Advanced — share an ensured room with playback helpers.
function RoomAudioGate({ room }: { room?: Room }) {
const ensuredRoom = useEnsureRoom(room);
const { canPlayAudio, startAudio } = useAudioPlayback(ensuredRoom);
return (
<VoiceRoom agent={agent}>
{!canPlayAudio && <button onClick={startAudio}>Start audio</button>}
<RoomAudioRenderer />
</VoiceRoom>
);
}