docs: update docs for useIOSAudioManagement

livekit · Dec 6, 2023 · dea542b · dea542b
1 parent c82f975
commit dea542b
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/src/audio/AudioManager.ts b/src/audio/AudioManager.ts
@@ -14,7 +14,7 @@ import { log } from '..';
  *
  * @param room
  * @param preferSpeakerOutput
- * @param onConfigureNativeAudio
+ * @param onConfigureNativeAudio A custom method for determining options used.
  */
 export function useIOSAudioManagement(
   room: Room,

diff --git a/src/audio/AudioSession.ts b/src/audio/AudioSession.ts
@@ -248,6 +248,8 @@ export default class AudioSession {
    * Applies the provided audio configuration to the underlying AudioSession.
    *
    * Must be called prior to connecting to a Room for the configuration to apply correctly.
+   *
+   * See also useIOSAudioManagement for automatic configuration of iOS audio options.
    */
   static configureAudio = async (config: AudioConfiguration) => {
     await LivekitReactNative.configureAudio(config);