@livekit/react-native 1.2.0 → 1.4.0

package/src/audio/AudioSession.ts

@@ -26,17 +26,15 @@ const LivekitReactNative = NativeModules.LivekitReactNative
  *   This is ignored when an output is manually selected with {@link AudioSession.selectAudioOutput}.
  *
  *   By default, the order is set to:
- *   1. `"speaker"`
- *   2. `"earpiece"`
- *   3. `"headset"`
- *   4. `"bluetooth"`
+ *   1. `"bluetooth"
+ *   2. `"headset"``
+ *   3. `"speaker"`
+ *   4. `"earpiece"`
  *
- * * audioMode - The audio mode to use for the audio session. Defaults to 'normal'.
+ * * audioTypeOptions - An {@link AndroidAudioTypeOptions} object which provides the
+ *   audio options to use on Android.
  *
- * * audioFocusMode - The focus mode to use for the audio session. Defaults to 'gain'.
- *
- *  See [AudioManager](https://developer.android.com/reference/android/media/AudioManager) for details
- *  on audio and focus modes.
+ *   See {@link AndroidAudioTypePresets} for pre-configured values.
  *
  * ----
  * iOS
@@ -48,23 +46,203 @@ const LivekitReactNative = NativeModules.LivekitReactNative
 export type AudioConfiguration = {
   android?: {
     preferredOutputList?: ('speaker' | 'earpiece' | 'headset' | 'bluetooth')[];
-    audioMode?:
-      | 'normal'
-      | 'callScreening'
-      | 'inCall'
-      | 'inCommunication'
-      | 'ringtone';
-    audioFocusMode?:
-      | 'gain'
-      | 'gainTransient'
-      | 'gainTransientExclusive'
-      | 'gainTransientMayDuck';
+    audioTypeOptions: AndroidAudioTypeOptions;
   };
   ios?: {
     defaultOutput?: 'speaker' | 'earpiece';
   };
 };
 
+export type AndroidAudioTypeOptions = {
+  /**
+   * Whether LiveKit should handle managing the audio focus or not.
+   *
+   * Defaults to true.
+   */
+  manageAudioFocus?: boolean;
+
+  /**
+   * Corresponds to {@link https://developer.android.com/reference/android/media/AudioManager#setMode(int)}
+   *
+   * Defaults to 'inCommunication'.
+   */
+  audioMode?:
+    | 'normal'
+    | 'callScreening'
+    | 'inCall'
+    | 'inCommunication'
+    | 'ringtone';
+
+  /**
+   * Corresponds to the duration hint when requesting audio focus.
+   *
+   * Defaults to 'gain'.
+   *
+   * See also {@link https://developer.android.com/reference/android/media/AudioManager#AUDIOFOCUS_GAIN}
+   */
+  audioFocusMode?:
+    | 'gain'
+    | 'gainTransient'
+    | 'gainTransientExclusive'
+    | 'gainTransientMayDuck';
+
+  /**
+   * Corresponds to Android's AudioAttributes usage type.
+   *
+   * Defaults to 'voiceCommunication'.
+   *
+   * See also {@link https://developer.android.com/reference/android/media/AudioAttributes}
+   */
+  audioAttributesUsageType?:
+    | 'alarm'
+    | 'assistanceAccessibility'
+    | 'assistanceNavigationGuidance'
+    | 'assistanceSonification'
+    | 'assistant'
+    | 'game'
+    | 'media'
+    | 'notification'
+    | 'notificationEvent'
+    | 'notificationRingtone'
+    | 'unknown'
+    | 'voiceCommunication'
+    | 'voiceCommunicationSignalling';
+
+  /**
+   * Corresponds to Android's AndroidAttributes content type.
+   *
+   * Defaults to 'speech'.
+   *
+   * See also {@link https://developer.android.com/reference/android/media/AudioAttributes}
+   */
+  audioAttributesContentType?:
+    | 'movie'
+    | 'music'
+    | 'sonification'
+    | 'speech'
+    | 'unknown';
+
+  /**
+   * Corresponds to the stream type when requesting audio focus. Used on pre-O devices.
+   *
+   * Defaults to 'voiceCall'
+   *
+   * See also {@link https://developer.android.com/reference/android/media/AudioManager#STREAM_VOICE_CALL}
+   */
+  audioStreamType?:
+    | 'accessibility'
+    | 'alarm'
+    | 'dtmf'
+    | 'music'
+    | 'notification'
+    | 'ring'
+    | 'system'
+    | 'voiceCall';
+
+  /**
+   * On certain Android devices, audio routing does not function properly and
+   * bluetooth microphones will not work unless audio mode is set to
+   * `inCommunication` or `inCall`. Audio routing is turned off those cases.
+   *
+   * If this set to true, will attempt to do audio routing regardless of audio mode.
+   *
+   * Defaults to false.
+   */
+  forceHandleAudioRouting?: boolean;
+};
+
+export const AndroidAudioTypePresets: {
+  /**
+   * A pre-configured AndroidAudioConfiguration for voice communication.
+   */
+  communication: AndroidAudioTypeOptions;
+  /**
+   * A pre-configured AndroidAudioConfiguration for media playback.
+   */
+  media: AndroidAudioTypeOptions;
+} = {
+  communication: {
+    manageAudioFocus: true,
+    audioMode: 'inCommunication',
+    audioFocusMode: 'gain',
+    audioStreamType: 'voiceCall',
+    audioAttributesUsageType: 'voiceCommunication',
+    audioAttributesContentType: 'speech',
+  },
+  media: {
+    manageAudioFocus: true,
+    audioMode: 'normal',
+    audioFocusMode: 'gain',
+    audioStreamType: 'music',
+    audioAttributesUsageType: 'media',
+    audioAttributesContentType: 'unknown',
+  },
+} as const;
+
+export type AppleAudioMode =
+  | 'default'
+  | 'gameChat'
+  | 'measurement'
+  | 'moviePlayback'
+  | 'spokenAudio'
+  | 'videoChat'
+  | 'videoRecording'
+  | 'voiceChat'
+  | 'voicePrompt';
+
+export type AppleAudioCategory =
+  | 'soloAmbient'
+  | 'playback'
+  | 'record'
+  | 'playAndRecord'
+  | 'multiRoute';
+
+export type AppleAudioCategoryOption =
+  | 'mixWithOthers'
+  | 'duckOthers'
+  | 'interruptSpokenAudioAndMixWithOthers'
+  | 'allowBluetooth'
+  | 'allowBluetoothA2DP'
+  | 'allowAirPlay'
+  | 'defaultToSpeaker';
+
+export type AppleAudioConfiguration = {
+  audioCategory?: AppleAudioCategory;
+  audioCategoryOptions?: AppleAudioCategoryOption[];
+  audioMode?: AppleAudioMode;
+};
+
+export type AudioTrackState =
+  | 'none'
+  | 'remoteOnly'
+  | 'localOnly'
+  | 'localAndRemote';
+
+export function getDefaultAppleAudioConfigurationForMode(
+  mode: AudioTrackState,
+  preferSpeakerOutput: boolean = true
+): AppleAudioConfiguration {
+  if (mode === 'remoteOnly') {
+    return {
+      audioCategory: 'playback',
+      audioCategoryOptions: ['mixWithOthers'],
+      audioMode: 'spokenAudio',
+    };
+  } else if (mode === 'localAndRemote' || mode === 'localOnly') {
+    return {
+      audioCategory: 'playAndRecord',
+      audioCategoryOptions: ['allowBluetooth', 'mixWithOthers'],
+      audioMode: preferSpeakerOutput ? 'videoChat' : 'voiceChat',
+    };
+  }
+
+  return {
+    audioCategory: 'soloAmbient',
+    audioCategoryOptions: [],
+    audioMode: 'default',
+  };
+}
+
 export default class AudioSession {
   /**
    * Applies the provided audio configuration to the underlying AudioSession.
@@ -100,9 +278,6 @@ export default class AudioSession {
    * * "headset"
    * * "bluetooth"
    *
-   * Note: For applications targeting SDK versions over 30, the runtime BLUETOOTH_CONNECT
-   * permission must be requested to send audio to bluetooth headsets.
-   *
    * ----
    *
    * For iOS, due to OS limitations, the only available types are:
@@ -147,4 +322,12 @@ export default class AudioSession {
       await LivekitReactNative.showAudioRoutePicker();
     }
   };
+
+  static setAppleAudioConfiguration = async (
+    config: AppleAudioConfiguration
+  ) => {
+    if (Platform.OS === 'ios') {
+      await LivekitReactNative.setAppleAudioConfiguration(config);
+    }
+  };
 }

package/src/index.tsx

@@ -1,9 +1,20 @@
 import { registerGlobals as webrtcRegisterGlobals } from '@livekit/react-native-webrtc';
 import { setupURLPolyfill } from 'react-native-url-polyfill';
-import AudioSession from './audio/AudioSession';
+import 'fastestsmallesttextencoderdecoder';
+import AudioSession, {
+  AndroidAudioTypePresets,
+  AndroidAudioTypeOptions,
+  AppleAudioCategory,
+  AppleAudioCategoryOption,
+  AppleAudioConfiguration,
+  AppleAudioMode,
+  AudioTrackState,
+  getDefaultAppleAudioConfigurationForMode,
+} from './audio/AudioSession';
 import type { AudioConfiguration } from './audio/AudioSession';
 import { PixelRatio, Platform } from 'react-native';
 import type { LiveKitReactNativeInfo } from 'livekit-client';
+import type { LogLevel, SetLogLevelOptions } from './logger';
 
 /**
  * Registers the required globals needed for LiveKit to work.
@@ -17,6 +28,8 @@ export function registerGlobals() {
   fixWebrtcAdapter();
   shimPromiseAllSettled();
   shimArrayAt();
+  shimAsyncIterator();
+  shimIterator();
 }
 function livekitRegisterGlobals() {
   let lkGlobal: LiveKitReactNativeInfo = {
@@ -52,7 +65,33 @@ function shimArrayAt() {
   }
 }
 
+function shimAsyncIterator() {
+  var shim = require('well-known-symbols/Symbol.asyncIterator/shim');
+  shim();
+}
+
+function shimIterator() {
+  var shim = require('well-known-symbols/Symbol.iterator/shim');
+  shim();
+}
+
 export * from './components/VideoView';
 export * from './useParticipant';
 export * from './useRoom';
-export { AudioSession, AudioConfiguration };
+export * from './logger';
+export * from './audio/AudioManager';
+
+export {
+  AudioSession,
+  AudioConfiguration,
+  AndroidAudioTypeOptions,
+  AndroidAudioTypePresets,
+  AppleAudioCategory,
+  AppleAudioCategoryOption,
+  AppleAudioConfiguration,
+  AppleAudioMode,
+  AudioTrackState,
+  getDefaultAppleAudioConfigurationForMode,
+  LogLevel,
+  SetLogLevelOptions,
+};

package/src/logger.ts

@@ -0,0 +1,23 @@
+import { setLogLevel as setClientSdkLogLevel } from 'livekit-client';
+import loglevel from 'loglevel';
+
+export const log = loglevel.getLogger('lk-react-native');
+log.setDefaultLevel('WARN');
+
+export type LogLevel = Parameters<typeof setClientSdkLogLevel>[0];
+export type SetLogLevelOptions = {
+  liveKitClientLogLevel?: LogLevel;
+};
+
+/**
+ * Set the log level for both the `@livekit/react-native` package and the `@livekit-client` package.
+ * To set the `@livekit-client` log independently, use the `liveKitClientLogLevel` prop on the `options` object.
+ * @public
+ */
+export function setLogLevel(
+  level: LogLevel,
+  options: SetLogLevelOptions = {}
+): void {
+  log.setLevel(level);
+  setClientSdkLogLevel(options.liveKitClientLogLevel ?? level);
+}