Deprecate clearNowPlayingMetadata (#1909)

See #1653
doublesymmetry · Feb 6, 2023 · ddead98 · ddead98
1 parent 399f2b8
commit ddead98
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/trackPlayer.ts b/src/trackPlayer.ts
@@ -259,6 +259,11 @@ export async function updateMetadataForTrack(
   return TrackPlayer.updateMetadataForTrack(trackIndex, metadata);
 }
 
+/**
+ * @deprecated Nominated for removal in the next major version. If you object
+ * to this, please describe your use-case in the following issue:
+ * https://github.com/doublesymmetry/react-native-track-player/issues/1653
+ */
 export function clearNowPlayingMetadata(): Promise<void> {
   return TrackPlayer.clearNowPlayingMetadata();
 }