useRoomContext
function useRoomContext(): unknown;Defined in: packages/react/src/hooks/room/useRoomContext.ts:51
Ensures that a room is provided via context. If no room is provided, an error is thrown.
Returns
unknown
Example
// Basic — access the room provided by context.
const room = useRoomContext();
// Advanced — wire a leave button to the current room.
function LeaveRoomButton() {
return (
<VoiceRoom agent={agent}>
<ConnectedLeaveButton />
<RoomAudioRenderer />
</VoiceRoom>
);
}
function ConnectedLeaveButton() {
const room = useRoomContext();
const participants = useParticipants({ room });
return <button onClick={() => room.disconnect()}>Leave {participants.length} participants</button>;
}