@studiokloek/capacitor-plugin-audiosession

This plugin works on iOS only.

This plugin is a port of and allows iOS applications to get notified about audio session interruptions and route changes (for example when a headset is connected). To query and override the audio device in use is also supported.

Install

``bash
yarn add @studiokloek/capacitor-plugin-audiosession
npx cap sync
`

For now this plugin works only in Capacitor 4.0+.

API

* currentOutputs()
* overrideOutput(...)
* addListener('routeChanged', ...)
* addListener('interruption', ...)
* Interfaces
* Type Aliases
* Enums

$3

`typescript
currentOutputs() => Promise
`

Returns: Promise<AudioSessionPorts[]>

--------------------

$3

`typescript
overrideOutput(type: OutputOverrideType) => Promise
`

| Param | Type |
| ---------- | ----------------------------------------------------------------- |
| type | OutputOverrideType |

Returns: Promise<OverrideResult>

--------------------

$3

`typescript
addListener(eventName: 'routeChanged', listenerFunc: RouteChangeListener) => Promise
`

| Param | Type |
| ------------------ | ------------------------------------------------------------------- |
| eventName | 'routeChanged' |
| listenerFunc | RouteChangeListener |

Returns: Promise<PluginListenerHandle>

--------------------

$3

`typescript
addListener(eventName: 'interruption', listenerFunc: InterruptionListener) => Promise
`

| Param | Type |
| ------------------ | --------------------------------------------------------------------- |
| eventName | 'interruption' |
| listenerFunc | InterruptionListener |

Returns: Promise<PluginListenerHandle>

--------------------

$3


#### PluginListenerHandle

| Prop | Type |
| ------------ | ----------------------------------------- |
| remove | () => Promise<void> |

$3


#### OverrideResult

{ success: boolean; message: string; }


#### OutputOverrideType

'default' | 'speaker'


#### RouteChangeListener

(reason: RouteChangeReasons): void


#### InterruptionListener

(type: InterruptionTypes): void

$3


#### AudioSessionPorts

| Members | Value |
| ----------------------- | ------------------------------- |
| AIR_PLAY | 'airplay' |
| BLUETOOTH_LE | 'bluetooth-le' |
| BLUETOOTH_HFP | 'bluetooth-hfp' |
| BLUETOOTH_A2DP | 'bluetooth-a2dp' |
| BUILT_IN_SPEAKER | 'builtin-speaker' |
| BUILT_IN_RECEIVER | 'builtin-receiver' |
| HDMI | 'hdmi' |
| HEADPHONES | 'headphones' |
| LINE_OUT | 'line-out' |


#### RouteChangeReasons

| Members | Value |
| ------------------------------------ | --------------------------------------------- |
| NEW_DEVICE_AVAILABLE | 'new-device-available' |
| OLD_DEVICE_UNAVAILABLE | 'old-device-unavailable' |
| CATEGORY_CHANGE | 'category-change' |
| OVERRIDE | 'override' |
| WAKE_FROM_SLEEP | 'wake-from-sleep' |
| NO_SUITABLE_ROUTE_FOR_CATEGORY | 'no-suitable-route-for-category' |
| ROUTE_CONFIGURATION_CHANGE | 'route-config-change' |
| UNKNOWN | 'unknown' |


#### InterruptionTypes

| Members | Value |
| ----------- | -------------------- |
| BEGAN | 'began' |
| ENDED` | 'ended' |

License

MIT

Author

Martijn Swart

Based on work from: Saúl Ibarra Corretgé