react-native-kit/react-native-track-player
React Native Track Player
This project is a cross-platform mobile audio player and native audio playback engine for React Native. It functions as a media session manager that integrates audio controls into device lock screens, system notifications, and external Bluetooth headsets.
The library features a dedicated mobile audio caching engine that preloads and stores content on disk to enable offline playback and gapless transitions. It also includes an automotive media interface that exposes audio content and playback controls to vehicle head units and car dashboards through hierarchical media browsing.
The system covers comprehensive audio playback management, including queue manipulation, metadata updates, and playback state monitoring. It provides tools for background audio management, DRM content playback, and streaming to external devices via native system pickers. Additional utilities include a configurable sleep timer and mechanisms for playback error recovery.
Features
- Audio Playback - Provides a native audio playback engine for React Native with background execution and media control support.
- Audio Playback Engines - Provides a native-backed audio playback engine that offloads decoding and stream management to platform-specific APIs.
- OS Media Session Integrations - Manages the bindings between application playback and operating system media sessions for system-wide controls.
- Audio - Utilizes persistent native services to maintain audio playback when the application is minimized or the screen is locked.
- Playback Preloading Engines - Provides a dedicated caching engine that preloads and stores content on disk for offline playback and gapless transitions.
- Playback Controls - Manages basic playback actions including playing, pausing, seeking, adjusting volume, and changing playback speed.
- Cross-Platform Audio Engines - Ships a cross-platform native audio playback engine supporting background playback, caching, and media sessions.
- Background Media Playback - Keeps audio playback active when the app is backgrounded, the screen is locked, or the user switches applications.
- Native Media Session Controls - Exposes audio playback controls to the device lock screen, system notifications, and connected Bluetooth headsets.
- Native Media Session Integrations - Integrates audio playback with device lock screens, system notifications, and Bluetooth headset commands.
- Background Audio Services - Maintains an active native process to ensure audio continues playing when the application is minimized or the screen is locked.
- Streaming Optimizations - Implements caching, preloading, and buffering strategies to ensure seamless, gapless transitions between audio tracks.
- Playback State Monitors - Tracks whether audio is playing, buffering, paused, or errored to keep the user interface synchronized.
- Transport Command Routing - Routes playback transport controls through a native bridge to ensure immediate response times for critical audio actions.
- Queue Navigation - Provides mechanisms for skipping tracks and jumping to specific indices within the playback sequence.
- Queue State Retrieval - Enables fetching the current media list and identifying the active track's position in the sequence.
- Playback Queue Managers - Enables adding, removing, reordering, or replacing audio tracks within a playback list at specific indexes.
- Audio Stream Caching - Caches streamed audio content on local disk to enable offline playback and reduce network data usage.
- Dynamic Metadata Updates - Modifies display information like titles or artists for a media item without interrupting the audio stream.
- Media Metadata Retrievers - Fetches track details like title and artist to synchronize the current playback state with native now-playing views.
- Offline Caching - Implements mechanisms for downloading and storing remote media content locally to enable offline access and gapless transitions.
- Playback Behavior Settings - Provides native player settings for content types, mixing modes, and automatic pause behavior upon output disconnection.
- Media Control Definitions - Defines which playback commands appear on the lock screen, notifications, and native media sessions.
- Automotive Head Unit Integration - Integrates audio content and navigation trees with vehicle head units and Android Auto for in-car playback.
- Hierarchical Media Browsing - Organizes audio content into a hierarchical structure of categories and folders for navigation on automotive displays.
- Hierarchical Navigation - Organizes audio content into a hierarchical tree structure for compatibility with automotive head units and system media browsers.
- Playback Position Tracking - Retrieves the current playback position, total media duration, and the amount of audio buffered on disk.
- Playback Transport Controls - Processes transport commands like play and skip via system handlers to ensure high responsiveness.
- JSI State Synchronization - Uses the React Native New Architecture (JSI) to synchronize playback state between native modules and JavaScript.
- Remote Control Configuration - Allows defining which playback commands appear on lock screens and notification areas to determine trigger responses.
- Audio Buffer Queues - Implements asynchronous buffering of audio data chunks to ensure seamless transitions and gapless playback.
- Event Bus Systems - Intercepts hardware and system-level media events via an event bus to trigger playback actions without waking the UI thread.
- Media - Intercepts media commands from the lock screen or notifications to trigger custom logic or update metadata.
- Prefetch Buffering - Implements prefetching buffers to download subsequent tracks in the queue, achieving gapless transitions.
- Runtime Configuration Retrieval - Retrieves the current playback speed, volume level, shuffle status, and repeat mode configuration.
- Media & Multimedia - Full-featured audio player for music applications.
