fix: fix useIOSAudioManagement calculation for track counts (#128)

* fix: fix useIOSAudioManagement calculation for track counts

* docs: add useIOSAudioManagement to readme

Author: davidliu

README.md

@@ -159,12 +159,13 @@ Additional documentation for the LiveKit SDK can be found at https://docs.liveki
 
 ## Audio sessions
 
-As seen in the above example, we've introduced a new class `AudioSession` that helps
+As seen in the above example, we've introduced a class `AudioSession` that helps
 to manage the audio session on native platforms. This class wraps either [AudioManager](https://developer.android.com/reference/android/media/AudioManager) on Android, or [AVAudioSession](https://developer.apple.com/documentation/avfaudio/avaudiosession) on iOS.
 
 You can customize the configuration of the audio session with `configureAudio`.
 
-### Media playback
+### Android
+#### Media playback
 
 By default, the audio session is set up for bidirectional communication. In this mode, the audio framework exhibits the following behaviors:
 
@@ -174,8 +175,6 @@ By default, the audio session is set up for bidirectional communication. In this
 
 If you're leveraging LiveKit primarily for media playback, you have the option to reconfigure the audio session to better suit media playback. Here's how:
 
-Note: iOS audio session customization is in development, and will be documented here when released.
-
 ```js
 useEffect(() => {
   let connect = async () => {
@@ -197,7 +196,7 @@ useEffect(() => {
 }, [url, token, room]);
 ```
 
-### Customizing audio session
+#### Customizing audio session
 
 Instead of using our presets, you can further customize the audio session to suit your specific needs.
 
@@ -220,6 +219,12 @@ await AudioSession.configureAudio({
 await AudioSession.startAudioSession();
 ```
 
+### iOS
+
+For iOS, the most appropriate audio configuration may change over time when local/remote
+audio tracks publish and unpublish from the room. To adapt to this, the [`useIOSAudioManagement`](https://htmlpreview.github.io/?https://raw.githubusercontent.com/livekit/client-sdk-react-native/main/docs/functions/useIOSAudioManagement.html)
+hook is advised over just configuring the audio session once for the entire audio session.
+
 ## Screenshare
 
 Enabling screenshare requires extra installation steps:

src/audio/AudioManager.ts

@@ -1,6 +1,6 @@
 import { useState, useEffect, useMemo } from 'react';
 import { Platform } from 'react-native';
-import { RoomEvent, type Room } from 'livekit-client';
+import { RoomEvent, Room } from 'livekit-client';
 import AudioSession, {
   getDefaultAppleAudioConfigurationForMode,
   type AppleAudioConfiguration,
@@ -31,14 +31,25 @@ export function useIOSAudioManagement(
     [localTrackCount, remoteTrackCount]
   );
 
+  useEffect(() => {
+    let recalculateTrackCounts = () => {
+      setLocalTrackCount(getLocalAudioTrackCount(room));
+      setRemoteTrackCount(getRemoteAudioTrackCount(room));
+    };
+
+    recalculateTrackCounts();
+
+    room.on(RoomEvent.Connected, recalculateTrackCounts);
+
+    return () => {
+      room.off(RoomEvent.Connected, recalculateTrackCounts);
+    };
+  }, [room]);
   useEffect(() => {
     if (Platform.OS !== 'ios') {
       return () => {};
     }
 
-    setLocalTrackCount(getLocalAudioTrackCount(room));
-    setRemoteTrackCount(getRemoteAudioTrackCount(room));
-
     let onLocalPublished = () => {
       setLocalTrackCount(localTrackCount + 1);
     };
@@ -85,7 +96,6 @@ export function useIOSAudioManagement(
     let configFunc =
       onConfigureNativeAudio ?? getDefaultAppleAudioConfigurationForMode;
     let audioConfig = configFunc(trackState, preferSpeakerOutput);
-
     AudioSession.setAppleAudioConfiguration(audioConfig);
   }, [trackState, onConfigureNativeAudio, preferSpeakerOutput]);
 }
@@ -106,13 +116,13 @@ function computeAudioTrackState(
 }
 
 function getLocalAudioTrackCount(room: Room): number {
-  return room.localParticipant.audioTracks.entries.length;
+  return room.localParticipant.audioTracks.size;
 }
 
 function getRemoteAudioTrackCount(room: Room): number {
   var audioTracks = 0;
   room.participants.forEach((participant) => {
-    audioTracks += participant.audioTracks.entries.length;
+    audioTracks += participant.audioTracks.size;
   });
 
   return audioTracks;

yarn.lock

@@ -7507,9 +7507,9 @@ lines-and-columns@^1.1.6:
   integrity sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==
 
 livekit-client@^1.15.0:
-  version "1.15.0"
-  resolved "https://registry.yarnpkg.com/livekit-client/-/livekit-client-1.15.0.tgz#ab3ea8687eaf920ecace72537b6307b676f5819f"
-  integrity sha512-uyp1sIFeOdezYBn9J0FnrMuG8uPgR4fwWPENodNisJC999xJwTSV3xVLX76AAnfky3IJoJehU4gY2UqoyXjm2w==
+  version "1.15.10"
+  resolved "https://registry.yarnpkg.com/livekit-client/-/livekit-client-1.15.10.tgz#8772927a55ee9ee57616b90d1d8bcbc9152e9ce7"
+  integrity sha512-fNiXakeJyoaInt8Yo2i7kzsEG5YtlvqVqgXX1OPv7U7Y6D5TVwJc7dR1sIPpMxsAGMEIwbvsIweRXlObpp2mxA==
   dependencies:
     "@bufbuild/protobuf" "^1.3.0"
     events "^3.3.0"