Skip to content

[Blocked] refactor: updated AVAudioSessionCategoryOptions #558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+12 −6
Open

[Blocked] refactor: updated AVAudioSessionCategoryOptions #558

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dde9430
refactor: updated AVAudioSessionCategoryOptions
vltkv Jul 11, 2025
991d8a6
Merge branch 'main' into refactor/update-audio-session-category
vltkv Jul 23, 2025
30e1ad4
style: fix formatting
vltkv Jul 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apps/common-app/src/examples/Record/Record.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ const Record: FC = () => {
AudioManager.setAudioSessionOptions({
iosCategory: 'playAndRecord',
iosMode: 'spokenAudio',
iosOptions: ['allowBluetooth', 'defaultToSpeaker'],
iosOptions: ['allowBluetoothHFP', 'defaultToSpeaker'],
});

recorderRef.current = new AudioRecorder({
Expand Down
171 changes: 86 additions & 85 deletions packages/audiodocs/docs/system/audio-manager.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,22 @@ import { AudioManager } from 'react-native-audio-api';
import { useEffect } from 'react';

function App() {
// set AVAudioSession example options (iOS only)
AudioManager.setAudioSessionOptions({
iosCategory: 'playback',
iosMode: 'default',
iosOptions: ['allowBluetooth', 'allowAirPlay'],
})

// set info for track to be visible while device is locked
AudioManager.setLockScreenInfo({
title: 'Audio file',
artist: 'Software Mansion',
album: 'Audio API',
duration: 10,
});
// set AVAudioSession example options (iOS only)
AudioManager.setAudioSessionOptions({
iosCategory: 'playback',
iosMode: 'default',
iosOptions: ['allowBluetoothHFP', 'allowAirPlay'],
});

// set info for track to be visible while device is locked
AudioManager.setLockScreenInfo({
title: 'Audio file',
artist: 'Software Mansion',
album: 'Audio API',
duration: 10,
});

useEffect(() => {

// enabling emission of events
AudioManager.enableRemoteCommand('remotePlay', true);
AudioManager.enableRemoteCommand('remotePause', true);
Expand Down Expand Up @@ -77,9 +76,9 @@ function App() {

### `setLockScreenInfo`

| Parameters | Type | Description |
| :---: | :---: | :-----: |
| `info` | [`LockScreenInfo`](/system/audio-manager#lockscreeninfo) | Information to be displayed on the lock screen |
| Parameters | Type | Description |
| :--------: | :------------------------------------------------------: | :--------------------------------------------: |
| `info` | [`LockScreenInfo`](/system/audio-manager#lockscreeninfo) | Information to be displayed on the lock screen |

#### Returns `undefined`

Expand All @@ -91,17 +90,17 @@ Resets all of the lock screen data.

### `setAudioSessionOptions` <OnlyiOS />

| Parameters | Type | Description |
| :---: | :---: | :---- |
| options | [`SessionOptions`](/system/audio-manager#sessionoptions) | Options to be set for AVAudioSession |
| Parameters | Type | Description |
| :--------: | :------------------------------------------------------: | :----------------------------------- |
| options | [`SessionOptions`](/system/audio-manager#sessionoptions) | Options to be set for AVAudioSession |

#### Returns `undefined`

### `setAudioSessionActivity` <OnlyiOS />

| Parameters | Type | Description |
| :---: | :---: | :---- |
| enabled | `boolean` | It is used to set/unset AVAudioSession activity |
| Parameters | Type | Description |
| :--------: | :-------: | :---------------------------------------------- |
| enabled | `boolean` | It is used to set/unset AVAudioSession activity |

#### Returns promise of `boolean` type, which is resolved to `true` if invokation ended with success, `false` otherwise.

Expand All @@ -111,28 +110,28 @@ Resets all of the lock screen data.

### `observeAudioInterruptions`

| Parameters | Type | Description |
| :---: | :---: | :---- |
| `enabled` | `boolean` | It is used to enable/disable observing audio interruptions |
| Parameters | Type | Description |
| :--------: | :-------: | :--------------------------------------------------------- |
| `enabled` | `boolean` | It is used to enable/disable observing audio interruptions |

#### Returns `undefined`

### `observeVolumeChanges`

| Parameters | Type | Description |
| :---: | :---: | :---- |
| `enabled` | `boolean` | It is used to enable/disable observing volume changes |
| Parameters | Type | Description |
| :--------: | :-------: | :---------------------------------------------------- |
| `enabled` | `boolean` | It is used to enable/disable observing volume changes |

#### Returns `undefined`

### `enableRemoteCommand`

Enables emition of some system events.

| Parameters | Type | Description |
| :---: | :---: | :---- |
| `name` | [`RemoteCommandEventName`](/system/audio-manager#systemeventname--remotecommandeventname) | Name of an event |
| `enabled` | `boolean` | Indicates the start or the end of event emission |
| Parameters | Type | Description |
| :--------: | :---------------------------------------------------------------------------------------: | :----------------------------------------------- |
| `name` | [`RemoteCommandEventName`](/system/audio-manager#systemeventname--remotecommandeventname) | Name of an event |
| `enabled` | `boolean` | Indicates the start or the end of event emission |

#### Returns `undefined`

Expand All @@ -143,14 +142,13 @@ with proper parameters.

:::


### `addSystemEventListener`

Adds callback to be invoked upon hearing an event.

| Parameters | Type | Description |
| :---: | :---: | :---- |
| `name` | [`SystemEventName`](/system/audio-manager#systemeventname--remotecommandeventname) | Name of an event listener |
| Parameters | Type | Description |
| :--------: | :------------------------------------------------------------------------------------: | :-------------------------------------------------- |
| `name` | [`SystemEventName`](/system/audio-manager#systemeventname--remotecommandeventname) | Name of an event listener |
| `callback` | [`SystemEventCallback`](/system/audio-manager#systemeventname--remotecommandeventname) | Callback that will be invoked upon hearing an event |

#### Returns [`AudioEventSubscription`](/system/audio-manager#audioeventsubscription) if `enabled` is set to true, `undefined` otherwise
Expand Down Expand Up @@ -189,17 +187,18 @@ interface BaseLockScreenInfo {
type MediaState = 'state_playing' | 'state_paused';

interface LockScreenInfo extends BaseLockScreenInfo {
title?: string; //title of the track
artwork?: string; //uri to the artwork
artist?: string; //name of the artist
album?: string; //name of the album
duration?: number; //duration in seconds
description?: string; // android only, description of the track
state?: MediaState;
speed?: number; //playback rate
elapsedTime?: number; //elapsed time of an audio in seconds
title?: string; //title of the track
artwork?: string; //uri to the artwork
artist?: string; //name of the artist
album?: string; //name of the album
duration?: number; //duration in seconds
description?: string; // android only, description of the track
state?: MediaState;
speed?: number; //playback rate
elapsedTime?: number; //elapsed time of an audio in seconds
}
```

````
</details>

### `SessionOptions`
Expand Down Expand Up @@ -230,7 +229,8 @@ type IOSOption =
| 'duckOthers'
| 'allowAirPlay'
| 'mixWithOthers'
| 'allowBluetooth'
| 'allowBluetoothHFP'
| 'bluetoothHighQualityRecording'
| 'defaultToSpeaker'
| 'allowBluetoothA2DP'
| 'overrideMutedMicrophoneInterruption'
Expand All @@ -241,9 +241,9 @@ interface SessionOptions {
iosOptions?: IOSOption[];
iosCategory?: IOSCategory;
}
```
</details>
````

</details>

### `SystemEventName` | `RemoteCommandEventName`

Expand All @@ -253,55 +253,56 @@ interface SessionOptions {
interface EventEmptyType {}

interface EventTypeWithValue {
value: number;
value: number;
}

interface OnInterruptionEventType {
type: 'ended' | 'began'; //if interruption event has started or ended
shouldResume: boolean; //if we should resume playing after interruption
type: 'ended' | 'began'; //if interruption event has started or ended
shouldResume: boolean; //if we should resume playing after interruption
}

interface OnRouteChangeEventType {
reason:
| 'Unknown'
| 'Override'
| 'CategoryChange'
| 'WakeFromSleep'
| 'NewDeviceAvailable'
| 'OldDeviceUnavailable'
| 'ConfigurationChange'
| 'NoSuitableRouteForCategory';
reason:
| 'Unknown'
| 'Override'
| 'CategoryChange'
| 'WakeFromSleep'
| 'NewDeviceAvailable'
| 'OldDeviceUnavailable'
| 'ConfigurationChange'
| 'NoSuitableRouteForCategory';
}

// visit https://developer.apple.com/documentation/mediaplayer/mpremotecommandcenter?language=objc
// for further info
interface RemoteCommandEvents {
remotePlay: EventEmptyType;
remotePause: EventEmptyType;
remoteStop: EventEmptyType;
remoteTogglePlayPause: EventEmptyType; // iOS only
remoteChangePlaybackRate: EventTypeWithValue;
remoteNextTrack: EventEmptyType;
remotePreviousTrack: EventEmptyType;
remoteSkipForward: EventTypeWithValue;
remoteSkipBackward: EventTypeWithValue; // iOS only
remoteSeekForward: EventEmptyType; // iOS only
remoteSeekBackward: EventEmptyType;
remoteChangePlaybackPosition: EventTypeWithValue;
remotePlay: EventEmptyType;
remotePause: EventEmptyType;
remoteStop: EventEmptyType;
remoteTogglePlayPause: EventEmptyType; // iOS only
remoteChangePlaybackRate: EventTypeWithValue;
remoteNextTrack: EventEmptyType;
remotePreviousTrack: EventEmptyType;
remoteSkipForward: EventTypeWithValue;
remoteSkipBackward: EventTypeWithValue; // iOS only
remoteSeekForward: EventEmptyType; // iOS only
remoteSeekBackward: EventEmptyType;
remoteChangePlaybackPosition: EventTypeWithValue;
}

type SystemEvents = RemoteCommandEvents & {
volumeChange: EventTypeWithValue; //triggered when volume level is changed
interruption: OnInterruptionEventType; //triggered when f.e. some app wants to play music when we are playing
routeChange: OnRouteChangeEventType; //change of output f.e. from speaker to headphones, events are always emitted!
volumeChange: EventTypeWithValue; //triggered when volume level is changed
interruption: OnInterruptionEventType; //triggered when f.e. some app wants to play music when we are playing
routeChange: OnRouteChangeEventType; //change of output f.e. from speaker to headphones, events are always emitted!
};

type RemoteCommandEventName = keyof RemoteCommandEvents;
type SystemEventName = keyof SystemEvents;
type SystemEventCallback<Name extends SystemEventName> = (
event: SystemEvents[Name]
event: SystemEvents[Name]
) => void;
```

````
</details>


Expand Down Expand Up @@ -333,16 +334,16 @@ class AudioEventSubscription {
);
}
}
```
````

</details>

### `PermissionStatus`

<details>
<summary>Type definitions</summary>
```typescript
type PermissionStatus = 'Undetermined' | 'Denied' | 'Granted';
```
<summary>Type definitions</summary>
```typescript type PermissionStatus = 'Undetermined' | 'Denied' | 'Granted';
```
</details>

### `AudioDevicesInfo`
Expand Down
8 changes: 6 additions & 2 deletions packages/react-native-audio-api/ios/audioapi/ios/system/AudioSessionManager.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,12 @@ - (void)setAudioSessionOptions:(NSString *)category
sessionOptions |= AVAudioSessionCategoryOptionMixWithOthers;
}

if ([option isEqualToString:@"allowBluetooth"]) {
sessionOptions |= AVAudioSessionCategoryOptionAllowBluetooth;
if ([option isEqualToString:@"allowBluetoothHFP"]) {
sessionOptions |= AVAudioSessionCategoryOptionAllowBluetoothHFP;
}

if ([option isEqualToString:@"bluetoothHighQualityRecording"]) {
sessionOptions |= AVAudioSessionCategoryOptionBluetoothHighQualityRecording;
}

if ([option isEqualToString:@"defaultToSpeaker"]) {
Expand Down
3 changes: 2 additions & 1 deletion packages/react-native-audio-api/src/system/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ export type IOSOption =
| 'duckOthers'
| 'allowAirPlay'
| 'mixWithOthers'
| 'allowBluetooth'
| 'allowBluetoothHFP'
| 'bluetoothHighQualityRecording'
| 'defaultToSpeaker'
| 'allowBluetoothA2DP'
| 'overrideMutedMicrophoneInterruption'
Expand Down