@livekit/react-native 2.5.1 → 2.6.1

package/src/events/EventEmitter.ts

@@ -0,0 +1,51 @@
+import { NativeEventEmitter, type EmitterSubscription } from 'react-native';
+// @ts-ignore
+import EventEmitter from 'react-native/Libraries/vendor/emitter/EventEmitter';
+import LiveKitModule from '../LKNativeModule';
+
+// This emitter is going to be used to listen to all the native events (once) and then
+// re-emit them on a JS-only emitter.
+const nativeEmitter = new NativeEventEmitter(LiveKitModule);
+
+const NATIVE_EVENTS = ['LK_VOLUME_PROCESSED', 'LK_MULTIBAND_PROCESSED'];
+
+const eventEmitter = new EventEmitter();
+
+export function setupNativeEvents() {
+  for (const eventName of NATIVE_EVENTS) {
+    nativeEmitter.addListener(eventName, (...args) => {
+      eventEmitter.emit(eventName, ...args);
+    });
+  }
+}
+
+type EventHandler = (event: unknown) => void;
+type Listener = unknown;
+
+const _subscriptions: Map<Listener, EmitterSubscription[]> = new Map();
+
+export function addListener(
+  listener: Listener,
+  eventName: string,
+  eventHandler: EventHandler
+): void {
+  if (!NATIVE_EVENTS.includes(eventName)) {
+    throw new Error(`Invalid event: ${eventName}`);
+  }
+
+  if (!_subscriptions.has(listener)) {
+    _subscriptions.set(listener, []);
+  }
+
+  _subscriptions
+    .get(listener)
+    ?.push(eventEmitter.addListener(eventName, eventHandler));
+}
+
+export function removeListener(listener: Listener): void {
+  _subscriptions.get(listener)?.forEach((sub) => {
+    sub.remove();
+  });
+
+  _subscriptions.delete(listener);
+}

package/src/hooks/useMultibandTrackVolume.ts

@@ -0,0 +1,97 @@
+import { type TrackReferenceOrPlaceholder } from '@livekit/components-react';
+import {
+  Track,
+  type LocalAudioTrack,
+  type RemoteAudioTrack,
+} from 'livekit-client';
+import { useEffect, useMemo, useState } from 'react';
+import { addListener, removeListener } from '../events/EventEmitter';
+import LiveKitModule from '../LKNativeModule';
+
+/**
+ * Interface for configuring options for the useMultibandTrackVolume hook.
+ * @alpha
+ */
+export interface MultiBandTrackVolumeOptions {
+  /**
+   * the number of bands to split the audio into
+   */
+  bands?: number;
+  /**
+   * cut off frequency on the lower end
+   */
+  minFrequency?: number;
+  /**
+   * cut off frequency on the higher end
+   */
+  maxFrequency?: number;
+  /**
+   * update should run every x ms
+   */
+  updateInterval?: number;
+}
+
+const multibandDefaults = {
+  bands: 5,
+  minFrequency: 1000,
+  maxFrequency: 8000,
+  updateInterval: 40,
+} as const satisfies MultiBandTrackVolumeOptions;
+
+/**
+ * A hook for tracking the volume of an audio track across multiple frequency bands.
+ *
+ * @param trackOrTrackReference
+ * @returns A number array containing the volume for each frequency band.
+ */
+export function useMultibandTrackVolume(
+  trackOrTrackReference?:
+    | LocalAudioTrack
+    | RemoteAudioTrack
+    | TrackReferenceOrPlaceholder,
+  options: MultiBandTrackVolumeOptions = {}
+) {
+  const track =
+    trackOrTrackReference instanceof Track
+      ? trackOrTrackReference
+      : <LocalAudioTrack | RemoteAudioTrack | undefined>(
+          trackOrTrackReference?.publication?.track
+        );
+  const opts = useMemo(() => {
+    return { ...multibandDefaults, ...options };
+  }, [options]);
+  const mediaStreamTrack = track?.mediaStreamTrack;
+
+  let [magnitudes, setMagnitudes] = useState<number[]>([]);
+  useEffect(() => {
+    let listener = Object();
+    let reactTag: string | null = null;
+    if (mediaStreamTrack) {
+      reactTag = LiveKitModule.createMultibandVolumeProcessor(
+        opts,
+        mediaStreamTrack._peerConnectionId ?? -1,
+        mediaStreamTrack.id
+      );
+      addListener(listener, 'LK_MULTIBAND_PROCESSED', (event: any) => {
+        if (event.magnitudes && reactTag && event.id === reactTag) {
+          console.log('event received: ', event.magnitudes[0]);
+          setMagnitudes(event.magnitudes);
+        }
+      });
+    }
+    return () => {
+      if (mediaStreamTrack) {
+        removeListener(listener);
+        if (reactTag) {
+          LiveKitModule.deleteMultibandVolumeProcessor(
+            reactTag,
+            mediaStreamTrack._peerConnectionId ?? -1,
+            mediaStreamTrack.id
+          );
+        }
+      }
+    };
+  }, [mediaStreamTrack, opts]);
+
+  return magnitudes;
+}

package/src/hooks/useTrackVolume.ts

@@ -0,0 +1,62 @@
+import { type TrackReferenceOrPlaceholder } from '@livekit/components-react';
+import {
+  Track,
+  type LocalAudioTrack,
+  type RemoteAudioTrack,
+} from 'livekit-client';
+import { useEffect, useState } from 'react';
+import { addListener, removeListener } from '../events/EventEmitter';
+import LiveKitModule from '../LKNativeModule';
+
+/**
+ * A hook for tracking the volume of an audio track.
+ *
+ * @param trackOrTrackReference
+ * @returns A number between 0-1 representing the volume.
+ */
+export function useTrackVolume(
+  trackOrTrackReference?:
+    | LocalAudioTrack
+    | RemoteAudioTrack
+    | TrackReferenceOrPlaceholder
+) {
+  const track =
+    trackOrTrackReference instanceof Track
+      ? trackOrTrackReference
+      : <LocalAudioTrack | RemoteAudioTrack | undefined>(
+          trackOrTrackReference?.publication?.track
+        );
+
+  const mediaStreamTrack = track?.mediaStreamTrack;
+
+  let [volume, setVolume] = useState(0.0);
+  useEffect(() => {
+    let listener = Object();
+    let reactTag: string | null = null;
+    if (mediaStreamTrack) {
+      reactTag = LiveKitModule.createVolumeProcessor(
+        mediaStreamTrack._peerConnectionId ?? -1,
+        mediaStreamTrack.id
+      );
+      addListener(listener, 'LK_VOLUME_PROCESSED', (event: any) => {
+        if (event.volume && reactTag && event.id === reactTag) {
+          setVolume(event.volume);
+        }
+      });
+    }
+    return () => {
+      if (mediaStreamTrack) {
+        removeListener(listener);
+        if (reactTag) {
+          LiveKitModule.deleteVolumeProcessor(
+            reactTag,
+            mediaStreamTrack._peerConnectionId ?? -1,
+            mediaStreamTrack.id
+          );
+        }
+      }
+    };
+  }, [mediaStreamTrack]);
+
+  return volume;
+}

package/src/hooks.ts

@@ -42,4 +42,6 @@ export type {
 
 export type { ReceivedDataMessage } from '@livekit/components-core';
 export * from './hooks/useE2EEManager';
+export * from './hooks/useTrackVolume';
+export * from './hooks/useMultibandTrackVolume';
 export type { UseRNE2EEManagerOptions } from './hooks/useE2EEManager';

package/src/index.tsx

@@ -17,6 +17,7 @@ import { type LiveKitReactNativeInfo } from 'livekit-client';
 import type { LogLevel, SetLogLevelOptions } from './logger';
 import RNE2EEManager from './e2ee/RNE2EEManager';
 import RNKeyProvider, { type RNKeyProviderOptions } from './e2ee/RNKeyProvider';
+import { setupNativeEvents } from './events/EventEmitter';
 
 /**
  * Registers the required globals needed for LiveKit to work.
@@ -33,6 +34,7 @@ export function registerGlobals() {
   shimArrayAt();
   shimAsyncIterator();
   shimIterator();
+  setupNativeEvents();
 }
 
 /**
@@ -99,6 +101,7 @@ function shimIterator() {
   shim();
 }
 export * from './hooks';
+export * from './components/BarVisualizer';
 export * from './components/LiveKitRoom';
 export * from './components/VideoTrack';
 export * from './components/VideoView'; // deprecated

package/ios/AudioUtils.h

@@ -1,9 +0,0 @@
-#if TARGET_OS_IPHONE
-#import <AVFoundation/AVFoundation.h>
-
-@interface AudioUtils : NSObject
-+ (AVAudioSessionMode)audioSessionModeFromString:(NSString*)mode;
-+ (AVAudioSessionCategory)audioSessionCategoryFromString:(NSString *)category;
-@end
-
-#endif

package/ios/AudioUtils.m

@@ -1,48 +0,0 @@
-#if TARGET_OS_IPHONE
-#import "AudioUtils.h"
-#import <AVFoundation/AVFoundation.h>
-
-@implementation AudioUtils
-
-+ (AVAudioSessionMode)audioSessionModeFromString:(NSString*)mode {
-  if([@"default_" isEqualToString:mode]) {
-    return AVAudioSessionModeDefault;
-  } else if([@"voicePrompt" isEqualToString:mode]) {
-    return AVAudioSessionModeVoicePrompt;
-  } else if([@"videoRecording" isEqualToString:mode]) {
-    return AVAudioSessionModeVideoRecording;
-  } else if([@"videoChat" isEqualToString:mode]) {
-    return AVAudioSessionModeVideoChat;
-  } else if([@"voiceChat" isEqualToString:mode]) {
-    return AVAudioSessionModeVoiceChat;
-  } else if([@"gameChat" isEqualToString:mode]) {
-    return AVAudioSessionModeGameChat;
-  } else if([@"measurement" isEqualToString:mode]) {
-    return AVAudioSessionModeMeasurement;
-  } else if([@"moviePlayback" isEqualToString:mode]) {
-    return AVAudioSessionModeMoviePlayback;
-  } else if([@"spokenAudio" isEqualToString:mode]) {
-    return AVAudioSessionModeSpokenAudio;
-  } 
-  return AVAudioSessionModeDefault;
-}
-
-+ (AVAudioSessionCategory)audioSessionCategoryFromString:(NSString *)category {
-  if([@"ambient" isEqualToString:category]) {
-    return AVAudioSessionCategoryAmbient;
-  } else if([@"soloAmbient" isEqualToString:category]) {
-    return AVAudioSessionCategorySoloAmbient;
-  } else if([@"playback" isEqualToString:category]) {
-    return AVAudioSessionCategoryPlayback;
-  } else if([@"record" isEqualToString:category]) {
-    return AVAudioSessionCategoryRecord;
-  } else if([@"playAndRecord" isEqualToString:category]) {
-    return AVAudioSessionCategoryPlayAndRecord;
-  } else if([@"multiRoute" isEqualToString:category]) {
-    return AVAudioSessionCategoryMultiRoute;
-  }
-  return AVAudioSessionCategoryAmbient;
-}
-
-@end
-#endif