Update references to rntp.dev for docs

dcvz · dcvz · commit 602d5459ec65 · 2026-03-09T20:35:22.000+01:00
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-<img src="https:/rntp.dev/img/optimized-logo.svg" width="300" />
+<img src="https://doublesymmetry.github.io/react-native-track-player/img/optimized-logo.svg" width="300" />
 
 [![downloads](https://img.shields.io/npm/dw/react-native-track-player.svg)](https://www.npmjs.com/package/react-native-track-player)
 [![npm](https://img.shields.io/npm/v/react-native-track-player.svg)](https://www.npmjs.com/package/react-native-track-player)
@@ -25,14 +25,14 @@ _[Blaze](https://runblaze.dev) sponsors RNTP by providing super fast Apple Silic
 
 ## Overview
 
-- [Documentation](https://rntp.dev)
-  * [Installation](https://rntp.dev/docs/basics/installation/)
-  * [Getting Started](https://rntp.dev/docs/basics/getting-started/)
-  * [API Docs](https://rntp.dev/docs/api/events)
-  * [Platform Support](https://rntp.dev/docs/basics/platform-support)
-  * [Background Mode](https://rntp.dev/docs/basics/background-mode)
-  * [Build Preferences](https://rntp.dev/docs/basics/build-preferences)
-  * [v2 Migration Guide](https://rntp.dev/docs/v2-migration)
+- [Documentation](https://doublesymmetry.github.io/react-native-track-player/)
+  * [Installation](https://doublesymmetry.github.io/react-native-track-player/docs/basics/installation/)
+  * [Getting Started](https://doublesymmetry.github.io/react-native-track-player/docs/basics/getting-started/)
+  * [API Docs](https://doublesymmetry.github.io/react-native-track-player/docs/api/events)
+  * [Platform Support](https://doublesymmetry.github.io/react-native-track-player/docs/basics/platform-support)
+  * [Background Mode](https://doublesymmetry.github.io/react-native-track-player/docs/basics/background-mode)
+  * [Build Preferences](https://doublesymmetry.github.io/react-native-track-player/docs/basics/build-preferences)
+  * [v2 Migration Guide](https://doublesymmetry.github.io/react-native-track-player/docs/v2-migration)
 - [Sponsors](#sponsors)
 - [Features](#features)
 - [Why another music module?](#why-another-music-module)
@@ -44,8 +44,8 @@ _[Blaze](https://runblaze.dev) sponsors RNTP by providing super fast Apple Silic
 
 Not sure where to start?
 
-1. Try [Getting Started](https://rntp.dev/docs/basics/getting-started).
-2. Peruse the [API Docs](https://rntp.dev/docs/api/events).
+1. Try [Getting Started](https://doublesymmetry.github.io/react-native-track-player/docs/basics/getting-started).
+2. Peruse the [API Docs](https://doublesymmetry.github.io/react-native-track-player/docs/api/events).
 3. Run the [Example Project](/example).
 
 ## Commerical Usage
@@ -78,7 +78,7 @@ All audio modules (like `react-native-sound`) don't play in a separated service
 
 ## Example Setup
 
-First please take a look at the [Getting Started](https://rntp.dev/docs/basics/getting-started/) guide, but a basic example of how to play a track:
+First please take a look at the [Getting Started](https://doublesymmetry.github.io/react-native-track-player/docs/basics/getting-started/) guide, but a basic example of how to play a track:
 
 ```javascript
 import TrackPlayer from 'react-native-track-player';
diff --git a/docs/docs/basics/getting-started.md b/docs/docs/basics/getting-started.md
@@ -69,7 +69,7 @@ const track3 = {
     duration: 411
 };
 
-// You can then [add](https://rntp.dev/docs/api/functions/queue#addtracks-insertbeforeindex) the items to the queue
+// You can then [add](https://doublesymmetry.github.io/react-native-track-player/docs/api/functions/queue#addtracks-insertbeforeindex) the items to the queue
 await TrackPlayer.add([track1, track2, track3]);
 ```
 
diff --git a/docs/static/CNAME b/docs/static/CNAME
diff --git a/docs/versioned_docs/version-2.1/basics/getting-started.md b/docs/versioned_docs/version-2.1/basics/getting-started.md
@@ -69,7 +69,7 @@ const track3 = {
     duration: 411
 };
 
-// You can then [add](https://rntp.dev/docs/api/functions/queue#addtracks-insertbeforeindex) the items to the queue
+// You can then [add](https://doublesymmetry.github.io/react-native-track-player/docs/api/functions/queue#addtracks-insertbeforeindex) the items to the queue
 await TrackPlayer.add([track1, track2, track3]);
 ```
 
diff --git a/docs/versioned_docs/version-3.1/basics/getting-started.md b/docs/versioned_docs/version-3.1/basics/getting-started.md
@@ -69,7 +69,7 @@ const track3 = {
     duration: 411
 };
 
-// You can then [add](https://rntp.dev/docs/api/functions/queue#addtracks-insertbeforeindex) the items to the queue
+// You can then [add](https://doublesymmetry.github.io/react-native-track-player/docs/api/functions/queue#addtracks-insertbeforeindex) the items to the queue
 await TrackPlayer.add([track1, track2, track3]);
 ```
 
diff --git a/docs/versioned_docs/version-3.2/basics/getting-started.md b/docs/versioned_docs/version-3.2/basics/getting-started.md
@@ -69,7 +69,7 @@ const track3 = {
     duration: 411
 };
 
-// You can then [add](https://rntp.dev/docs/api/functions/queue#addtracks-insertbeforeindex) the items to the queue
+// You can then [add](https://doublesymmetry.github.io/react-native-track-player/docs/api/functions/queue#addtracks-insertbeforeindex) the items to the queue
 await TrackPlayer.add([track1, track2, track3]);
 ```
 
diff --git a/docs/versioned_docs/version-4.0/basics/getting-started.md b/docs/versioned_docs/version-4.0/basics/getting-started.md
@@ -69,7 +69,7 @@ const track3 = {
     duration: 411
 };
 
-// You can then [add](https://rntp.dev/docs/api/functions/queue#addtracks-insertbeforeindex) the items to the queue
+// You can then [add](https://doublesymmetry.github.io/react-native-track-player/docs/api/functions/queue#addtracks-insertbeforeindex) the items to the queue
 await TrackPlayer.add([track1, track2, track3]);
 ```
 
diff --git a/docs/versioned_docs/version-4.1/basics/getting-started.md b/docs/versioned_docs/version-4.1/basics/getting-started.md
@@ -69,7 +69,7 @@ const track3 = {
     duration: 411
 };
 
-// You can then [add](https://rntp.dev/docs/api/functions/queue#addtracks-insertbeforeindex) the items to the queue
+// You can then [add](https://doublesymmetry.github.io/react-native-track-player/docs/api/functions/queue#addtracks-insertbeforeindex) the items to the queue
 await TrackPlayer.add([track1, track2, track3]);
 ```
 
diff --git a/docs/versioned_docs/version-5.0/basics/getting-started.md b/docs/versioned_docs/version-5.0/basics/getting-started.md
@@ -69,7 +69,7 @@ const track3 = {
     duration: 411
 };
 
-// You can then [add](https://rntp.dev/docs/api/functions/queue#addtracks-insertbeforeindex) the items to the queue
+// You can then [add](https://doublesymmetry.github.io/react-native-track-player/docs/api/functions/queue#addtracks-insertbeforeindex) the items to the queue
 await TrackPlayer.add([track1, track2, track3]);
 ```
 
diff --git a/src/constants/Event.ts b/src/constants/Event.ts
@@ -18,7 +18,7 @@ export enum Event {
   PlaybackPlayWhenReadyChanged = 'playback-play-when-ready-changed',
   /**
    * Fired when playback progress has been updated.
-   * See https://rntp.dev/docs/api/events#playbackprogressupdated
+   * See https://doublesymmetry.github.io/react-native-track-player/docs/api/events#playbackprogressupdated
    **/
   PlaybackProgressUpdated = 'playback-progress-updated',
   /**
@@ -28,7 +28,7 @@ export enum Event {
   PlaybackResume = 'android-playback-resume',
   /**
    * Fired when the user presses the play button.
-   * See https://rntp.dev/docs/api/events#remoteplay
+   * See https://doublesymmetry.github.io/react-native-track-player/docs/api/events#remoteplay
    **/
   RemotePlay = 'remote-play',
   /**
@@ -37,93 +37,93 @@ export enum Event {
   RemotePlayPause = 'remote-play-pause',
   /**
    * Fired when the user presses the pause button.
-   * See https://rntp.dev/docs/api/events#remotepause
+   * See https://doublesymmetry.github.io/react-native-track-player/docs/api/events#remotepause
    **/
   RemotePause = 'remote-pause',
   /**
    * Fired when the user presses the stop button.
-   * See https://rntp.dev/docs/api/events#remotestop
+   * See https://doublesymmetry.github.io/react-native-track-player/docs/api/events#remotestop
    **/
   RemoteStop = 'remote-stop',
   /**
    * Fired when the user presses the next track button.
-   * See https://rntp.dev/docs/api/events#remotenext
+   * See https://doublesymmetry.github.io/react-native-track-player/docs/api/events#remotenext
    **/
   RemoteNext = 'remote-next',
   /**
    * Fired when the user presses the previous track button.
-   * See https://rntp.dev/docs/api/events#remoteprevious
+   * See https://doublesymmetry.github.io/react-native-track-player/docs/api/events#remoteprevious
    **/
   RemotePrevious = 'remote-previous',
   /**
    * Fired when the user presses the jump forward button.
-   * See https://rntp.dev/docs/api/events#remotejumpforward
+   * See https://doublesymmetry.github.io/react-native-track-player/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
+   * See https://doublesymmetry.github.io/react-native-track-player/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
+   * See https://doublesymmetry.github.io/react-native-track-player/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
+   * See https://doublesymmetry.github.io/react-native-track-player/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
+   * See https://doublesymmetry.github.io/react-native-track-player/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
+   * See https://doublesymmetry.github.io/react-native-track-player/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
+   * See https://doublesymmetry.github.io/react-native-track-player/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
+   * See https://doublesymmetry.github.io/react-native-track-player/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
+   * See https://doublesymmetry.github.io/react-native-track-player/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
+   * See https://doublesymmetry.github.io/react-native-track-player/docs/api/events#remoteplaysearch
    **/
   RemotePlaySearch = 'remote-play-search',
   /**
    * (Android only) Fired when the user presses the skip button.
-   * See https://rntp.dev/docs/api/events#remoteskip
+   * See https://doublesymmetry.github.io/react-native-track-player/docs/api/events#remoteskip
    **/
   RemoteSkip = 'remote-skip',
   /** (iOS only) Fired when chapter metadata is received.
-   * See https://rntp.dev/docs/api/events#chaptermetadatareceived
+   * See https://doublesymmetry.github.io/react-native-track-player/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
+   * See https://doublesymmetry.github.io/react-native-track-player/docs/api/events#timedmetadatareceived
    **/
   MetadataTimedReceived = 'metadata-timed-received',
   /**
    * Fired when common (static) metadata is received.
-   * See https://rntp.dev/docs/api/events#commonmetadatareceived
+   * See https://doublesymmetry.github.io/react-native-track-player/docs/api/events#commonmetadatareceived
    **/
   MetadataCommonReceived = 'metadata-common-received',
   /**
diff --git a/src/hooks/useTrackPlayerEvents.ts b/src/hooks/useTrackPlayerEvents.ts
@@ -31,7 +31,7 @@ export const useTrackPlayerEvents = <
           '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'
+            'https://doublesymmetry.github.io/react-native-track-player/docs/api/events'
         );
       }
     }
diff --git a/src/interfaces/Progress.ts b/src/interfaces/Progress.ts
@@ -1,11 +1,11 @@
 export interface Progress {
   /**
    * The playback position of the current track in seconds.
-   * See https://rntp.dev/docs/api/functions/player#getposition
+   * See https://doublesymmetry.github.io/react-native-track-player/docs/api/functions/player#getposition
    **/
   position: number;
   /** The duration of the current track in seconds.
-   * See https://rntp.dev/docs/api/functions/player#getduration
+   * See https://doublesymmetry.github.io/react-native-track-player/docs/api/functions/player#getduration
    **/
   duration: number;
   /**
diff --git a/src/interfaces/events/RemoteJumpBackwardEvent.ts b/src/interfaces/events/RemoteJumpBackwardEvent.ts
@@ -1,7 +1,7 @@
 export interface RemoteJumpBackwardEvent {
   /**
    * The number of seconds to jump backward.
-   * See https://rntp.dev/docs/api/events#remotejumpbackward
+   * See https://doublesymmetry.github.io/react-native-track-player/docs/api/events#remotejumpbackward
    **/
   interval: number;
 }
diff --git a/src/interfaces/events/RemoteJumpForwardEvent.ts b/src/interfaces/events/RemoteJumpForwardEvent.ts
@@ -1,7 +1,7 @@
 export interface RemoteJumpForwardEvent {
   /**
    * The number of seconds to jump forward.
-   * See https://rntp.dev/docs/api/events#remotejumpforward
+   * See https://doublesymmetry.github.io/react-native-track-player/docs/api/events#remotejumpforward
    **/
   interval: number;
 }
diff --git a/src/trackPlayer.ts b/src/trackPlayer.ts
@@ -49,7 +49,7 @@ function resolveTrackAssets(track: AddTrack) {
  * Initializes the player with the specified options.
  *
  * @param options The options to initialize the player with.
- * @see https://rntp.dev/docs/api/functions/lifecycle
+ * @see https://doublesymmetry.github.io/react-native-track-player/docs/api/functions/lifecycle
  */
 export async function setupPlayer(options: PlayerOptions = {}): Promise<void> {
   return TrackPlayer.setupPlayer(options);
@@ -200,7 +200,7 @@ export async function skipToPrevious(initialPosition = -1): Promise<void> {
  * Updates the configuration for the components.
  *
  * @param options The options to update.
- * @see https://rntp.dev/docs/api/functions/player#updateoptionsoptions
+ * @see https://doublesymmetry.github.io/react-native-track-player/docs/api/functions/player#updateoptionsoptions
  */
 export async function updateOptions(
   options: UpdateOptions = {}
@@ -332,7 +332,7 @@ export async function setRate(rate: number): Promise<void> {
  * Sets the queue.
  *
  * @param tracks The tracks to set as the queue.
- * @see https://rntp.dev/docs/api/constants/repeat-mode
+ * @see https://doublesymmetry.github.io/react-native-track-player/docs/api/constants/repeat-mode
  */
 export async function setQueue(tracks: Track[]): Promise<void> {
   return TrackPlayer.setQueue(tracks);
@@ -342,7 +342,7 @@ export async function setQueue(tracks: Track[]): Promise<void> {
  * Sets the queue repeat mode.
  *
  * @param repeatMode The repeat mode to set.
- * @see https://rntp.dev/docs/api/constants/repeat-mode
+ * @see https://doublesymmetry.github.io/react-native-track-player/docs/api/constants/repeat-mode
  */
 export async function setRepeatMode(mode: RepeatMode): Promise<RepeatMode> {
   return TrackPlayer.setRepeatMode(mode);
@@ -410,7 +410,7 @@ export async function getProgress(): Promise<Progress> {
 /**
  * Gets the playback state of the player.
  *
- * @see https://rntp.dev/docs/api/constants/state
+ * @see https://doublesymmetry.github.io/react-native-track-player/docs/api/constants/state
  */
 export async function getPlaybackState(): Promise<PlaybackState> {
   return (await TrackPlayer.getPlaybackState()) as PlaybackState;
@@ -419,7 +419,7 @@ export async function getPlaybackState(): Promise<PlaybackState> {
 /**
  * Gets the queue repeat mode.
  *
- * @see https://rntp.dev/docs/api/constants/repeat-mode
+ * @see https://doublesymmetry.github.io/react-native-track-player/docs/api/constants/repeat-mode
  */
 export async function getRepeatMode(): Promise<RepeatMode> {
   return TrackPlayer.getRepeatMode();
