@javascriptcommon/react-native-track-player 1.2.23 → 4.1.5

package/lib/specs/NativeTrackPlayer.d.ts

@@ -0,0 +1,134 @@
+import type { TurboModule } from 'react-native';
+import { type UnsafeObject } from 'react-native/Libraries/Types/CodegenTypes';
+export interface Spec extends TurboModule {
+    setupPlayer(options: UnsafeObject, background: boolean): Promise<void>;
+    updateOptions(options: UnsafeObject): Promise<void>;
+    load(track: UnsafeObject): Promise<number | void>;
+    reset(): Promise<void>;
+    play(): Promise<void>;
+    pause(): Promise<void>;
+    stop(): Promise<void>;
+    setPlayWhenReady(playWhenReady: boolean): Promise<boolean>;
+    getPlayWhenReady(): Promise<boolean>;
+    seekTo(position: number): Promise<void>;
+    seekBy(offset: number): Promise<void>;
+    setVolume(level: number): Promise<void>;
+    getVolume(): Promise<number>;
+    setRate(rate: number): Promise<void>;
+    getRate(): Promise<number>;
+    getProgress(): Promise<UnsafeObject>;
+    getPlaybackState(): Promise<UnsafeObject>;
+    retry(): Promise<void>;
+    add(tracks: UnsafeObject[], insertBeforeIndex: number): Promise<number | void>;
+    move(fromIndex: number, toIndex: number): Promise<void>;
+    remove(indexes: number[]): Promise<void>;
+    removeUpcomingTracks(): Promise<void>;
+    skip(index: number, initialPosition: number): Promise<void>;
+    skipToNext(initialPosition: number): Promise<void>;
+    skipToPrevious(initialPosition: number): Promise<void>;
+    updateMetadataForTrack(trackIndex: number, metadata: UnsafeObject): Promise<void>;
+    updateNowPlayingMetadata(metadata: UnsafeObject): Promise<void>;
+    setQueue(tracks: UnsafeObject[]): Promise<void>;
+    getQueue(): Promise<UnsafeObject[]>;
+    setRepeatMode(mode: number): Promise<number>;
+    getRepeatMode(): Promise<number>;
+    getTrack(index: number): Promise<UnsafeObject | undefined>;
+    getActiveTrackIndex(): Promise<number | undefined>;
+    getActiveTrack(): Promise<UnsafeObject | undefined>;
+    setBrowseTree(browseTree: UnsafeObject): Promise<string>;
+    setPlaybackState(mediaID: string): Promise<void>;
+    setBrowseTreeStyle(browsableStyle: number, playableStyle: number): Promise<void>;
+    setSearchResults(searchResults: UnsafeObject[]): Promise<void>;
+    crossFadePrepare(previous: boolean, seekTo?: number): Promise<void>;
+    switchExoPlayer(fadeDuration: number, fadeInterval: number, fadeToVolume: number, waitUntil?: number): Promise<void>;
+    getLastConnectedPackage(): Promise<string | undefined>;
+    setLoudnessEnhance(gain: number): Promise<void>;
+    setEqualizerPreset(preset: number): Promise<void>;
+    getCurrentEqualizerPreset(): Promise<number>;
+    getEqualizerPresets(): Promise<string[]>;
+    addListener(eventName: string): void;
+    removeListeners(count: number): void;
+    getConstants: () => {
+        CAPABILITY_PLAY: number;
+        CAPABILITY_PLAY_FROM_ID: number;
+        CAPABILITY_PLAY_FROM_SEARCH: number;
+        CAPABILITY_PAUSE: number;
+        CAPABILITY_STOP: number;
+        CAPABILITY_SEEK_TO: number;
+        CAPABILITY_SKIP: number;
+        CAPABILITY_SKIP_TO_NEXT: number;
+        CAPABILITY_SKIP_TO_PREVIOUS: number;
+        CAPABILITY_SET_RATING: number;
+        CAPABILITY_JUMP_FORWARD: number;
+        CAPABILITY_JUMP_BACKWARD: number;
+        CAPABILITY_LIKE: number;
+        CAPABILITY_DISLIKE: number;
+        CAPABILITY_BOOKMARK: number;
+        STATE_NONE: string;
+        STATE_READY: string;
+        STATE_PLAYING: string;
+        STATE_PAUSED: string;
+        STATE_STOPPED: string;
+        STATE_BUFFERING: string;
+        STATE_LOADING: string;
+        RATING_HEART: number;
+        RATING_THUMBS_UP_DOWN: number;
+        RATING_3_STARS: number;
+        RATING_4_STARS: number;
+        RATING_5_STARS: number;
+        RATING_PERCENTAGE: number;
+        REPEAT_OFF: number;
+        REPEAT_TRACK: number;
+        REPEAT_QUEUE: number;
+        PITCH_ALGORITHM_LINEAR: number;
+        PITCH_ALGORITHM_MUSIC: number;
+        PITCH_ALGORITHM_VOICE: number;
+    };
+    acquireWakeLock(): Promise<void>;
+    abandonWakeLock(): Promise<void>;
+    setAnimatedVolume(volume: number, duration: number, interval: number, msg: string): Promise<void>;
+    fadeOutPause(duration: number, interval: number): Promise<void>;
+    fadeOutNext(duration: number, interval: number, toVolume: number): Promise<void>;
+    fadeOutPrevious(duration: number, interval: number, toVolume: number): Promise<void>;
+    fadeOutJump(index: number, duration: number, interval: number, toVolume: number): Promise<void>;
+    setPitch(pitch: number): Promise<void>;
+    getPitch(): Promise<number>;
+}
+declare const module: Spec;
+export declare const Constants: {
+    CAPABILITY_PLAY: number;
+    CAPABILITY_PLAY_FROM_ID: number;
+    CAPABILITY_PLAY_FROM_SEARCH: number;
+    CAPABILITY_PAUSE: number;
+    CAPABILITY_STOP: number;
+    CAPABILITY_SEEK_TO: number;
+    CAPABILITY_SKIP: number;
+    CAPABILITY_SKIP_TO_NEXT: number;
+    CAPABILITY_SKIP_TO_PREVIOUS: number;
+    CAPABILITY_SET_RATING: number;
+    CAPABILITY_JUMP_FORWARD: number;
+    CAPABILITY_JUMP_BACKWARD: number;
+    CAPABILITY_LIKE: number;
+    CAPABILITY_DISLIKE: number;
+    CAPABILITY_BOOKMARK: number;
+    STATE_NONE: string;
+    STATE_READY: string;
+    STATE_PLAYING: string;
+    STATE_PAUSED: string;
+    STATE_STOPPED: string;
+    STATE_BUFFERING: string;
+    STATE_LOADING: string;
+    RATING_HEART: number;
+    RATING_THUMBS_UP_DOWN: number;
+    RATING_3_STARS: number;
+    RATING_4_STARS: number;
+    RATING_5_STARS: number;
+    RATING_PERCENTAGE: number;
+    REPEAT_OFF: number;
+    REPEAT_TRACK: number;
+    REPEAT_QUEUE: number;
+    PITCH_ALGORITHM_LINEAR: number;
+    PITCH_ALGORITHM_MUSIC: number;
+    PITCH_ALGORITHM_VOICE: number;
+};
+export default module;

package/lib/specs/NativeTrackPlayer.js

@@ -0,0 +1,4 @@
+import { TurboModuleRegistry } from 'react-native';
+const module = TurboModuleRegistry.getEnforcing('TrackPlayer');
+export const Constants = module?.getConstants();
+export default module;

package/lib/src/TrackPlayerModule.web.d.ts

@@ -0,0 +1,2 @@
+import TrackPlayerModule from '../web';
+export default TrackPlayerModule;

package/lib/src/TrackPlayerModule.web.js

@@ -0,0 +1,2 @@
+import TrackPlayerModule from '../web';
+export default TrackPlayerModule;

package/lib/src/VideoView.d.ts

@@ -0,0 +1,16 @@
+import React from 'react';
+import { StyleProp, ViewStyle } from 'react-native';
+interface VideoViewProps {
+    /**
+     * Style object that will be applied to the underlying native video view.
+     */
+    style?: StyleProp<ViewStyle>;
+    /**
+     * How the video should be resized to fit its container. On iOS this maps to
+     * AVLayerVideoGravity, on Android to ExoPlayer's resize mode.
+     * Defaults to "contain" (AspectFit).
+     */
+    resizeMode?: 'contain' | 'cover' | 'stretch' | 'none';
+}
+export declare const VideoView: React.FC<VideoViewProps>;
+export default VideoView;

package/lib/src/VideoView.js

@@ -0,0 +1,25 @@
+import React from 'react';
+import { requireNativeComponent, Platform, } from 'react-native';
+/**
+ * VideoView is a convenience component that synchronises a <Video> component
+ * with the currently playing track from react-native-track-player.
+ *
+ * It will automatically:
+ * 1. Render nothing when the current track does not expose a video source.
+ * 2. Pause/resume playback based on TrackPlayer's playback state.
+ *
+ * This makes it trivial to embed alongside your existing audio UI:
+ *
+ * ```tsx
+ * <VideoView style={{ width: 300, height: 200 }} />
+ * ```
+ */
+const NativeVideoView = requireNativeComponent(Platform.select({
+    ios: 'RNTrackPlayerVideoView',
+    android: 'RNTrackPlayerVideoView',
+    default: 'RNTrackPlayerVideoView',
+}));
+export const VideoView = ({ style, resizeMode = 'contain', }) => {
+    return <NativeVideoView style={style} resizeMode={resizeMode}/>;
+};
+export default VideoView;

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

@@ -0,0 +1,35 @@
+export declare enum AndroidAudioContentType {
+    /**
+     * Content type value to use when the content type is music.
+     *
+     * See https://developer.android.com/reference/android/media/AudioAttributes#CONTENT_TYPE_MUSIC
+     */
+    Music = "music",
+    /**
+     * Content type value to use when the content type is speech.
+     *
+     * See https://developer.android.com/reference/android/media/AudioAttributes#CONTENT_TYPE_SPEECH
+     */
+    Speech = "speech",
+    /**
+     * Content type value to use when the content type is a sound used to
+     * accompany a user action, such as a beep or sound effect expressing a key
+     * click, or event, such as the type of a sound for a bonus being received in
+     * a game. These sounds are mostly synthesized or short Foley sounds.
+     *
+     * See https://developer.android.com/reference/android/media/AudioAttributes#CONTENT_TYPE_SONIFICATION
+     */
+    Sonification = "sonification",
+    /**
+     * Content type value to use when the content type is a soundtrack, typically
+     * accompanying a movie or TV program.
+     */
+    Movie = "movie",
+    /**
+     * Content type value to use when the content type is unknown, or other than
+     * the ones defined.
+     *
+     * See https://developer.android.com/reference/android/media/AudioAttributes#CONTENT_TYPE_UNKNOWN
+     */
+    Unknown = "unknown"
+}

package/lib/src/constants/AndroidAudioContentType.js

@@ -0,0 +1,36 @@
+export var AndroidAudioContentType;
+(function (AndroidAudioContentType) {
+    /**
+     * Content type value to use when the content type is music.
+     *
+     * See https://developer.android.com/reference/android/media/AudioAttributes#CONTENT_TYPE_MUSIC
+     */
+    AndroidAudioContentType["Music"] = "music";
+    /**
+     * Content type value to use when the content type is speech.
+     *
+     * See https://developer.android.com/reference/android/media/AudioAttributes#CONTENT_TYPE_SPEECH
+     */
+    AndroidAudioContentType["Speech"] = "speech";
+    /**
+     * Content type value to use when the content type is a sound used to
+     * accompany a user action, such as a beep or sound effect expressing a key
+     * click, or event, such as the type of a sound for a bonus being received in
+     * a game. These sounds are mostly synthesized or short Foley sounds.
+     *
+     * See https://developer.android.com/reference/android/media/AudioAttributes#CONTENT_TYPE_SONIFICATION
+     */
+    AndroidAudioContentType["Sonification"] = "sonification";
+    /**
+     * Content type value to use when the content type is a soundtrack, typically
+     * accompanying a movie or TV program.
+     */
+    AndroidAudioContentType["Movie"] = "movie";
+    /**
+     * Content type value to use when the content type is unknown, or other than
+     * the ones defined.
+     *
+     * See https://developer.android.com/reference/android/media/AudioAttributes#CONTENT_TYPE_UNKNOWN
+     */
+    AndroidAudioContentType["Unknown"] = "unknown";
+})(AndroidAudioContentType || (AndroidAudioContentType = {}));

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

@@ -0,0 +1,10 @@
+/**
+ * Define Android Auto's content style. defualt is List. see
+ * https://developer.android.com/training/cars/media#apply_content_style
+ */
+export declare enum AndroidAutoContentStyle {
+    List = 0,
+    Grid = 1,
+    CategoryList = 2,
+    CategoryGrid = 3
+}

package/lib/src/constants/AndroidAutoContentStyle.js

@@ -0,0 +1,11 @@
+/**
+ * Define Android Auto's content style. defualt is List. see
+ * https://developer.android.com/training/cars/media#apply_content_style
+ */
+export var AndroidAutoContentStyle;
+(function (AndroidAutoContentStyle) {
+    AndroidAutoContentStyle[AndroidAutoContentStyle["List"] = 0] = "List";
+    AndroidAutoContentStyle[AndroidAutoContentStyle["Grid"] = 1] = "Grid";
+    AndroidAutoContentStyle[AndroidAutoContentStyle["CategoryList"] = 2] = "CategoryList";
+    AndroidAutoContentStyle[AndroidAutoContentStyle["CategoryGrid"] = 3] = "CategoryGrid";
+})(AndroidAutoContentStyle || (AndroidAutoContentStyle = {}));

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

@@ -0,0 +1,17 @@
+/**
+ * Define how the audio playback should behave to removing the app from recents (killing it). Default is `ContinuePlayback`.
+ */
+export declare enum AppKilledPlaybackBehavior {
+    /**
+     * This option will continue playing audio in the background when the app is removed from recents. The notification remains. This is the default.
+     */
+    ContinuePlayback = "continue-playback",
+    /**
+     * This option will pause playing audio in the background when the app is removed from recents. The notification remains and can be used to resume playback.
+     */
+    PausePlayback = "pause-playback",
+    /**
+     * This option will stop playing audio in the background when the app is removed from recents. The notification is removed and can't be used to resume playback. Users would need to open the app again to start playing audio.
+     */
+    StopPlaybackAndRemoveNotification = "stop-playback-and-remove-notification"
+}

package/lib/src/constants/AppKilledPlaybackBehavior.js

@@ -0,0 +1,18 @@
+/**
+ * Define how the audio playback should behave to removing the app from recents (killing it). Default is `ContinuePlayback`.
+ */
+export var AppKilledPlaybackBehavior;
+(function (AppKilledPlaybackBehavior) {
+    /**
+     * This option will continue playing audio in the background when the app is removed from recents. The notification remains. This is the default.
+     */
+    AppKilledPlaybackBehavior["ContinuePlayback"] = "continue-playback";
+    /**
+     * This option will pause playing audio in the background when the app is removed from recents. The notification remains and can be used to resume playback.
+     */
+    AppKilledPlaybackBehavior["PausePlayback"] = "pause-playback";
+    /**
+     * This option will stop playing audio in the background when the app is removed from recents. The notification is removed and can't be used to resume playback. Users would need to open the app again to start playing audio.
+     */
+    AppKilledPlaybackBehavior["StopPlaybackAndRemoveNotification"] = "stop-playback-and-remove-notification";
+})(AppKilledPlaybackBehavior || (AppKilledPlaybackBehavior = {}));

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

@@ -0,0 +1,17 @@
+export declare enum Capability {
+    Play,
+    PlayFromId,
+    PlayFromSearch,
+    Pause,
+    Stop,
+    SeekTo,
+    Skip,
+    SkipToNext,
+    SkipToPrevious,
+    JumpForward,
+    JumpBackward,
+    SetRating,
+    Like,
+    Dislike,
+    Bookmark
+}

package/lib/src/constants/Capability.js

@@ -0,0 +1,19 @@
+import { Constants as TrackPlayer } from '../../specs/NativeTrackPlayer';
+export var Capability;
+(function (Capability) {
+    Capability[Capability["Play"] = TrackPlayer.CAPABILITY_PLAY] = "Play";
+    Capability[Capability["PlayFromId"] = TrackPlayer.CAPABILITY_PLAY_FROM_ID] = "PlayFromId";
+    Capability[Capability["PlayFromSearch"] = TrackPlayer.CAPABILITY_PLAY_FROM_SEARCH] = "PlayFromSearch";
+    Capability[Capability["Pause"] = TrackPlayer.CAPABILITY_PAUSE] = "Pause";
+    Capability[Capability["Stop"] = TrackPlayer.CAPABILITY_STOP] = "Stop";
+    Capability[Capability["SeekTo"] = TrackPlayer.CAPABILITY_SEEK_TO] = "SeekTo";
+    Capability[Capability["Skip"] = TrackPlayer.CAPABILITY_SKIP] = "Skip";
+    Capability[Capability["SkipToNext"] = TrackPlayer.CAPABILITY_SKIP_TO_NEXT] = "SkipToNext";
+    Capability[Capability["SkipToPrevious"] = TrackPlayer.CAPABILITY_SKIP_TO_PREVIOUS] = "SkipToPrevious";
+    Capability[Capability["JumpForward"] = TrackPlayer.CAPABILITY_JUMP_FORWARD] = "JumpForward";
+    Capability[Capability["JumpBackward"] = TrackPlayer.CAPABILITY_JUMP_BACKWARD] = "JumpBackward";
+    Capability[Capability["SetRating"] = TrackPlayer.CAPABILITY_SET_RATING] = "SetRating";
+    Capability[Capability["Like"] = TrackPlayer.CAPABILITY_LIKE] = "Like";
+    Capability[Capability["Dislike"] = TrackPlayer.CAPABILITY_DISLIKE] = "Dislike";
+    Capability[Capability["Bookmark"] = TrackPlayer.CAPABILITY_BOOKMARK] = "Bookmark";
+})(Capability || (Capability = {}));

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

@@ -0,0 +1,172 @@
+export declare enum Event {
+    PlayerError = "player-error",
+    /** Fired when the state of the player changes. */
+    PlaybackState = "playback-state",
+    /** Fired when a playback error occurs. */
+    PlaybackError = "playback-error",
+    /** (Android Only) Fired when animated volume completed changing. */
+    PlaybackAnimatedVolumeChanged = "playback-animated-volume-changed",
+    /** Fired after playback has paused due to the queue having reached the end. */
+    PlaybackQueueEnded = "playback-queue-ended",
+    /**
+     * Fired when another track has become active or when there no longer is an
+     * active track.
+     *
+     * @deprecated use `playback-active-track-changed` instead.
+     **/
+    PlaybackTrackChanged = "playback-track-changed",
+    /**
+     * Fired when another track has become active or when there no longer is an
+     * active track.
+     **/
+    PlaybackActiveTrackChanged = "playback-active-track-changed",
+    /**
+     * Fired when the current track receives metadata encoded in. (e.g. ID3 tags,
+     * Icy Metadata, Vorbis Comments or QuickTime metadata).
+     * @deprecated use `AudioChapterMetadataReceived, AudioTimedMetadataReceived, AudioCommonMetadataReceived` instead.
+     **/
+    PlaybackMetadataReceived = "playback-metadata-received",
+    /**
+     * Fired when playback play when ready has changed.
+     **/
+    PlaybackPlayWhenReadyChanged = "playback-play-when-ready-changed",
+    /**
+     * Fired when playback progress has been updated.
+     * See https://rntp.dev/docs/api/events#playbackprogressupdated
+     **/
+    PlaybackProgressUpdated = "playback-progress-updated",
+    /**
+     * Android media3 playback resumption. most likely require a
+     * headless setup.
+     */
+    PlaybackResume = "playback-resume-android",
+    /**
+     * Fired when the user presses the play button.
+     * See https://rntp.dev/docs/api/events#remoteplay
+     **/
+    RemotePlay = "remote-play",
+    /**
+     * Fired when the user presses the play/pause button.
+     **/
+    RemotePlayPause = "remote-play-pause",
+    /**
+     * Fired when the user presses the pause button.
+     * See https://rntp.dev/docs/api/events#remotepause
+     **/
+    RemotePause = "remote-pause",
+    /**
+     * Fired when the user presses the stop button.
+     * See https://rntp.dev/docs/api/events#remotestop
+     **/
+    RemoteStop = "remote-stop",
+    /**
+     * Fired when the user presses the next track button.
+     * See https://rntp.dev/docs/api/events#remotenext
+     **/
+    RemoteNext = "remote-next",
+    /**
+     * Fired when the user presses the previous track button.
+     * See https://rntp.dev/docs/api/events#remoteprevious
+     **/
+    RemotePrevious = "remote-previous",
+    /**
+     * Fired when the user presses the jump forward button.
+     * See https://rntp.dev/docs/api/events#remotejumpforward
+     **/
+    RemoteJumpForward = "remote-jump-forward",
+    /**
+     * Fired when the user presses the jump backward button.
+     * See https://rntp.dev/docs/api/events#remotejumpbackward
+     **/
+    RemoteJumpBackward = "remote-jump-backward",
+    /**
+     * Fired when the user changes the position of the timeline.
+     * See https://rntp.dev/docs/api/events#remoteseek
+     **/
+    RemoteSeek = "remote-seek",
+    /**
+     * Fired when the user changes the rating for the track remotely.
+     * See https://rntp.dev/docs/api/events#remotesetrating
+     **/
+    RemoteSetRating = "remote-set-rating",
+    /**
+     * Fired when the app needs to handle an audio interruption.
+     * See https://rntp.dev/docs/api/events#remoteduck
+     **/
+    RemoteDuck = "remote-duck",
+    /**
+     * (iOS only) Fired when the user presses the like button in the now playing
+     * center.
+     * See https://rntp.dev/docs/api/events#remotelike-ios-only
+     **/
+    RemoteLike = "remote-like",
+    /**
+     * (iOS only) Fired when the user presses the dislike button in the now playing
+     * center.
+     * See https://rntp.dev/docs/api/events#remotedislike-ios-only
+     **/
+    RemoteDislike = "remote-dislike",
+    /** (iOS only) Fired when the user presses the bookmark button in the now
+     * playing center.
+     * See https://rntp.dev/docs/api/events#remotebookmark-ios-only
+     **/
+    RemoteBookmark = "remote-bookmark",
+    /**
+     * (Android only) Fired when the user selects a track from an external device.
+     * See https://rntp.dev/docs/api/events#remoteplayid
+     **/
+    RemotePlayId = "remote-play-id",
+    /**
+     * (Android only) Fired when the user searches for a track (usually voice search).
+     * See https://rntp.dev/docs/api/events#remoteplaysearch
+     **/
+    RemotePlaySearch = "remote-play-search",
+    /**
+     * (Android only) Fired when the user searches for content.
+     * See https://rntp.dev/docs/api/events#remotesearch
+     **/
+    RemoteSearch = "remote-search",
+    /**
+     * (Android only) Fired when the user presses the skip button.
+     * See https://rntp.dev/docs/api/events#remoteskip
+     **/
+    RemoteSkip = "remote-skip",
+    /**
+     * (Android only) Fired when the user enters a browsable children in android auto.
+     * See https://rntp.dev/docs/api/events#remoteBrowse
+     **/
+    RemoteBrowse = "remote-browse",
+    /**
+     * (Android only) Fired when a custom action button is pressed.
+     * See https://rntp.dev/docs/api/events#remoteCustomAction
+     **/
+    RemoteCustomAction = "remote-custom-action",
+    /** (iOS only) Fired when chapter metadata is received.
+     * See https://rntp.dev/docs/api/events#chaptermetadatareceived
+     **/
+    MetadataChapterReceived = "metadata-chapter-received",
+    /**
+     * Fired when metadata is received at a specific time in the audio.
+     * See https://rntp.dev/docs/api/events#timedmetadatareceived
+     **/
+    MetadataTimedReceived = "metadata-timed-received",
+    /**
+     * Fired when common (static) metadata is received.
+     * See https://rntp.dev/docs/api/events#commonmetadatareceived
+     **/
+    MetadataCommonReceived = "metadata-common-received",
+    /**
+     * Fired when an android connector connects to MusicService.
+     * typical controllers are media notification and Android Auto.
+     **/
+    connectorConnected = "android-controller-connected",
+    /**
+     * Fired when an android connector connects to MusicService.
+     * typical controllers are media notification and Android Auto.
+     **/
+    connectorDisconnected = "android-controller-disconnected",
+    /**
+     * Fired when there is an fft update
+     **/
+    fftUpdate = "fft-updated"
+}