react-native-mp3-player 1.0.0

package/lib/src/constants/IOSCategory.d.ts

@@ -0,0 +1,36 @@
+export declare enum IOSCategory {
+    /**
+     * The category for playing recorded music or other sounds that are central
+     * to the successful use of your app.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616509-playback
+     **/
+    Playback = "playback",
+    /**
+     * The category for recording (input) and playback (output) of audio, such as
+     * for a Voice over Internet Protocol (VoIP) app.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616568-playandrecord
+     **/
+    PlayAndRecord = "playAndRecord",
+    /**
+     * The category for routing distinct streams of audio data to different
+     * output devices at the same time.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616484-multiroute
+     **/
+    MultiRoute = "multiRoute",
+    /**
+     * The category for an app in which sound playback is nonprimary — that is,
+     * your app also works with the sound turned off.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616560-ambient
+     **/
+    Ambient = "ambient",
+    /**
+     * The default audio session category.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616488-soloambient
+     **/
+    SoloAmbient = "soloAmbient",
+    /**
+     * The category for recording audio while also silencing playback audio.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616451-record
+     **/
+    Record = "record"
+}

package/lib/src/constants/IOSCategory.js

@@ -0,0 +1,37 @@
+export var IOSCategory;
+(function (IOSCategory) {
+    /**
+     * The category for playing recorded music or other sounds that are central
+     * to the successful use of your app.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616509-playback
+     **/
+    IOSCategory["Playback"] = "playback";
+    /**
+     * The category for recording (input) and playback (output) of audio, such as
+     * for a Voice over Internet Protocol (VoIP) app.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616568-playandrecord
+     **/
+    IOSCategory["PlayAndRecord"] = "playAndRecord";
+    /**
+     * The category for routing distinct streams of audio data to different
+     * output devices at the same time.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616484-multiroute
+     **/
+    IOSCategory["MultiRoute"] = "multiRoute";
+    /**
+     * The category for an app in which sound playback is nonprimary — that is,
+     * your app also works with the sound turned off.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616560-ambient
+     **/
+    IOSCategory["Ambient"] = "ambient";
+    /**
+     * The default audio session category.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616488-soloambient
+     **/
+    IOSCategory["SoloAmbient"] = "soloAmbient";
+    /**
+     * The category for recording audio while also silencing playback audio.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/category/1616451-record
+     **/
+    IOSCategory["Record"] = "record";
+})(IOSCategory || (IOSCategory = {}));

package/lib/src/constants/IOSCategoryMode.d.ts

@@ -0,0 +1,47 @@
+export declare enum IOSCategoryMode {
+    /**
+     * The default audio session mode.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616579-default
+     **/
+    Default = "default",
+    /**
+     * A mode that the GameKit framework sets on behalf of an application that
+     * uses GameKit’s voice chat service.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616511-gamechat
+     **/
+    GameChat = "gameChat",
+    /**
+     * A mode that indicates that your app is performing measurement of audio
+     * input or output.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616608-measurement
+     **/
+    Measurement = "measurement",
+    /** A mode that indicates that your app is playing back movie content.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616623-movieplayback
+     **/
+    MoviePlayback = "moviePlayback",
+    /** A mode used for continuous spoken audio to pause the audio when another
+     * app plays a short audio prompt. See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616510-spokenaudio */
+    SpokenAudio = "spokenAudio",
+    /**
+     * A mode that indicates that your app is engaging in online video conferencing.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616590-videochat
+     **/
+    VideoChat = "videoChat",
+    /**
+     * A mode that indicates that your app is recording a movie.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616535-videorecording
+     **/
+    VideoRecording = "videoRecording",
+    /**
+     * A mode that indicates that your app is performing two-way voice communication,
+     * such as using Voice over Internet Protocol (VoIP).
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616455-voicechat
+     **/
+    VoiceChat = "voiceChat",
+    /**
+     * A mode that indicates that your app plays audio using text-to-speech.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/2962803-voiceprompt
+     **/
+    VoicePrompt = "voicePrompt"
+}

package/lib/src/constants/IOSCategoryMode.js

@@ -0,0 +1,48 @@
+export var IOSCategoryMode;
+(function (IOSCategoryMode) {
+    /**
+     * The default audio session mode.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616579-default
+     **/
+    IOSCategoryMode["Default"] = "default";
+    /**
+     * A mode that the GameKit framework sets on behalf of an application that
+     * uses GameKit’s voice chat service.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616511-gamechat
+     **/
+    IOSCategoryMode["GameChat"] = "gameChat";
+    /**
+     * A mode that indicates that your app is performing measurement of audio
+     * input or output.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616608-measurement
+     **/
+    IOSCategoryMode["Measurement"] = "measurement";
+    /** A mode that indicates that your app is playing back movie content.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616623-movieplayback
+     **/
+    IOSCategoryMode["MoviePlayback"] = "moviePlayback";
+    /** A mode used for continuous spoken audio to pause the audio when another
+     * app plays a short audio prompt. See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616510-spokenaudio */
+    IOSCategoryMode["SpokenAudio"] = "spokenAudio";
+    /**
+     * A mode that indicates that your app is engaging in online video conferencing.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616590-videochat
+     **/
+    IOSCategoryMode["VideoChat"] = "videoChat";
+    /**
+     * A mode that indicates that your app is recording a movie.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616535-videorecording
+     **/
+    IOSCategoryMode["VideoRecording"] = "videoRecording";
+    /**
+     * A mode that indicates that your app is performing two-way voice communication,
+     * such as using Voice over Internet Protocol (VoIP).
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/1616455-voicechat
+     **/
+    IOSCategoryMode["VoiceChat"] = "voiceChat";
+    /**
+     * A mode that indicates that your app plays audio using text-to-speech.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/2962803-voiceprompt
+     **/
+    IOSCategoryMode["VoicePrompt"] = "voicePrompt";
+})(IOSCategoryMode || (IOSCategoryMode = {}));

package/lib/src/constants/IOSCategoryOptions.d.ts

@@ -0,0 +1,44 @@
+export declare enum IOSCategoryOptions {
+    /**
+     * An option that indicates whether audio from this session mixes with audio
+     * from active sessions in other audio apps.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616611-mixwithothers
+     **/
+    MixWithOthers = "mixWithOthers",
+    /**
+     * An option that reduces the volume of other audio sessions while audio from
+     * this session plays.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616618-duckothers
+     **/
+    DuckOthers = "duckOthers",
+    /**
+     * An option that determines whether to pause spoken audio content from other
+     * sessions when your app plays its audio.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616534-interruptspokenaudioandmixwithot
+     **/
+    InterruptSpokenAudioAndMixWithOthers = "interruptSpokenAudioAndMixWithOthers",
+    /**
+     * An option that determines whether Bluetooth hands-free devices appear as
+     * available input routes.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616518-allowbluetooth
+     **/
+    AllowBluetooth = "allowBluetooth",
+    /**
+     * An option that determines whether you can stream audio from this session
+     * to Bluetooth devices that support the Advanced Audio Distribution Profile (A2DP).
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1771735-allowbluetootha2dp
+     **/
+    AllowBluetoothA2DP = "allowBluetoothA2DP",
+    /**
+     * An option that determines whether you can stream audio from this session
+     * to AirPlay devices.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1771736-allowairplay
+     **/
+    AllowAirPlay = "allowAirPlay",
+    /**
+     * An option that determines whether audio from the session defaults to the
+     * built-in speaker instead of the receiver.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616462-defaulttospeaker
+     **/
+    DefaultToSpeaker = "defaultToSpeaker"
+}

package/lib/src/constants/IOSCategoryOptions.js

@@ -0,0 +1,45 @@
+export var IOSCategoryOptions;
+(function (IOSCategoryOptions) {
+    /**
+     * An option that indicates whether audio from this session mixes with audio
+     * from active sessions in other audio apps.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616611-mixwithothers
+     **/
+    IOSCategoryOptions["MixWithOthers"] = "mixWithOthers";
+    /**
+     * An option that reduces the volume of other audio sessions while audio from
+     * this session plays.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616618-duckothers
+     **/
+    IOSCategoryOptions["DuckOthers"] = "duckOthers";
+    /**
+     * An option that determines whether to pause spoken audio content from other
+     * sessions when your app plays its audio.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616534-interruptspokenaudioandmixwithot
+     **/
+    IOSCategoryOptions["InterruptSpokenAudioAndMixWithOthers"] = "interruptSpokenAudioAndMixWithOthers";
+    /**
+     * An option that determines whether Bluetooth hands-free devices appear as
+     * available input routes.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616518-allowbluetooth
+     **/
+    IOSCategoryOptions["AllowBluetooth"] = "allowBluetooth";
+    /**
+     * An option that determines whether you can stream audio from this session
+     * to Bluetooth devices that support the Advanced Audio Distribution Profile (A2DP).
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1771735-allowbluetootha2dp
+     **/
+    IOSCategoryOptions["AllowBluetoothA2DP"] = "allowBluetoothA2DP";
+    /**
+     * An option that determines whether you can stream audio from this session
+     * to AirPlay devices.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1771736-allowairplay
+     **/
+    IOSCategoryOptions["AllowAirPlay"] = "allowAirPlay";
+    /**
+     * An option that determines whether audio from the session defaults to the
+     * built-in speaker instead of the receiver.
+     * See https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616462-defaulttospeaker
+     **/
+    IOSCategoryOptions["DefaultToSpeaker"] = "defaultToSpeaker";
+})(IOSCategoryOptions || (IOSCategoryOptions = {}));

package/lib/src/constants/MediaItemPlayable.d.ts

@@ -0,0 +1,4 @@
+export declare enum MediaItemPlayable {
+    MediaPlayable = "0",
+    MediaBrowsable = "1"
+}

package/lib/src/constants/MediaItemPlayable.js

@@ -0,0 +1,5 @@
+export var MediaItemPlayable;
+(function (MediaItemPlayable) {
+    MediaItemPlayable["MediaPlayable"] = "0";
+    MediaItemPlayable["MediaBrowsable"] = "1";
+})(MediaItemPlayable || (MediaItemPlayable = {}));

package/lib/src/constants/PitchAlgorithm.d.ts

@@ -0,0 +1,14 @@
+export declare enum PitchAlgorithm {
+    /**
+     * A high-quality time pitch algorithm that doesn’t perform pitch correction.
+     * */
+    Linear,
+    /**
+     * A highest-quality time pitch algorithm that’s suitable for music.
+     **/
+    Music,
+    /**
+     * A modest quality time pitch algorithm that’s suitable for voice.
+     **/
+    Voice
+}

package/lib/src/constants/PitchAlgorithm.js

@@ -0,0 +1,16 @@
+import { Constants as TrackPlayer } from '../../specs/NativeTrackPlayer';
+export var PitchAlgorithm;
+(function (PitchAlgorithm) {
+    /**
+     * A high-quality time pitch algorithm that doesn’t perform pitch correction.
+     * */
+    PitchAlgorithm[PitchAlgorithm["Linear"] = TrackPlayer.PITCH_ALGORITHM_LINEAR] = "Linear";
+    /**
+     * A highest-quality time pitch algorithm that’s suitable for music.
+     **/
+    PitchAlgorithm[PitchAlgorithm["Music"] = TrackPlayer.PITCH_ALGORITHM_MUSIC] = "Music";
+    /**
+     * A modest quality time pitch algorithm that’s suitable for voice.
+     **/
+    PitchAlgorithm[PitchAlgorithm["Voice"] = TrackPlayer.PITCH_ALGORITHM_VOICE] = "Voice";
+})(PitchAlgorithm || (PitchAlgorithm = {}));

package/lib/src/constants/RatingType.d.ts

@@ -0,0 +1,8 @@
+export declare enum RatingType {
+    Heart,
+    ThumbsUpDown,
+    ThreeStars,
+    FourStars,
+    FiveStars,
+    Percentage
+}

package/lib/src/constants/RatingType.js

@@ -0,0 +1,10 @@
+import { Constants as TrackPlayer } from '../../specs/NativeTrackPlayer';
+export var RatingType;
+(function (RatingType) {
+    RatingType[RatingType["Heart"] = TrackPlayer.RATING_HEART] = "Heart";
+    RatingType[RatingType["ThumbsUpDown"] = TrackPlayer.RATING_THUMBS_UP_DOWN] = "ThumbsUpDown";
+    RatingType[RatingType["ThreeStars"] = TrackPlayer.RATING_3_STARS] = "ThreeStars";
+    RatingType[RatingType["FourStars"] = TrackPlayer.RATING_4_STARS] = "FourStars";
+    RatingType[RatingType["FiveStars"] = TrackPlayer.RATING_5_STARS] = "FiveStars";
+    RatingType[RatingType["Percentage"] = TrackPlayer.RATING_PERCENTAGE] = "Percentage";
+})(RatingType || (RatingType = {}));

package/lib/src/constants/RepeatMode.d.ts

@@ -0,0 +1,8 @@
+export declare enum RepeatMode {
+    /** Playback stops when the last track in the queue has finished playing. */
+    Off,
+    /** Repeats the current track infinitely during ongoing playback. */
+    Track,
+    /** Repeats the entire queue infinitely. */
+    Queue
+}

package/lib/src/constants/RepeatMode.js

@@ -0,0 +1,10 @@
+import { Constants as TrackPlayer } from '../../specs/NativeTrackPlayer';
+export var RepeatMode;
+(function (RepeatMode) {
+    /** Playback stops when the last track in the queue has finished playing. */
+    RepeatMode[RepeatMode["Off"] = TrackPlayer.REPEAT_OFF] = "Off";
+    /** Repeats the current track infinitely during ongoing playback. */
+    RepeatMode[RepeatMode["Track"] = TrackPlayer.REPEAT_TRACK] = "Track";
+    /** Repeats the entire queue infinitely. */
+    RepeatMode[RepeatMode["Queue"] = TrackPlayer.REPEAT_QUEUE] = "Queue";
+})(RepeatMode || (RepeatMode = {}));

package/lib/src/constants/State.d.ts

@@ -0,0 +1,34 @@
+export declare enum State {
+    /** Indicates that no media is currently loaded */
+    None = "none",
+    /** Indicates that the player is paused, but ready to start playing */
+    Ready = "ready",
+    /** Indicates that the player is currently playing */
+    Playing = "playing",
+    /** Indicates that the player is currently paused */
+    Paused = "paused",
+    /** Indicates that the player is currently stopped */
+    Stopped = "stopped",
+    /** Indicates that the initial load of the item is occurring. */
+    Loading = "loading",
+    /**
+     * @deprecated Use `State.Loading` instead.
+     **/
+    Connecting = "loading",
+    /**
+     * Indicates that the player is currently loading more data before it can
+     * continue playing or is ready to start playing.
+     */
+    Buffering = "buffering",
+    /**
+     * Indicates that playback of the current item failed. Call `TrackPlayer.getError()`
+     * to get more information on the type of error that occurred.
+     * Call `TrackPlayer.retry()` or `TrackPlayer.play()` to try to play the item
+     * again.
+     */
+    Error = "error",
+    /**
+     * Indicates that playback stopped due to the end of the queue being reached.
+     */
+    Ended = "ended"
+}

package/lib/src/constants/State.js

@@ -0,0 +1,35 @@
+export var State;
+(function (State) {
+    /** Indicates that no media is currently loaded */
+    State["None"] = "none";
+    /** Indicates that the player is paused, but ready to start playing */
+    State["Ready"] = "ready";
+    /** Indicates that the player is currently playing */
+    State["Playing"] = "playing";
+    /** Indicates that the player is currently paused */
+    State["Paused"] = "paused";
+    /** Indicates that the player is currently stopped */
+    State["Stopped"] = "stopped";
+    /** Indicates that the initial load of the item is occurring. */
+    State["Loading"] = "loading";
+    /**
+     * @deprecated Use `State.Loading` instead.
+     **/
+    State["Connecting"] = "loading";
+    /**
+     * Indicates that the player is currently loading more data before it can
+     * continue playing or is ready to start playing.
+     */
+    State["Buffering"] = "buffering";
+    /**
+     * Indicates that playback of the current item failed. Call `TrackPlayer.getError()`
+     * to get more information on the type of error that occurred.
+     * Call `TrackPlayer.retry()` or `TrackPlayer.play()` to try to play the item
+     * again.
+     */
+    State["Error"] = "error";
+    /**
+     * Indicates that playback stopped due to the end of the queue being reached.
+     */
+    State["Ended"] = "ended";
+})(State || (State = {}));

package/lib/src/constants/TrackType.d.ts

@@ -0,0 +1,6 @@
+export declare enum TrackType {
+    Default = "default",
+    Dash = "dash",
+    HLS = "hls",
+    SmoothStreaming = "smoothstreaming"
+}

package/lib/src/constants/TrackType.js

@@ -0,0 +1,7 @@
+export var TrackType;
+(function (TrackType) {
+    TrackType["Default"] = "default";
+    TrackType["Dash"] = "dash";
+    TrackType["HLS"] = "hls";
+    TrackType["SmoothStreaming"] = "smoothstreaming";
+})(TrackType || (TrackType = {}));

package/lib/src/constants/index.d.ts

@@ -0,0 +1,14 @@
+export * from './AndroidAudioContentType';
+export * from './AndroidAutoContentStyle';
+export * from './AppKilledPlaybackBehavior';
+export * from './Capability';
+export * from './Event';
+export * from './IOSCategory';
+export * from './IOSCategoryMode';
+export * from './IOSCategoryOptions';
+export * from './PitchAlgorithm';
+export * from './RatingType';
+export * from './RepeatMode';
+export * from './State';
+export * from './TrackType';
+export * from './MediaItemPlayable';

package/lib/src/constants/index.js

@@ -0,0 +1,14 @@
+export * from './AndroidAudioContentType';
+export * from './AndroidAutoContentStyle';
+export * from './AppKilledPlaybackBehavior';
+export * from './Capability';
+export * from './Event';
+export * from './IOSCategory';
+export * from './IOSCategoryMode';
+export * from './IOSCategoryOptions';
+export * from './PitchAlgorithm';
+export * from './RatingType';
+export * from './RepeatMode';
+export * from './State';
+export * from './TrackType';
+export * from './MediaItemPlayable';

package/lib/src/hooks/index.d.ts

@@ -0,0 +1,6 @@
+export * from './useActiveTrack';
+export * from './useIsPlaying';
+export * from './usePlayWhenReady';
+export * from './usePlaybackState';
+export * from './useProgress';
+export * from './useTrackPlayerEvents';

package/lib/src/hooks/index.js

@@ -0,0 +1,6 @@
+export * from './useActiveTrack';
+export * from './useIsPlaying';
+export * from './usePlayWhenReady';
+export * from './usePlaybackState';
+export * from './useProgress';
+export * from './useTrackPlayerEvents';

package/lib/src/hooks/useActiveTrack.d.ts

@@ -0,0 +1,2 @@
+import type { Track } from '../interfaces/Track';
+export declare const useActiveTrack: () => Track | undefined;

package/lib/src/hooks/useActiveTrack.js

@@ -0,0 +1,28 @@
+import { useState, useEffect } from 'react';
+import { getActiveTrack } from '../trackPlayer';
+import { Event } from '../constants';
+import { useTrackPlayerEvents } from './useTrackPlayerEvents';
+export const useActiveTrack = () => {
+    const [track, setTrack] = useState();
+    // Sets the initial index (if still undefined)
+    useEffect(() => {
+        let unmounted = false;
+        getActiveTrack()
+            .then((initialTrack) => {
+            if (unmounted)
+                return;
+            setTrack((track) => track ?? initialTrack ?? undefined);
+        })
+            .catch(() => {
+            // throws when you haven't yet setup, which is fine because it also
+            // means there's no active track
+        });
+        return () => {
+            unmounted = true;
+        };
+    }, []);
+    useTrackPlayerEvents([Event.PlaybackActiveTrackChanged], async ({ track }) => {
+        setTrack(track ?? undefined);
+    });
+    return track;
+};

package/lib/src/hooks/useAppIsInBackground.d.ts

@@ -0,0 +1 @@
+export declare function useAppIsInBackground(): boolean;

package/lib/src/hooks/useAppIsInBackground.js

@@ -0,0 +1,16 @@
+import { useState, useEffect, useRef } from 'react';
+import { AppState } from 'react-native';
+export function useAppIsInBackground() {
+    const [state, setState] = useState('active');
+    const eventListener = useRef(undefined);
+    useEffect(() => {
+        const onStateChange = (nextState) => {
+            setState(nextState);
+        };
+        eventListener.current = AppState.addEventListener('change', onStateChange);
+        return () => {
+            eventListener.current?.remove();
+        };
+    }, []);
+    return state === 'background';
+}

package/lib/src/hooks/useIsPlaying.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Tells whether the TrackPlayer is in a mode that most people would describe
+ * as "playing." Great for UI to decide whether to show a Play or Pause button.
+ * @returns playing - whether UI should likely show as Playing, or undefined
+ *   if this isn't yet known.
+ * @returns bufferingDuringPlay - whether UI should show as Buffering, or
+ *   undefined if this isn't yet known.
+ */
+export declare function useIsPlaying(): {
+    playing: undefined;
+    bufferingDuringPlay: undefined;
+} | {
+    playing: boolean;
+    bufferingDuringPlay: boolean;
+};
+/**
+ * This exists if you need realtime status on whether the TrackPlayer is
+ * playing, whereas the hooks all have a delay because they depend on responding
+ * to events before their state is updated.
+ *
+ * It also exists whenever you need to know the play state outside of a React
+ * component, since hooks only work in components.
+ *
+ * @returns playing - whether UI should likely show as Playing, or undefined
+ *   if this isn't yet known.
+ * @returns bufferingDuringPlay - whether UI should show as Buffering, or
+ *   undefined if this isn't yet known.
+ */
+export declare function isPlaying(): Promise<{
+    playing: undefined;
+    bufferingDuringPlay: undefined;
+} | {
+    playing: boolean;
+    bufferingDuringPlay: boolean;
+}>;

package/lib/src/hooks/useIsPlaying.js

@@ -0,0 +1,50 @@
+import * as TrackPlayer from '../trackPlayer';
+import { State } from '../constants';
+import { usePlayWhenReady } from './usePlayWhenReady';
+import { usePlaybackState } from './usePlaybackState';
+/**
+ * Tells whether the TrackPlayer is in a mode that most people would describe
+ * as "playing." Great for UI to decide whether to show a Play or Pause button.
+ * @returns playing - whether UI should likely show as Playing, or undefined
+ *   if this isn't yet known.
+ * @returns bufferingDuringPlay - whether UI should show as Buffering, or
+ *   undefined if this isn't yet known.
+ */
+export function useIsPlaying() {
+    const state = usePlaybackState().state;
+    const playWhenReady = usePlayWhenReady();
+    return determineIsPlaying(playWhenReady, state);
+}
+function determineIsPlaying(playWhenReady, state) {
+    if (playWhenReady === undefined || state === undefined) {
+        return { playing: undefined, bufferingDuringPlay: undefined };
+    }
+    const isLoading = state === State.Loading || state === State.Buffering;
+    const isErrored = state === State.Error;
+    const isEnded = state === State.Ended;
+    const isNone = state === State.None;
+    return {
+        playing: playWhenReady && !(isErrored || isEnded || isNone),
+        bufferingDuringPlay: playWhenReady && isLoading,
+    };
+}
+/**
+ * This exists if you need realtime status on whether the TrackPlayer is
+ * playing, whereas the hooks all have a delay because they depend on responding
+ * to events before their state is updated.
+ *
+ * It also exists whenever you need to know the play state outside of a React
+ * component, since hooks only work in components.
+ *
+ * @returns playing - whether UI should likely show as Playing, or undefined
+ *   if this isn't yet known.
+ * @returns bufferingDuringPlay - whether UI should show as Buffering, or
+ *   undefined if this isn't yet known.
+ */
+export async function isPlaying() {
+    const [playbackState, playWhenReady] = await Promise.all([
+        TrackPlayer.getPlaybackState(),
+        TrackPlayer.getPlayWhenReady(),
+    ]);
+    return determineIsPlaying(playWhenReady, playbackState.state);
+}

package/lib/src/hooks/usePlayWhenReady.d.ts

@@ -0,0 +1 @@
+export declare const usePlayWhenReady: () => boolean | undefined;