Skip to content

Commit 30e1ad4

Browse files
committed
style: fix formatting
1 parent 991d8a6 commit 30e1ad4

File tree

2 files changed

+85
-85
lines changed

2 files changed

+85
-85
lines changed

packages/audiodocs/docs/system/audio-manager.mdx

Lines changed: 84 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,23 @@ import { AudioManager } from 'react-native-audio-api';
1616
import { useEffect } from 'react';
1717

1818
function App() {
19-
// set AVAudioSession example options (iOS only)
20-
AudioManager.setAudioSessionOptions({
21-
iosCategory: 'playback',
22-
iosMode: 'default',
23-
iosOptions: ['allowBluetoothHFP', 'allowAirPlay'],
24-
});
25-
26-
// set info for track to be visible while device is locked
27-
AudioManager.setLockScreenInfo({
28-
title: 'Audio file',
29-
artist: 'Software Mansion',
30-
album: 'Audio API',
31-
duration: 10,
32-
});
19+
// set AVAudioSession example options (iOS only)
20+
AudioManager.setAudioSessionOptions({
21+
iosCategory: 'playback',
22+
iosMode: 'default',
23+
iosOptions: ['allowBluetoothHFP', 'allowAirPlay'],
24+
})
25+
26+
// set info for track to be visible while device is locked
27+
AudioManager.setLockScreenInfo({
28+
title: 'Audio file',
29+
artist: 'Software Mansion',
30+
album: 'Audio API',
31+
duration: 10,
32+
});
3333

3434
useEffect(() => {
35+
3536
// enabling emission of events
3637
AudioManager.enableRemoteCommand('remotePlay', true);
3738
AudioManager.enableRemoteCommand('remotePause', true);
@@ -76,9 +77,9 @@ function App() {
7677

7778
### `setLockScreenInfo`
7879

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

8384
#### Returns `undefined`
8485

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

9192
### `setAudioSessionOptions` <OnlyiOS />
9293

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

9798
#### Returns `undefined`
9899

99100
### `setAudioSessionActivity` <OnlyiOS />
100101

101-
| Parameters | Type | Description |
102-
| :--------: | :-------: | :---------------------------------------------- |
103-
| enabled | `boolean` | It is used to set/unset AVAudioSession activity |
102+
| Parameters | Type | Description |
103+
| :---: | :---: | :---- |
104+
| enabled | `boolean` | It is used to set/unset AVAudioSession activity |
104105

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

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

111112
### `observeAudioInterruptions`
112113

113-
| Parameters | Type | Description |
114-
| :--------: | :-------: | :--------------------------------------------------------- |
115-
| `enabled` | `boolean` | It is used to enable/disable observing audio interruptions |
114+
| Parameters | Type | Description |
115+
| :---: | :---: | :---- |
116+
| `enabled` | `boolean` | It is used to enable/disable observing audio interruptions |
116117

117118
#### Returns `undefined`
118119

119120
### `observeVolumeChanges`
120121

121-
| Parameters | Type | Description |
122-
| :--------: | :-------: | :---------------------------------------------------- |
123-
| `enabled` | `boolean` | It is used to enable/disable observing volume changes |
122+
| Parameters | Type | Description |
123+
| :---: | :---: | :---- |
124+
| `enabled` | `boolean` | It is used to enable/disable observing volume changes |
124125

125126
#### Returns `undefined`
126127

127128
### `enableRemoteCommand`
128129

129130
Enables emition of some system events.
130131

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

136137
#### Returns `undefined`
137138

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

143144
:::
144145

146+
145147
### `addSystemEventListener`
146148

147149
Adds callback to be invoked upon hearing an event.
148150

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

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

189191
interface LockScreenInfo extends BaseLockScreenInfo {
190-
title?: string; //title of the track
191-
artwork?: string; //uri to the artwork
192-
artist?: string; //name of the artist
193-
album?: string; //name of the album
194-
duration?: number; //duration in seconds
195-
description?: string; // android only, description of the track
196-
state?: MediaState;
197-
speed?: number; //playback rate
198-
elapsedTime?: number; //elapsed time of an audio in seconds
192+
title?: string; //title of the track
193+
artwork?: string; //uri to the artwork
194+
artist?: string; //name of the artist
195+
album?: string; //name of the album
196+
duration?: number; //duration in seconds
197+
description?: string; // android only, description of the track
198+
state?: MediaState;
199+
speed?: number; //playback rate
200+
elapsedTime?: number; //elapsed time of an audio in seconds
199201
}
200-
201-
````
202+
```
202203
</details>
203204

204205
### `SessionOptions`
@@ -241,10 +242,10 @@ interface SessionOptions {
241242
iosOptions?: IOSOption[];
242243
iosCategory?: IOSCategory;
243244
}
244-
````
245-
245+
```
246246
</details>
247247

248+
248249
### `SystemEventName` | `RemoteCommandEventName`
249250

250251
<details>
@@ -253,56 +254,55 @@ interface SessionOptions {
253254
interface EventEmptyType {}
254255

255256
interface EventTypeWithValue {
256-
value: number;
257+
value: number;
257258
}
258259

259260
interface OnInterruptionEventType {
260-
type: 'ended' | 'began'; //if interruption event has started or ended
261-
shouldResume: boolean; //if we should resume playing after interruption
261+
type: 'ended' | 'began'; //if interruption event has started or ended
262+
shouldResume: boolean; //if we should resume playing after interruption
262263
}
263264

264265
interface OnRouteChangeEventType {
265-
reason:
266-
| 'Unknown'
267-
| 'Override'
268-
| 'CategoryChange'
269-
| 'WakeFromSleep'
270-
| 'NewDeviceAvailable'
271-
| 'OldDeviceUnavailable'
272-
| 'ConfigurationChange'
273-
| 'NoSuitableRouteForCategory';
266+
reason:
267+
| 'Unknown'
268+
| 'Override'
269+
| 'CategoryChange'
270+
| 'WakeFromSleep'
271+
| 'NewDeviceAvailable'
272+
| 'OldDeviceUnavailable'
273+
| 'ConfigurationChange'
274+
| 'NoSuitableRouteForCategory';
274275
}
275276

276277
// visit https://developer.apple.com/documentation/mediaplayer/mpremotecommandcenter?language=objc
277278
// for further info
278279
interface RemoteCommandEvents {
279-
remotePlay: EventEmptyType;
280-
remotePause: EventEmptyType;
281-
remoteStop: EventEmptyType;
282-
remoteTogglePlayPause: EventEmptyType; // iOS only
283-
remoteChangePlaybackRate: EventTypeWithValue;
284-
remoteNextTrack: EventEmptyType;
285-
remotePreviousTrack: EventEmptyType;
286-
remoteSkipForward: EventTypeWithValue;
287-
remoteSkipBackward: EventTypeWithValue; // iOS only
288-
remoteSeekForward: EventEmptyType; // iOS only
289-
remoteSeekBackward: EventEmptyType;
290-
remoteChangePlaybackPosition: EventTypeWithValue;
280+
remotePlay: EventEmptyType;
281+
remotePause: EventEmptyType;
282+
remoteStop: EventEmptyType;
283+
remoteTogglePlayPause: EventEmptyType; // iOS only
284+
remoteChangePlaybackRate: EventTypeWithValue;
285+
remoteNextTrack: EventEmptyType;
286+
remotePreviousTrack: EventEmptyType;
287+
remoteSkipForward: EventTypeWithValue;
288+
remoteSkipBackward: EventTypeWithValue; // iOS only
289+
remoteSeekForward: EventEmptyType; // iOS only
290+
remoteSeekBackward: EventEmptyType;
291+
remoteChangePlaybackPosition: EventTypeWithValue;
291292
}
292293

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

299300
type RemoteCommandEventName = keyof RemoteCommandEvents;
300301
type SystemEventName = keyof SystemEvents;
301302
type SystemEventCallback<Name extends SystemEventName> = (
302-
event: SystemEvents[Name]
303+
event: SystemEvents[Name]
303304
) => void;
304-
305-
````
305+
```
306306
</details>
307307

308308

@@ -334,16 +334,16 @@ class AudioEventSubscription {
334334
);
335335
}
336336
}
337-
````
338-
337+
```
339338
</details>
340339

341340
### `PermissionStatus`
342341

343342
<details>
344-
<summary>Type definitions</summary>
345-
```typescript type PermissionStatus = 'Undetermined' | 'Denied' | 'Granted';
346-
```
343+
<summary>Type definitions</summary>
344+
```typescript
345+
type PermissionStatus = 'Undetermined' | 'Denied' | 'Granted';
346+
```
347347
</details>
348348

349349
### `AudioDevicesInfo`

packages/react-native-audio-api/ios/audioapi/ios/system/AudioSessionManager.mm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ - (void)setAudioSessionOptions:(NSString *)category
9191
sessionOptions |= AVAudioSessionCategoryOptionAllowBluetoothHFP;
9292
}
9393

94-
if ([option isEqualToString:@"bluetoothHighQualityRecording"]) {
94+
if (@available(iOS 26.0, *) && [option isEqualToString:@"bluetoothHighQualityRecording"]) {
9595
sessionOptions |= AVAudioSessionCategoryOptionBluetoothHighQualityRecording;
9696
}
9797

0 commit comments

Comments
 (0)