Deprecated: AudioSessionIos is deprecated. To use whisper.rn for realtime transcription, use the new RealtimeTranscriber instead.
AudioSessionIos provides utilities to manage iOS audio session settings for recording and playback. It allows you to configure audio session categories, modes, and options to control how your app interacts with the system’s audio environment.
Platform: iOS only
Import
import { AudioSessionIos } from 'whisper.rn'
Methods
getCurrentCategory()
Get the current audio session category and options.
const { category, options } = await AudioSessionIos.getCurrentCategory()
Returns
category
AudioSessionCategoryIos
required
The current audio session category
options
AudioSessionCategoryOptionIos[]
required
Array of active category options
Example
const { category, options } = await AudioSessionIos.getCurrentCategory()
console.log('Current category:', category)
console.log('Options:', options)
getCurrentMode()
Get the current audio session mode.
const mode = await AudioSessionIos.getCurrentMode()
Returns
mode
AudioSessionModeIos
required
The current audio session mode
Example
const mode = await AudioSessionIos.getCurrentMode()
console.log('Current mode:', mode)
setCategory()
Set the audio session category with options.
await AudioSessionIos.setCategory(category, options)
Parameters
category
AudioSessionCategoryIos
required
The audio session category to set
options
AudioSessionCategoryOptionIos[]
required
Array of category options to apply
Example
await AudioSessionIos.setCategory(
AudioSessionIos.Category.PlayAndRecord,
[AudioSessionIos.CategoryOption.MixWithOthers]
)
setMode()
Set the audio session mode.
await AudioSessionIos.setMode(mode)
Parameters
mode
AudioSessionModeIos
required
The audio session mode to set
Example
await AudioSessionIos.setMode(AudioSessionIos.Mode.VoiceChat)
setActive()
Activate or deactivate the audio session.
await AudioSessionIos.setActive(active)
Parameters
Whether to activate (true) or deactivate (false) the audio session
Example
await AudioSessionIos.setActive(true) // Activate
await AudioSessionIos.setActive(false) // Deactivate
Enums
AudioSessionCategoryIos
Audio session categories define the audio behavior of your app.
Reference: AVAudioSessionCategory
enum AudioSessionCategoryIos {
Ambient = 'Ambient',
SoloAmbient = 'SoloAmbient',
Playback = 'Playback',
Record = 'Record',
PlayAndRecord = 'PlayAndRecord',
MultiRoute = 'MultiRoute',
}
Ambient - Audio mixes with other apps, silenced by the Ring/Silent switchSoloAmbient - Default category, silences other audio, silenced by Ring/Silent switchPlayback - For playing recorded music or other soundsRecord - For recording audioPlayAndRecord - For recording and playback simultaneously (e.g., VoIP)MultiRoute - For routing distinct audio streams to different outputs
Usage
AudioSessionIos.Category.PlayAndRecord
AudioSessionIos.Category.Record
AudioSessionCategoryOptionIos
Options that modify the behavior of audio session categories.
Reference: AVAudioSessionCategoryOptions
enum AudioSessionCategoryOptionIos {
MixWithOthers = 'MixWithOthers',
DuckOthers = 'DuckOthers',
InterruptSpokenAudioAndMixWithOthers = 'InterruptSpokenAudioAndMixWithOthers',
AllowBluetooth = 'AllowBluetooth',
AllowBluetoothA2DP = 'AllowBluetoothA2DP',
AllowAirPlay = 'AllowAirPlay',
DefaultToSpeaker = 'DefaultToSpeaker',
}
MixWithOthers - Mix your audio with audio from other appsDuckOthers - Reduce the volume of other audio sessionsInterruptSpokenAudioAndMixWithOthers - Interrupt spoken audio content from other appsAllowBluetooth - Allow Bluetooth hands-free devicesAllowBluetoothA2DP - Allow Bluetooth A2DP devicesAllowAirPlay - Allow audio routing to AirPlay devicesDefaultToSpeaker - Route audio to speaker instead of receiver
Usage
[
AudioSessionIos.CategoryOption.MixWithOthers,
AudioSessionIos.CategoryOption.DefaultToSpeaker
]
AudioSessionModeIos
Audio session modes optimize settings for specific use cases.
Reference: AVAudioSessionMode
enum AudioSessionModeIos {
Default = 'Default',
VoiceChat = 'VoiceChat',
VideoChat = 'VideoChat',
GameChat = 'GameChat',
VideoRecording = 'VideoRecording',
Measurement = 'Measurement',
MoviePlayback = 'MoviePlayback',
SpokenAudio = 'SpokenAudio',
}
Default - Default mode, no special processingVoiceChat - Optimized for two-way voice communicationVideoChat - Optimized for video chatGameChat - Optimized for in-game chatVideoRecording - Optimized for video recordingMeasurement - Minimizes system-supplied signal processingMoviePlayback - Optimized for movie playbackSpokenAudio - Optimized for spoken audio (podcasts, audiobooks)
Usage
AudioSessionIos.Mode.VoiceChat
AudioSessionIos.Mode.VideoRecording
Complete Example
Configure audio session for voice recording with background music:
import { AudioSessionIos } from 'whisper.rn'
// Save current state
const prevCategory = await AudioSessionIos.getCurrentCategory()
const prevMode = await AudioSessionIos.getCurrentMode()
// Configure for recording
await AudioSessionIos.setCategory(
AudioSessionIos.Category.PlayAndRecord,
[
AudioSessionIos.CategoryOption.MixWithOthers,
AudioSessionIos.CategoryOption.DefaultToSpeaker
]
)
await AudioSessionIos.setMode(AudioSessionIos.Mode.VoiceChat)
await AudioSessionIos.setActive(true)
// ... perform recording ...
// Restore previous state
await AudioSessionIos.setCategory(prevCategory.category, prevCategory.options)
await AudioSessionIos.setMode(prevMode)
await AudioSessionIos.setActive(false)
See Also