expo-native-track-player 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ExpoNativeTrackPlayer.podspec +21 -0
- package/LICENSE +20 -0
- package/README.md +267 -0
- package/android/build.gradle +71 -0
- package/android/src/main/AndroidManifest.xml +12 -0
- package/android/src/main/java/com/exponativetrackplayer/ExpoNativeTrackPlayerModule.kt +528 -0
- package/android/src/main/java/com/exponativetrackplayer/ExpoNativeTrackPlayerPackage.kt +34 -0
- package/android/src/main/java/com/exponativetrackplayer/ExpoNativeTrackPlayerService.kt +118 -0
- package/ios/ExpoNativeTrackPlayer.h +6 -0
- package/ios/ExpoNativeTrackPlayer.mm +475 -0
- package/lib/module/NativeExpoNativeTrackPlayer.js +5 -0
- package/lib/module/NativeExpoNativeTrackPlayer.js.map +1 -0
- package/lib/module/constants.js +31 -0
- package/lib/module/constants.js.map +1 -0
- package/lib/module/events.js +56 -0
- package/lib/module/events.js.map +1 -0
- package/lib/module/hooks.js +105 -0
- package/lib/module/hooks.js.map +1 -0
- package/lib/module/index.js +150 -0
- package/lib/module/index.js.map +1 -0
- package/lib/module/package.json +1 -0
- package/lib/module/types/ResourceObject.js +2 -0
- package/lib/module/types/ResourceObject.js.map +1 -0
- package/lib/module/types/Track.js +4 -0
- package/lib/module/types/Track.js.map +1 -0
- package/lib/module/types/TrackMetadataBase.js +2 -0
- package/lib/module/types/TrackMetadataBase.js.map +1 -0
- package/lib/typescript/package.json +1 -0
- package/lib/typescript/src/NativeExpoNativeTrackPlayer.d.ts +57 -0
- package/lib/typescript/src/NativeExpoNativeTrackPlayer.d.ts.map +1 -0
- package/lib/typescript/src/constants.d.ts +23 -0
- package/lib/typescript/src/constants.d.ts.map +1 -0
- package/lib/typescript/src/events.d.ts +163 -0
- package/lib/typescript/src/events.d.ts.map +1 -0
- package/lib/typescript/src/hooks.d.ts +12 -0
- package/lib/typescript/src/hooks.d.ts.map +1 -0
- package/lib/typescript/src/index.d.ts +65 -0
- package/lib/typescript/src/index.d.ts.map +1 -0
- package/lib/typescript/src/types/ResourceObject.d.ts +5 -0
- package/lib/typescript/src/types/ResourceObject.d.ts.map +1 -0
- package/lib/typescript/src/types/Track.d.ts +22 -0
- package/lib/typescript/src/types/Track.d.ts.map +1 -0
- package/lib/typescript/src/types/TrackMetadataBase.d.ts +18 -0
- package/lib/typescript/src/types/TrackMetadataBase.d.ts.map +1 -0
- package/package.json +172 -0
- package/src/NativeExpoNativeTrackPlayer.ts +70 -0
- package/src/constants.ts +40 -0
- package/src/events.ts +136 -0
- package/src/hooks.ts +149 -0
- package/src/index.tsx +250 -0
- package/src/types/ResourceObject.ts +4 -0
- package/src/types/Track.ts +23 -0
- package/src/types/TrackMetadataBase.ts +17 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
require "json"
|
|
2
|
+
|
|
3
|
+
package = JSON.parse(File.read(File.join(__dir__, "package.json")))
|
|
4
|
+
|
|
5
|
+
Pod::Spec.new do |s|
|
|
6
|
+
s.name = "ExpoNativeTrackPlayer"
|
|
7
|
+
s.version = package["version"]
|
|
8
|
+
s.summary = package["description"]
|
|
9
|
+
s.homepage = package["homepage"]
|
|
10
|
+
s.license = package["license"]
|
|
11
|
+
s.authors = package["author"]
|
|
12
|
+
|
|
13
|
+
s.platforms = { :ios => min_ios_version_supported }
|
|
14
|
+
s.source = { :git => ".git", :tag => "#{s.version}" }
|
|
15
|
+
|
|
16
|
+
s.source_files = "ios/**/*.{h,m,mm,swift,cpp}"
|
|
17
|
+
s.private_header_files = "ios/**/*.h"
|
|
18
|
+
s.frameworks = ["AVFoundation", "CoreMedia", "MediaPlayer"]
|
|
19
|
+
|
|
20
|
+
install_modules_dependencies(s)
|
|
21
|
+
end
|
package/LICENSE
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026
|
|
4
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
5
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
6
|
+
in the Software without restriction, including without limitation the rights
|
|
7
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
8
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
9
|
+
furnished to do so, subject to the following conditions:
|
|
10
|
+
|
|
11
|
+
The above copyright notice and this permission notice shall be included in all
|
|
12
|
+
copies or substantial portions of the Software.
|
|
13
|
+
|
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
15
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
16
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
17
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
18
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
19
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
20
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,267 @@
|
|
|
1
|
+
# expo-native-track-player
|
|
2
|
+
|
|
3
|
+
TurboModule track player for React Native New Architecture (iOS + Android).
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- Native queue management
|
|
8
|
+
- Repeat modes: `off`, `track`, `queue`, `loop_portion`
|
|
9
|
+
- Full track metadata
|
|
10
|
+
- Background playback ready (native)
|
|
11
|
+
- Android foreground service + media notification
|
|
12
|
+
- Audio focus handling (Android)
|
|
13
|
+
- Simple async JS API
|
|
14
|
+
|
|
15
|
+
## Installation (outside this repo)
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
npm install expo-native-track-player
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Requirements
|
|
22
|
+
|
|
23
|
+
- React Native New Architecture enabled
|
|
24
|
+
- Android: minSdk 24+
|
|
25
|
+
- iOS: Background audio capability for long playback
|
|
26
|
+
|
|
27
|
+
## Expo usage
|
|
28
|
+
|
|
29
|
+
This library requires native code (TurboModule + Media3). It is **not** usable in
|
|
30
|
+
Expo Go. Use one of these:
|
|
31
|
+
|
|
32
|
+
- **Expo prebuild (recommended)**: `npx expo prebuild` and run native builds.
|
|
33
|
+
- **Expo bare workflow**: use the generated `ios/` and `android/` projects.
|
|
34
|
+
|
|
35
|
+
### Expo prebuild steps
|
|
36
|
+
|
|
37
|
+
1. Install the package:
|
|
38
|
+
```sh
|
|
39
|
+
npm install expo-native-track-player
|
|
40
|
+
```
|
|
41
|
+
2. Generate native projects:
|
|
42
|
+
```sh
|
|
43
|
+
npx expo prebuild
|
|
44
|
+
```
|
|
45
|
+
3. Run the app:
|
|
46
|
+
```sh
|
|
47
|
+
npx expo run:ios
|
|
48
|
+
npx expo run:android
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Expo config notes
|
|
52
|
+
|
|
53
|
+
- iOS: add background audio mode in `app.json`:
|
|
54
|
+
```json
|
|
55
|
+
{
|
|
56
|
+
"ios": {
|
|
57
|
+
"infoPlist": {
|
|
58
|
+
"UIBackgroundModes": ["audio"]
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
- Android: the required permissions are declared in the library manifest,
|
|
64
|
+
but Android 13+ still needs runtime notification permission.
|
|
65
|
+
|
|
66
|
+
### iOS
|
|
67
|
+
|
|
68
|
+
```sh
|
|
69
|
+
cd ios
|
|
70
|
+
pod install
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Ensure New Architecture is enabled in your app (RCT_NEW_ARCH_ENABLED=1).
|
|
74
|
+
|
|
75
|
+
Enable background audio in your app target:
|
|
76
|
+
- `UIBackgroundModes` includes `audio`
|
|
77
|
+
|
|
78
|
+
### Android
|
|
79
|
+
|
|
80
|
+
This module uses a foreground media service for reliable background playback.
|
|
81
|
+
Ensure your app has these permissions:
|
|
82
|
+
|
|
83
|
+
```xml
|
|
84
|
+
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
|
|
85
|
+
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK" />
|
|
86
|
+
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
On Android 13+ you must request notification permission at runtime for the
|
|
90
|
+
media notification to appear.
|
|
91
|
+
|
|
92
|
+
Make sure you test background playback on a real device.
|
|
93
|
+
|
|
94
|
+
## Usage
|
|
95
|
+
|
|
96
|
+
```tsx
|
|
97
|
+
import TrackPlayer, {
|
|
98
|
+
type PlaybackState,
|
|
99
|
+
type RepeatMode,
|
|
100
|
+
type TrackMetadata,
|
|
101
|
+
} from 'expo-native-track-player';
|
|
102
|
+
|
|
103
|
+
const track: TrackMetadata = {
|
|
104
|
+
id: '001',
|
|
105
|
+
url: 'https://example.com/audio.mp3',
|
|
106
|
+
title: 'Example Track',
|
|
107
|
+
artist: 'Artist Name',
|
|
108
|
+
};
|
|
109
|
+
|
|
110
|
+
await TrackPlayer.reset();
|
|
111
|
+
await TrackPlayer.addToQueue(track);
|
|
112
|
+
await TrackPlayer.play(null);
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
## API
|
|
116
|
+
|
|
117
|
+
All time values are milliseconds unless stated otherwise.
|
|
118
|
+
|
|
119
|
+
### Types
|
|
120
|
+
|
|
121
|
+
```ts
|
|
122
|
+
export interface TrackMetadata {
|
|
123
|
+
id: string;
|
|
124
|
+
url: string;
|
|
125
|
+
title?: string;
|
|
126
|
+
artist?: string;
|
|
127
|
+
albumName?: string;
|
|
128
|
+
artworkUri?: string;
|
|
129
|
+
trackNumber?: number;
|
|
130
|
+
composer?: string;
|
|
131
|
+
conductor?: string;
|
|
132
|
+
genre?: string;
|
|
133
|
+
compilation?: string;
|
|
134
|
+
subtitle?: string;
|
|
135
|
+
description?: string;
|
|
136
|
+
station?: string;
|
|
137
|
+
mediaType?: number;
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
export type RepeatMode = 'off' | 'track' | 'queue' | 'loop_portion';
|
|
141
|
+
export type PlaybackState = 'playing' | 'paused' | 'stopped';
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### Queue
|
|
145
|
+
|
|
146
|
+
- `addToQueue(track: TrackMetadata): Promise<void>`
|
|
147
|
+
- `addQueue(tracks: TrackMetadata[]): Promise<void>`
|
|
148
|
+
- `getQueue(): Promise<TrackMetadata[]>`
|
|
149
|
+
- `removeFromQueue(trackId: string): Promise<void>`
|
|
150
|
+
- `clearQueue(): Promise<void>`
|
|
151
|
+
|
|
152
|
+
### Playback
|
|
153
|
+
|
|
154
|
+
- `play(index?: number | null): Promise<void>`
|
|
155
|
+
- `pause(): Promise<void>`
|
|
156
|
+
- `stop(): Promise<void>`
|
|
157
|
+
- `skipToNext(): Promise<void>`
|
|
158
|
+
- `skipToPrevious(): Promise<void>`
|
|
159
|
+
- `skipToIndex(index: number): Promise<void>`
|
|
160
|
+
- `seekTo(positionMs: number): Promise<void>`
|
|
161
|
+
- `reset(): Promise<void>`
|
|
162
|
+
|
|
163
|
+
### Repeat
|
|
164
|
+
|
|
165
|
+
- `setRepeatMode(mode: RepeatMode, startMs?: number | null, endMs?: number | null): Promise<void>`
|
|
166
|
+
- `getRepeatMode(): Promise<RepeatMode>`
|
|
167
|
+
|
|
168
|
+
`loop_portion` repeats between `startMs` and `endMs`.
|
|
169
|
+
|
|
170
|
+
### State
|
|
171
|
+
|
|
172
|
+
- `getCurrentTrack(): Promise<TrackMetadata | null>`
|
|
173
|
+
- `getCurrentTrackIndex(): Promise<number>`
|
|
174
|
+
- `getPosition(): Promise<number>`
|
|
175
|
+
- `getDuration(): Promise<number>`
|
|
176
|
+
- `getPlaybackState(): Promise<PlaybackState>`
|
|
177
|
+
|
|
178
|
+
### Audio Controls
|
|
179
|
+
|
|
180
|
+
- `setVolume(volume: number): Promise<void>` (0.0 to 1.0)
|
|
181
|
+
- `getVolume(): Promise<number>`
|
|
182
|
+
- `setRate(rate: number): Promise<void>` (0.5 to 2.0 recommended)
|
|
183
|
+
- `getRate(): Promise<number>`
|
|
184
|
+
|
|
185
|
+
## Background playback
|
|
186
|
+
|
|
187
|
+
### Android
|
|
188
|
+
|
|
189
|
+
- Foreground service keeps playback alive in background.
|
|
190
|
+
- Media notification is required for long playback.
|
|
191
|
+
- Audio focus is enabled; playback may pause on focus loss.
|
|
192
|
+
|
|
193
|
+
### iOS
|
|
194
|
+
|
|
195
|
+
- Enable `audio` under `UIBackgroundModes`.
|
|
196
|
+
- Keep the app audio session active.
|
|
197
|
+
|
|
198
|
+
## Troubleshooting
|
|
199
|
+
|
|
200
|
+
### Android: audio plays but no sound
|
|
201
|
+
|
|
202
|
+
- URL must be ASCII-safe. If it contains non-ASCII characters, URL-encode it.
|
|
203
|
+
- Ensure device volume and notification permission are enabled.
|
|
204
|
+
- Test on a real device; emulators are not reliable for audio focus/Doze.
|
|
205
|
+
|
|
206
|
+
### Android: queue empty after add
|
|
207
|
+
|
|
208
|
+
- The example app sets a local queue immediately and then syncs from native.
|
|
209
|
+
|
|
210
|
+
### iOS: background audio stops
|
|
211
|
+
|
|
212
|
+
- Confirm background audio capability is enabled in Xcode.
|
|
213
|
+
|
|
214
|
+
## Example app (this repo)
|
|
215
|
+
|
|
216
|
+
```sh
|
|
217
|
+
cd example
|
|
218
|
+
yarn install
|
|
219
|
+
|
|
220
|
+
# iOS
|
|
221
|
+
cd ios
|
|
222
|
+
pod install
|
|
223
|
+
cd ..
|
|
224
|
+
yarn ios
|
|
225
|
+
|
|
226
|
+
# Android
|
|
227
|
+
yarn android
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
The example app should boot and load the sample queue on startup.
|
|
231
|
+
|
|
232
|
+
## Example usage patterns
|
|
233
|
+
|
|
234
|
+
### Add multiple tracks and play
|
|
235
|
+
|
|
236
|
+
```ts
|
|
237
|
+
await TrackPlayer.reset();
|
|
238
|
+
await TrackPlayer.addQueue(tracks);
|
|
239
|
+
await TrackPlayer.play(null);
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
### Loop a portion of a track
|
|
243
|
+
|
|
244
|
+
```ts
|
|
245
|
+
await TrackPlayer.setRepeatMode('loop_portion', 2000, 10000);
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
### Jump to a specific track
|
|
249
|
+
|
|
250
|
+
```ts
|
|
251
|
+
await TrackPlayer.skipToIndex(3);
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
## Contributing
|
|
256
|
+
|
|
257
|
+
- [Development workflow](CONTRIBUTING.md#development-workflow)
|
|
258
|
+
- [Sending a pull request](CONTRIBUTING.md#sending-a-pull-request)
|
|
259
|
+
- [Code of conduct](CODE_OF_CONDUCT.md)
|
|
260
|
+
|
|
261
|
+
## License
|
|
262
|
+
|
|
263
|
+
MIT
|
|
264
|
+
|
|
265
|
+
---
|
|
266
|
+
|
|
267
|
+
Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
buildscript {
|
|
2
|
+
ext.ExpoNativeTrackPlayer = [
|
|
3
|
+
kotlinVersion: "2.0.21",
|
|
4
|
+
minSdkVersion: 24,
|
|
5
|
+
compileSdkVersion: 36,
|
|
6
|
+
targetSdkVersion: 36
|
|
7
|
+
]
|
|
8
|
+
|
|
9
|
+
ext.getExtOrDefault = { prop ->
|
|
10
|
+
if (rootProject.ext.has(prop)) {
|
|
11
|
+
return rootProject.ext.get(prop)
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
return ExpoNativeTrackPlayer[prop]
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
repositories {
|
|
18
|
+
google()
|
|
19
|
+
mavenCentral()
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
dependencies {
|
|
23
|
+
classpath "com.android.tools.build:gradle:8.7.2"
|
|
24
|
+
// noinspection DifferentKotlinGradleVersion
|
|
25
|
+
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${getExtOrDefault('kotlinVersion')}"
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
apply plugin: "com.android.library"
|
|
31
|
+
apply plugin: "kotlin-android"
|
|
32
|
+
|
|
33
|
+
apply plugin: "com.facebook.react"
|
|
34
|
+
|
|
35
|
+
android {
|
|
36
|
+
namespace "com.exponativetrackplayer"
|
|
37
|
+
|
|
38
|
+
compileSdkVersion getExtOrDefault("compileSdkVersion")
|
|
39
|
+
|
|
40
|
+
defaultConfig {
|
|
41
|
+
minSdkVersion getExtOrDefault("minSdkVersion")
|
|
42
|
+
targetSdkVersion getExtOrDefault("targetSdkVersion")
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
buildFeatures {
|
|
46
|
+
buildConfig true
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
buildTypes {
|
|
50
|
+
release {
|
|
51
|
+
minifyEnabled false
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
lint {
|
|
56
|
+
disable "GradleCompatible"
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
compileOptions {
|
|
60
|
+
sourceCompatibility JavaVersion.VERSION_1_8
|
|
61
|
+
targetCompatibility JavaVersion.VERSION_1_8
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
dependencies {
|
|
66
|
+
implementation "com.facebook.react:react-android"
|
|
67
|
+
implementation "androidx.media3:media3-common:1.7.1"
|
|
68
|
+
implementation "androidx.media3:media3-exoplayer:1.7.1"
|
|
69
|
+
implementation "androidx.media3:media3-session:1.7.1"
|
|
70
|
+
implementation "androidx.media3:media3-ui:1.7.1"
|
|
71
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
|
|
2
|
+
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
|
|
3
|
+
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK" />
|
|
4
|
+
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
|
|
5
|
+
|
|
6
|
+
<application>
|
|
7
|
+
<service
|
|
8
|
+
android:name=".ExpoNativeTrackPlayerService"
|
|
9
|
+
android:exported="false"
|
|
10
|
+
android:foregroundServiceType="mediaPlayback" />
|
|
11
|
+
</application>
|
|
12
|
+
</manifest>
|