react-native-nitro-player 1.7.0-alpha.4 → 1.7.0-alpha.6

package/nitrogen/generated/shared/c++/HybridAndroidAutoMediaLibrarySpec.cpp

@@ -16,6 +16,12 @@ namespace margelo::nitro::nitroplayer {
     registerHybrids(this, [](Prototype& prototype) {
       prototype.registerHybridMethod("setMediaLibrary", &HybridAndroidAutoMediaLibrarySpec::setMediaLibrary);
       prototype.registerHybridMethod("clearMediaLibrary", &HybridAndroidAutoMediaLibrarySpec::clearMediaLibrary);
+      prototype.registerHybridMethod("onLoadChildren", &HybridAndroidAutoMediaLibrarySpec::onLoadChildren);
+      prototype.registerHybridMethod("onSearch", &HybridAndroidAutoMediaLibrarySpec::onSearch);
+      prototype.registerHybridMethod("resolveRequest", &HybridAndroidAutoMediaLibrarySpec::resolveRequest);
+      prototype.registerHybridMethod("setSessionButtons", &HybridAndroidAutoMediaLibrarySpec::setSessionButtons);
+      prototype.registerHybridMethod("onSessionButtonPress", &HybridAndroidAutoMediaLibrarySpec::onSessionButtonPress);
+      prototype.registerHybridMethod("onPlaybackResumption", &HybridAndroidAutoMediaLibrarySpec::onPlaybackResumption);
     });
   }
 

package/nitrogen/generated/shared/c++/HybridAndroidAutoMediaLibrarySpec.hpp

@@ -17,6 +17,7 @@
 
 #include <NitroModules/Promise.hpp>
 #include <string>
+#include <functional>
 
 namespace margelo::nitro::nitroplayer {
 
@@ -51,6 +52,12 @@ namespace margelo::nitro::nitroplayer {
       // Methods
       virtual std::shared_ptr<Promise<void>> setMediaLibrary(const std::string& libraryJson) = 0;
       virtual std::shared_ptr<Promise<void>> clearMediaLibrary() = 0;
+      virtual void onLoadChildren(const std::function<void(const std::string& /* requestId */, const std::string& /* parentId */)>& callback) = 0;
+      virtual void onSearch(const std::function<void(const std::string& /* requestId */, const std::string& /* query */)>& callback) = 0;
+      virtual void resolveRequest(const std::string& requestId, const std::string& itemsJson) = 0;
+      virtual void setSessionButtons(const std::string& buttonsJson) = 0;
+      virtual void onSessionButtonPress(const std::function<void(const std::string& /* action */)>& callback) = 0;
+      virtual void onPlaybackResumption(const std::function<void()>& callback) = 0;
 
     protected:
       // Hybrid Setup

package/nitrogen/generated/shared/c++/PlayerConfig.hpp

@@ -47,13 +47,14 @@ namespace margelo::nitro::nitroplayer {
     std::optional<bool> showInNotification     SWIFT_PRIVATE;
     std::optional<double> remoteSkipForwardInterval     SWIFT_PRIVATE;
     std::optional<double> remoteSkipBackwardInterval     SWIFT_PRIVATE;
+    std::optional<bool> preferRemoteSkipIntervals     SWIFT_PRIVATE;
     std::optional<double> lookaheadCount     SWIFT_PRIVATE;
     std::optional<std::string> androidNotificationIcon     SWIFT_PRIVATE;
     std::optional<AndroidAudioFocusMode> androidAudioFocus     SWIFT_PRIVATE;
 
   public:
     PlayerConfig() = default;
-    explicit PlayerConfig(std::optional<bool> androidAutoEnabled, std::optional<bool> carPlayEnabled, std::optional<bool> showInNotification, std::optional<double> remoteSkipForwardInterval, std::optional<double> remoteSkipBackwardInterval, std::optional<double> lookaheadCount, std::optional<std::string> androidNotificationIcon, std::optional<AndroidAudioFocusMode> androidAudioFocus): androidAutoEnabled(androidAutoEnabled), carPlayEnabled(carPlayEnabled), showInNotification(showInNotification), remoteSkipForwardInterval(remoteSkipForwardInterval), remoteSkipBackwardInterval(remoteSkipBackwardInterval), lookaheadCount(lookaheadCount), androidNotificationIcon(androidNotificationIcon), androidAudioFocus(androidAudioFocus) {}
+    explicit PlayerConfig(std::optional<bool> androidAutoEnabled, std::optional<bool> carPlayEnabled, std::optional<bool> showInNotification, std::optional<double> remoteSkipForwardInterval, std::optional<double> remoteSkipBackwardInterval, std::optional<bool> preferRemoteSkipIntervals, std::optional<double> lookaheadCount, std::optional<std::string> androidNotificationIcon, std::optional<AndroidAudioFocusMode> androidAudioFocus): androidAutoEnabled(androidAutoEnabled), carPlayEnabled(carPlayEnabled), showInNotification(showInNotification), remoteSkipForwardInterval(remoteSkipForwardInterval), remoteSkipBackwardInterval(remoteSkipBackwardInterval), preferRemoteSkipIntervals(preferRemoteSkipIntervals), lookaheadCount(lookaheadCount), androidNotificationIcon(androidNotificationIcon), androidAudioFocus(androidAudioFocus) {}
 
   public:
     friend bool operator==(const PlayerConfig& lhs, const PlayerConfig& rhs) = default;
@@ -74,6 +75,7 @@ namespace margelo::nitro {
         JSIConverter<std::optional<bool>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "showInNotification"))),
         JSIConverter<std::optional<double>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "remoteSkipForwardInterval"))),
         JSIConverter<std::optional<double>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "remoteSkipBackwardInterval"))),
+        JSIConverter<std::optional<bool>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "preferRemoteSkipIntervals"))),
         JSIConverter<std::optional<double>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "lookaheadCount"))),
         JSIConverter<std::optional<std::string>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "androidNotificationIcon"))),
         JSIConverter<std::optional<margelo::nitro::nitroplayer::AndroidAudioFocusMode>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "androidAudioFocus")))
@@ -86,6 +88,7 @@ namespace margelo::nitro {
       obj.setProperty(runtime, PropNameIDCache::get(runtime, "showInNotification"), JSIConverter<std::optional<bool>>::toJSI(runtime, arg.showInNotification));
       obj.setProperty(runtime, PropNameIDCache::get(runtime, "remoteSkipForwardInterval"), JSIConverter<std::optional<double>>::toJSI(runtime, arg.remoteSkipForwardInterval));
       obj.setProperty(runtime, PropNameIDCache::get(runtime, "remoteSkipBackwardInterval"), JSIConverter<std::optional<double>>::toJSI(runtime, arg.remoteSkipBackwardInterval));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "preferRemoteSkipIntervals"), JSIConverter<std::optional<bool>>::toJSI(runtime, arg.preferRemoteSkipIntervals));
       obj.setProperty(runtime, PropNameIDCache::get(runtime, "lookaheadCount"), JSIConverter<std::optional<double>>::toJSI(runtime, arg.lookaheadCount));
       obj.setProperty(runtime, PropNameIDCache::get(runtime, "androidNotificationIcon"), JSIConverter<std::optional<std::string>>::toJSI(runtime, arg.androidNotificationIcon));
       obj.setProperty(runtime, PropNameIDCache::get(runtime, "androidAudioFocus"), JSIConverter<std::optional<margelo::nitro::nitroplayer::AndroidAudioFocusMode>>::toJSI(runtime, arg.androidAudioFocus));
@@ -104,6 +107,7 @@ namespace margelo::nitro {
       if (!JSIConverter<std::optional<bool>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "showInNotification")))) return false;
       if (!JSIConverter<std::optional<double>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "remoteSkipForwardInterval")))) return false;
       if (!JSIConverter<std::optional<double>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "remoteSkipBackwardInterval")))) return false;
+      if (!JSIConverter<std::optional<bool>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "preferRemoteSkipIntervals")))) return false;
       if (!JSIConverter<std::optional<double>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "lookaheadCount")))) return false;
       if (!JSIConverter<std::optional<std::string>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "androidNotificationIcon")))) return false;
       if (!JSIConverter<std::optional<margelo::nitro::nitroplayer::AndroidAudioFocusMode>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "androidAudioFocus")))) return false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-nitro-player",
-  "version": "1.7.0-alpha.4",
+  "version": "1.7.0-alpha.6",
   "description": "A powerful audio player library for React Native with playlist management, playback controls, and support for Android Auto and CarPlay",
   "main": "lib/index",
   "module": "lib/index",

package/src/index.ts

@@ -1,7 +1,7 @@
 // TODO: Export all HybridObjects here for the user
 
 import { NitroModules } from 'react-native-nitro-modules'
-import { Platform } from 'react-native'
+import { AppRegistry, Platform } from 'react-native'
 import type {
   PlayerQueue as PlayerQueueType,
   TrackPlayer as TrackPlayerType,
@@ -13,6 +13,14 @@ import type { Cast as CastType } from './specs/Cast.nitro'
 import type { DownloadManager as DownloadManagerType } from './specs/DownloadManager.nitro'
 import type { Equalizer as EqualizerType } from './specs/Equalizer.nitro'
 
+// Native runs this while it needs JS without a resumed activity (car, screen off): it keeps JS timers ticking
+if (Platform.OS === 'android') {
+  AppRegistry.registerHeadlessTask(
+    'NitroPlayerKeepAlive',
+    () => () => new Promise<void>(() => {})
+  )
+}
+
 export const PlayerQueue =
   NitroModules.createHybridObject<PlayerQueueType>('PlayerQueue')
 export const TrackPlayer =

package/src/specs/AndroidAutoMediaLibrary.nitro.ts

@@ -20,4 +20,22 @@ export interface AndroidAutoMediaLibrary extends HybridObject<{
    * Falls back to showing all playlists
    */
   clearMediaLibrary(): Promise<void>
+
+  /** Android Auto opened a folder published with `children: []`; answer with {@link resolveRequest}. */
+  onLoadChildren(callback: (requestId: string, parentId: string) => void): void
+
+  /** A car search, or a voice request the loaded playlists cannot match; answer with {@link resolveRequest}. */
+  onSearch(callback: (requestId: string, query: string) => void): void
+
+  /** Answers {@link onLoadChildren} / {@link onSearch} with a JSON array of MediaItem. */
+  resolveRequest(requestId: string, itemsJson: string): void
+
+  /** Replaces the session buttons with a JSON array of SessionButton. */
+  setSessionButtons(buttonsJson: string): void
+
+  /** Called with the button's `action` when a session button is pressed. */
+  onSessionButtonPress(callback: (action: string) => void): void
+
+  /** A controller asked to play with nothing loaded (car auto-play, play on connect); load the last queue now. */
+  onPlaybackResumption(callback: () => void): void
 }

package/src/types/AndroidAutoMediaLibrary.ts

@@ -38,6 +38,9 @@ export interface MediaItem {
 
   /** Layout type for folder items (overrides library default) */
   layoutType?: LayoutType
+
+  /** Group header; contiguous items sharing one are listed under it */
+  groupTitle?: string
 }
 
 /**
@@ -56,3 +59,24 @@ export interface MediaLibrary {
   /** Optional app icon URL */
   appIconUrl?: string
 }
+
+export type SessionButtonIcon =
+  | 'heart'
+  | 'heart_filled'
+  | 'star'
+  | 'star_filled'
+  | 'thumb_up'
+  | 'thumb_up_filled'
+  | 'plus'
+  | 'check'
+
+/** App-defined button beside the transport controls in Android Auto and the notification */
+export interface SessionButton {
+  /** Passed to the press callback */
+  action: string
+
+  /** Accessibility label */
+  title: string
+
+  icon: SessionButtonIcon
+}

package/src/types/PlayerQueue.ts

@@ -82,6 +82,10 @@ export interface PlayerConfig {
    * Fixed interval, in seconds, for remote skip-backward controls (default: 15)
    */
   remoteSkipBackwardInterval?: number
+  /**
+   * iOS only, ignored on Android: the lock screen, Control Center and CarPlay side buttons skip by the remote skip intervals instead of changing track (default: false)
+   */
+  preferRemoteSkipIntervals?: boolean
   /**
    * Number of upcoming tracks to preload URLs for (default: 5)
    * Higher values = more proactive loading, but more network requests

package/src/utils/androidAutoMediaLibrary.ts

@@ -1,6 +1,24 @@
-import type { MediaLibrary } from '../types/AndroidAutoMediaLibrary'
+import type {
+  MediaItem,
+  MediaLibrary,
+  SessionButton,
+} from '../types/AndroidAutoMediaLibrary'
 import { AndroidAutoMediaLibrary as AndroidAutoMediaLibraryModule } from '../index'
 
+type ItemsProvider = (
+  argument: string
+) => Promise<MediaItem[] | null | undefined>
+
+const answer = (requestId: string, provide: () => ReturnType<ItemsProvider>) =>
+  provide()
+    .catch(() => null)
+    .then((items) =>
+      AndroidAutoMediaLibraryModule?.resolveRequest(
+        requestId,
+        JSON.stringify(items ?? [])
+      )
+    )
+
 /**
  * Helper utilities for Android Auto Media Library
  * Android-only functionality
@@ -57,6 +75,35 @@ export const AndroidAutoMediaLibraryHelper = {
     AndroidAutoMediaLibraryModule.clearMediaLibrary()
   },
 
+  /** Children of folders published with `children: []`; playable ids are `${playlistId}:${trackId}`, empty after 10s. Register at module scope: the car can start the app without UI. */
+  setChildrenLoader: (loader: ItemsProvider): void => {
+    AndroidAutoMediaLibraryModule?.onLoadChildren((requestId, parentId) =>
+      answer(requestId, () => loader(parentId))
+    )
+  },
+
+  /** Answers car searches and unmatched voice requests (first playable result plays); search shows from the next connection. */
+  setSearchHandler: (handler: ItemsProvider): void => {
+    AndroidAutoMediaLibraryModule?.onSearch((requestId, query) =>
+      answer(requestId, () => handler(query))
+    )
+  },
+
+  /** Buttons beside the transport controls in Android Auto and the notification; call again to change their state. */
+  setSessionButtons: (buttons: SessionButton[]): void => {
+    AndroidAutoMediaLibraryModule?.setSessionButtons(JSON.stringify(buttons))
+  },
+
+  /** Called with the pressed button's `action`. */
+  onSessionButtonPress: (callback: (action: string) => void): void => {
+    AndroidAutoMediaLibraryModule?.onSessionButtonPress(callback)
+  },
+
+  /** Car auto-play or play-on-connect found nothing loaded: restore your last queue (playback starts once it is loaded). */
+  onPlaybackResumption: (callback: () => void): void => {
+    AndroidAutoMediaLibraryModule?.onPlaybackResumption(callback)
+  },
+
   /**
    * Check if Android Auto Media Library is available (Android only)
    */