react-native-nitro-player 1.5.1-alpha.0 → 1.6.0-alpha.0

package/src/hooks/useTimedMetadata.ts

@@ -0,0 +1,25 @@
+import { useEffect, useState } from 'react'
+import { callbackManager } from './callbackManager'
+import type { TimedMetadata } from '../types/PlayerQueue'
+
+/**
+ * Hook to subscribe to in-stream (timed) metadata — ICY/Shoutcast StreamTitle
+ * updates and ID3 frames emitted while a live stream plays.
+ *
+ * @returns The most recent metadata, or undefined until the first event arrives
+ *
+ * @example
+ * ```tsx
+ * function NowPlayingFromStream() {
+ *   const metadata = useTimedMetadata()
+ *   return <Text>{metadata?.title ?? 'Live'}</Text>
+ * }
+ * ```
+ */
+export function useTimedMetadata(): TimedMetadata | undefined {
+  const [metadata, setMetadata] = useState<TimedMetadata | undefined>(undefined)
+
+  useEffect(() => callbackManager.subscribeToTimedMetadata(setMetadata), [])
+
+  return metadata
+}

package/src/specs/TrackPlayer.nitro.ts

@@ -7,6 +7,7 @@ import type {
   PlayerState,
   PlayerConfig,
   Playlist,
+  TimedMetadata,
 } from '../types/PlayerQueue'
 
 export interface PlayerQueue extends HybridObject<{
@@ -96,6 +97,11 @@ export interface TrackPlayer extends HybridObject<{
       isManuallySeeked?: boolean
     ) => void
   ): void
+  /**
+   * Register callback for in-stream (timed) metadata — ICY/Shoutcast StreamTitle
+   * updates and ID3 frames emitted while a live stream plays.
+   */
+  onTimedMetadata(callback: (metadata: TimedMetadata) => void): void
   onAndroidAutoConnectionChange(callback: (connected: boolean) => void): void
   isAndroidAutoConnected(): boolean
   setVolume(volume: number): Promise<void>

package/src/types/PlayerQueue.ts

@@ -40,6 +40,14 @@ export interface PlayerState {
   currentPlayingType: CurrentPlayingType
 }
 
+/** In-stream metadata emitted while a stream plays (ICY/Shoutcast StreamTitle, ID3 frames) */
+export interface TimedMetadata {
+  title?: string
+  artist?: string
+  album?: string
+  artworkUrl?: string
+}
+
 export interface PlayerConfig {
   androidAutoEnabled?: boolean
   carPlayEnabled?: boolean