Skip to content

@capgo/capacitor-audio-session

Configure iOS audio routing for playback and VoIP.

Read active outputs and override speaker routes before other audio plugins fight over AVAudioSession.

PlatformSupportNotes
iOSYesAVAudioSession routing
AndroidNoNo audio routing; currentOutputs() and overrideOutput() are iOS-only
WebNoBrowser policies differ
  • currentOutputs - Get the current active audio output routes.
  • overrideOutput - Override the current audio output route.
MethodDescription
currentOutputsGet the current active audio output routes.
overrideOutputOverride the current audio output route.
addListenerListen for audio route changes (e.g. headset connected/disconnected).
addListenerListen for audio session interruptions (e.g. incoming call) and their end.
getPluginVersionGet the native Capacitor plugin version.

This reference is synced from src/definitions.ts in capacitor-audiosession.

Keep going from @capgo/capacitor-audio-session

Section titled “Keep going from @capgo/capacitor-audio-session”

If you are using @capgo/capacitor-audio-session to plan native media and interface behavior, connect it with Using @capgo/capacitor-audio-session for the native capability in Using @capgo/capacitor-audio-session, Using @capgo/capacitor-live-activities for the native capability in Using @capgo/capacitor-live-activities, @capgo/capacitor-live-activities for the implementation detail in @capgo/capacitor-live-activities, Using @capgo/capacitor-video-player for the native capability in Using @capgo/capacitor-video-player, and @capgo/capacitor-video-player for the implementation detail in @capgo/capacitor-video-player.