react-native-track-player/lib/src/hooks/useTrackPlayerEvents.js

A fully fledged audio module created for music apps

import { useEffect, useRef } from 'react';
import { addEventListener } from '../trackPlayer';
import { Event } from '../constants';
/**
 * Attaches a handler to the given TrackPlayer events and performs cleanup on unmount
 * @param events - TrackPlayer events to subscribe to
 * @param handler - callback invoked when the event fires
 */
export const useTrackPlayerEvents = (events, handler) => {
    const savedHandler = useRef(handler);
    savedHandler.current = handler;
    /* eslint-disable react-hooks/exhaustive-deps */
    useEffect(() => {
        if (__DEV__) {
            const allowedTypes = Object.values(Event);
            const invalidTypes = events.filter((type) => !allowedTypes.includes(type));
            if (invalidTypes.length) {
                console.warn('One or more of the events provided to useTrackPlayerEvents is ' +
                    `not a valid TrackPlayer event: ${invalidTypes.join("', '")}. ` +
                    'A list of available events can be found at ' +
                    'https://rntp.dev/docs/api/events');
            }
        }
        const subs = events.map((type) => addEventListener(type, (payload) => {
            // @ts-expect-error - we know the type is correct
            savedHandler.current({ ...payload, type });
        }));
        return () => subs.forEach((sub) => sub.remove());
    }, events);
};