Update LiveKitRoom connection logic

[1egoman]

Initially, I made #1197, which aimed to create a react hook for managing a room connection. However, after some comments were left and I started digging in to the codebase a bit deeper, I noticed that there was already a mechanism in place to support this - LiveKitRoom / useLiveKitRoom. Embarrassingly, this is also called out right in the README... 🤦

So, ditch the old attempt and instead update this pre-existing abstraction to use the connection behavior from the previous change. In addition, it looks like there isn't a means to support the microphone preconnect audio buffer logic with the existing implementation, so add a mechanism to do that.

I ported agent-starter-react over to use this mechanism here: livekit-examples/agent-starter-react#225

[changeset-bot]

⚠️ No Changeset found

Latest commit: 01a8fcd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[github-actions]

size-limit report 📦

Path	Size
LiveKitRoom only	6.06 KB (+1.11% 🔺)
LiveKitRoom with VideoConference	30.64 KB (+0.17% 🔺)
All exports	38.19 KB (+0.15% 🔺)

[1egoman]

This new prop / parameter allows a user to inject in a side effect to run in parallel with the room.connect(...) call - an example of its use in agent-starter-react:

// Within a react component:
const enableMicrophonePreConnectBuffer = useCallback(async (room: Room) => {
  room.localParticipant.setMicrophoneEnabled(true, undefined, {
    preConnectBuffer: appConfig.isPreConnectBufferEnabled,
  });
}, []);

// (later on in the component)
return (
  <LiveKitRoom
    token="..."
    serverUrl="..."
    connectionSideEffect={enableMicrophonePreConnectBuffer}
  >
    {/* rest of application here */}
  </LiveKitRoom>
);

Note that I could see enableMicrophonePreConnectBuffer being extracted into the eventual agents sdk that has been discussed.