Skip to content

Commit dea542b

Browse files
committed
docs: update docs for useIOSAudioManagement
1 parent c82f975 commit dea542b

2 files changed

Lines changed: 3 additions & 1 deletion

File tree

src/audio/AudioManager.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import { log } from '..';
1414
*
1515
* @param room
1616
* @param preferSpeakerOutput
17-
* @param onConfigureNativeAudio
17+
* @param onConfigureNativeAudio A custom method for determining options used.
1818
*/
1919
export function useIOSAudioManagement(
2020
room: Room,

src/audio/AudioSession.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,8 @@ export default class AudioSession {
248248
* Applies the provided audio configuration to the underlying AudioSession.
249249
*
250250
* Must be called prior to connecting to a Room for the configuration to apply correctly.
251+
*
252+
* See also useIOSAudioManagement for automatic configuration of iOS audio options.
251253
*/
252254
static configureAudio = async (config: AudioConfiguration) => {
253255
await LivekitReactNative.configureAudio(config);

0 commit comments

Comments
 (0)