Skip to main content
Capgo logo
Back to plugins
@capgo/capacitor-audiosession
Tutorial
@capgo/capacitor-audiosession

Audio Session

Configure iOS audio session for background playback, mixing, and routing control

Downloads/month

0

GitHub Stars

7

Guide

Tutorial on Audio Session

Using @capgo/capacitor-audio-session

iOS-only plugin to query and control the audio session output and listen to route changes and interruptions.

Install

bun add @capgo/capacitor-audio-session
bunx cap sync

What This Plugin Exposes

  • currentOutputs - Get the current active audio output routes.
  • overrideOutput - Override the current audio output route.

Example Usage

currentOutputs

Get the current active audio output routes.

import { AudioSession } from '@capgo/capacitor-audio-session';

await AudioSession.currentOutputs();

overrideOutput

Override the current audio output route.

import { AudioSession } from '@capgo/capacitor-audio-session';

await AudioSession.overrideOutput({} as OutputOverrideType);

Full Reference

Keep going from Using @capgo/capacitor-audio-session

If you are using Using @capgo/capacitor-audio-session to plan native media and interface behavior, connect it with @capgo/capacitor-audio-session for the implementation detail in @capgo/capacitor-audio-session, Getting Started for the implementation detail in Getting Started, 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, and Using @capgo/capacitor-video-player for the native capability in Using @capgo/capacitor-video-player.