react-native-media3-player 0.0.1 → 1.0.0

package/android/build.gradle

@@ -1,37 +1,55 @@
+// Apply the Android library plugin
 apply plugin: "com.android.library"
+// Apply the Kotlin Android plugin for Kotlin language support
 apply plugin: "org.jetbrains.kotlin.android"
+// Apply the React Native plugin to enable React Native integration
+apply plugin: "com.facebook.react"
 
 android {
+    // Set the namespace for the generated R class and manifest
     namespace "com.rnmedia3playerdemo"
+
+    // Compile SDK version to build against
     compileSdkVersion 35
 
     defaultConfig {
+        // Minimum SDK version supported by the library
         minSdkVersion 24
+        // Target SDK version for compatibility and behaviors
         targetSdkVersion 34
     }
 
     compileOptions {
+        // Specify Java source and target compatibility
         sourceCompatibility JavaVersion.VERSION_17
         targetCompatibility JavaVersion.VERSION_17
     }
 
     kotlinOptions {
+        // Set the Kotlin JVM target version
         jvmTarget = "17"
     }
+
+    sourceSets {
+        main {
+            // Include codegen outputs (for TurboModules, Fabric, etc.) in the main sources
+            java.srcDirs += "${buildDir}/generated/source/codegen/java"
+        }
+    }
 }
 
 dependencies {
-    // Required for React Native bridge
-    implementation "com.facebook.react:react-native:+"
+    // Dependency for React Native bridge (provided by the app, NOT bundled in aar)
+    compileOnly "com.facebook.react:react-android"
 
-    // Kotlin standard lib
-    implementation "org.jetbrains.kotlin:kotlin-stdlib:1.8.0"
+    // Kotlin standard library dependency
+    implementation "org.jetbrains.kotlin:kotlin-stdlib"
 
-    // ✅ Media3 dependencies
+    // AndroidX Media3 ExoPlayer, UI components, and Common classes
     implementation "androidx.media3:media3-exoplayer:1.4.1"
     implementation "androidx.media3:media3-ui:1.4.1"
     implementation "androidx.media3:media3-common:1.4.1"
 
-    // Useful Android extensions
+    // Android core utilities and extensions (KTX)
     implementation "androidx.core:core-ktx:1.13.1"
 }

package/android/src/main/java/com/rnmedia3playerdemo/Media3Package.kt

@@ -2,13 +2,25 @@ package com.rnmedia3playerdemo
 
 import com.facebook.react.ReactPackage
 import com.facebook.react.bridge.NativeModule
-import com.facebook.react.uimanager.ViewManager
 import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.uimanager.ViewManager
 
+/**
+ * Media3Package integrates the custom Media3PlayerViewManager with React Native.
+ *
+ * This package does not register any NativeModules. It only provides the
+ * Media3PlayerViewManager for use as a native UI component from JavaScript.
+ */
 class Media3Package : ReactPackage {
-    override fun createNativeModules(reactContext: ReactApplicationContext): List<NativeModule> = emptyList()
+    /**
+     * No native modules are exported by this package.
+     */
+    override fun createNativeModules(reactContext: ReactApplicationContext): List<NativeModule> =
+        emptyList()
 
-    override fun createViewManagers(reactContext: ReactApplicationContext): List<ViewManager<*, *>> {
-        return listOf(Media3PlayerViewManager(reactContext))
-    }
+    /**
+     * Registers Media3PlayerViewManager as the only custom ViewManager for this package.
+     */
+    override fun createViewManagers(reactContext: ReactApplicationContext): List<ViewManager<*, *>> =
+        listOf(Media3PlayerViewManager())
 }

package/android/src/main/java/com/rnmedia3playerdemo/Media3PlayerView.kt

@@ -9,26 +9,32 @@ import androidx.media3.common.Player
 import androidx.media3.common.PlaybackException
 import androidx.media3.exoplayer.ExoPlayer
 import androidx.media3.ui.PlayerView
-import com.facebook.react.bridge.ReactContext
-import com.facebook.react.uimanager.events.RCTEventEmitter
 import com.facebook.react.bridge.Arguments
+import com.facebook.react.bridge.ReactContext
+import com.facebook.react.bridge.WritableMap
+import com.facebook.react.uimanager.UIManagerHelper
+import com.facebook.react.uimanager.events.Event
 
 /**
- * Media3PlayerView
- *
- * Handles ExoPlayer playback and exposes events to React Native:
- * - onReady
- * - onEnd
- * - onError
+ * Custom view that wraps ExoPlayer and PlayerView, integrating with React Native.
  */
 class Media3PlayerView(context: Context) : FrameLayout(context) {
+    // ExoPlayer instance to handle media playback
     private var exoPlayer: ExoPlayer? = null
+    // PlayerView to display video content
     private var playerView: PlayerView
+    // Currently loaded media source URI
     private var sourceUri: String? = null
+    // Should video autoplay when ready
     private var autoplay: Boolean = false
+    // Play state controlled by the JS prop
     private var play: Boolean = false
+    // Mute state controlled by the JS prop
     private var mute: Boolean = false
 
+    /**
+     * Constructor: initialize the PlayerView and attach it to the layout.
+     */
     init {
         playerView = PlayerView(context)
         playerView.layoutParams = LayoutParams(
@@ -38,16 +44,23 @@ class Media3PlayerView(context: Context) : FrameLayout(context) {
         addView(playerView)
     }
 
+    /**
+     * Initializes ExoPlayer and attaches a listener for player events.
+     * Ensures only one instance exists.
+     */
     private fun initializePlayer() {
         if (exoPlayer == null) {
             exoPlayer = ExoPlayer.Builder(context).build()
             playerView.player = exoPlayer
 
+            // Listen for playback state changes and errors
             exoPlayer?.addListener(object : Player.Listener {
                 override fun onPlaybackStateChanged(state: Int) {
                     when (state) {
                         Player.STATE_READY -> {
-                            sendEvent("onReady")
+                            // Notify React Native that player is ready
+                            sendEvent("topReady")
+                            // If autoplay is enabled, start playback when ready
                             if (autoplay) {
                                 exoPlayer?.playWhenReady = true
                                 exoPlayer?.play()
@@ -55,62 +68,105 @@ class Media3PlayerView(context: Context) : FrameLayout(context) {
                             }
                         }
                         Player.STATE_ENDED -> {
-                            sendEvent("onEnd")
+                            // Notify React Native that playback has ended
+                            sendEvent("topEnd")
                         }
                     }
                 }
 
                 override fun onPlayerError(error: PlaybackException) {
-                    sendEvent("onError", error.message ?: "Unknown error")
+                    // Report playback errors to React Native
+                    sendEvent("topError", error.message ?: "Unknown error")
                 }
             })
         }
     }
 
+    /**
+     * Sets the video source from a URI string and prepares the player.
+     * @param uriString Video source URI as a string
+     */
     fun setSource(uriString: String?) {
         if (uriString.isNullOrEmpty()) return
         sourceUri = uriString
 
+        // Ensure player is initialized
         initializePlayer()
 
+        // Set and prepare the media item for playback
         val item = MediaItem.fromUri(Uri.parse(uriString))
         exoPlayer?.setMediaItem(item)
         exoPlayer?.prepare()
     }
 
+    /**
+     * Sets the autoplay flag to control whether playback starts when player is ready.
+     * @param value Boolean value from JS prop
+     */
     fun setAutoplay(value: Boolean) {
         autoplay = value
     }
 
+    /**
+     * Set the play state of the player.
+     * If true, the player will start/resume playback; otherwise, pause.
+     * @param value Boolean value from JS prop
+     */
     fun setPlay(value: Boolean) {
         play = value
-        // if you want to disable autoplay with play (prop) -
-        // if (exoPlayer?.playbackState == Player.STATE_READY)
-            if (play) {
-                exoPlayer?.play()
-            } else {
-                exoPlayer?.pause()
-            }
-        // }
+        // Optionally: Disabling autoplay if play is used directly
+        // Only play or pause if player is ready
+        if (play) {
+            exoPlayer?.play()
+        } else {
+            exoPlayer?.pause()
+        }
     }
 
+    /**
+     * Sets the mute state of the player.
+     * @param value Boolean indicating if the audio should be muted
+     */
     fun setMute(value: Boolean) {
         mute = value
         exoPlayer?.volume = if (mute) 0f else 1f
     }
 
+    /**
+     * Releases the player and cleans up resources.
+     * This should be called when the view is destroyed.
+     */
     fun releasePlayer() {
         exoPlayer?.release()
         exoPlayer = null
     }
 
-    // 👇 helper function to send events to React Native
+    /**
+     * Helper function to send events and optional data payloads to React Native JS side.
+     * @param eventName Name of the event (e.g., "topReady", "topError")
+     * @param message Optional message string to pass in the event payload
+     */
     private fun sendEvent(eventName: String, message: String? = null) {
         val reactContext = context as? ReactContext ?: return
-        val event = Arguments.createMap()
-        message?.let { event.putString("message", it) }
-        reactContext
-            .getJSModule(RCTEventEmitter::class.java)
-            .receiveEvent(id, eventName, event)
+        val surfaceId = UIManagerHelper.getSurfaceId(this)
+        val eventDispatcher = UIManagerHelper.getEventDispatcherForReactTag(reactContext, id)
+        val payload = Arguments.createMap()
+        message?.let { payload.putString("message", it) }
+        eventDispatcher?.dispatchEvent(
+            Media3Event(surfaceId, id, eventName, payload)
+        )
+    }
+
+    /**
+     * Custom event class to bridge native events to React Native UIManager system.
+     */
+    private class Media3Event(
+        surfaceId: Int,
+        viewId: Int,
+        private val name: String,
+        private val payload: WritableMap
+    ) : Event<Media3Event>(surfaceId, viewId) {
+        override fun getEventName(): String = name
+        override fun getEventData(): WritableMap = payload
     }
 }

package/android/src/main/java/com/rnmedia3playerdemo/Media3PlayerViewManager.kt

@@ -1,61 +1,106 @@
 package com.rnmedia3playerdemo
 
-import com.facebook.react.bridge.ReactApplicationContext
 import com.facebook.react.bridge.ReadableMap
+import com.facebook.react.module.annotations.ReactModule
 import com.facebook.react.uimanager.SimpleViewManager
 import com.facebook.react.uimanager.ThemedReactContext
+import com.facebook.react.uimanager.ViewManagerDelegate
 import com.facebook.react.uimanager.annotations.ReactProp
+import com.facebook.react.viewmanagers.Media3PlayerViewManagerDelegate
+import com.facebook.react.viewmanagers.Media3PlayerViewManagerInterface
 
 /**
- * Media3PlayerViewManager
- *
- * Exposes the native view to React Native.
- * Props: source { uri: string }, autoplay, play, mute
- * Events: onReady, onEnd, onError
+ * ViewManager for the custom Media3PlayerView.
+ * Responsible for creating the view, handling props from JS, and managing events.
  */
-class Media3PlayerViewManager(private val reactContext: ReactApplicationContext) :
-    SimpleViewManager<Media3PlayerView>() {
+@ReactModule(name = Media3PlayerViewManager.NAME)
+class Media3PlayerViewManager :
+    SimpleViewManager<Media3PlayerView>(),
+    Media3PlayerViewManagerInterface<Media3PlayerView> {
 
-    override fun getName(): String = "Media3PlayerView"
+    companion object {
+        // The name used to reference this view manager from JS
+        const val NAME = "Media3PlayerView"
+    }
+
+    // Delegate handles communication and prop mapping automatically when generated by Codegen
+    private val delegate = Media3PlayerViewManagerDelegate(this)
+
+    /**
+     * Returns the delegate instance for prop/event mapping.
+     */
+    override fun getDelegate(): ViewManagerDelegate<Media3PlayerView> = delegate
+
+    /**
+     * Returns the unique name for this ViewManager, used by React Native.
+     */
+    override fun getName(): String = NAME
 
+    /**
+     * Creates and returns a new Media3PlayerView instance for this ViewManager.
+     * @param reactContext ThemedReactContext provided by React Native
+     */
     override fun createViewInstance(reactContext: ThemedReactContext): Media3PlayerView {
         return Media3PlayerView(reactContext)
     }
 
+    /**
+     * Sets the "source" property on the Media3PlayerView.
+     * Reads the "uri" string from the passed ReadableMap and loads it into the native view.
+     */
     @ReactProp(name = "source")
-    fun setSource(view: Media3PlayerView, source: ReadableMap?) {
-        val uri: String? = source?.getString("uri")
+    override fun setSource(view: Media3PlayerView, source: ReadableMap?) {
+        val uri = source?.getString("uri")
         if (!uri.isNullOrEmpty()) {
             view.setSource(uri)
         }
     }
 
+    /**
+     * Sets the "autoplay" property on the Media3PlayerView.
+     * Controls whether playback should start automatically when ready.
+     */
     @ReactProp(name = "autoplay", defaultBoolean = false)
-    fun setAutoplay(view: Media3PlayerView, autoplay: Boolean) {
-        view.setAutoplay(autoplay)
+    override fun setAutoplay(view: Media3PlayerView, value: Boolean) {
+        view.setAutoplay(value)
     }
 
+    /**
+     * Sets the "play" property on the Media3PlayerView.
+     * Controls whether the player should be playing or paused.
+     */
     @ReactProp(name = "play", defaultBoolean = false)
-    fun setPlay(view: Media3PlayerView, play: Boolean) {
-        view.setPlay(play)
+    override fun setPlay(view: Media3PlayerView, value: Boolean) {
+        view.setPlay(value)
     }
 
+    /**
+     * Sets the "mute" property on the Media3PlayerView.
+     * Controls whether the audio should be muted.
+     */
     @ReactProp(name = "mute", defaultBoolean = false)
-    fun setMute(view: Media3PlayerView, mute: Boolean) {
-        view.setMute(mute)
+    override fun setMute(view: Media3PlayerView, value: Boolean) {
+        view.setMute(value)
     }
 
+    /**
+     * Called when the React Native view instance is about to be dropped/remounted.
+     * Ensures resources are released to avoid leaks.
+     */
     override fun onDropViewInstance(view: Media3PlayerView) {
         super.onDropViewInstance(view)
         view.releasePlayer()
     }
 
-    // 👇 Expose custom events to JS
+    /**
+     * Exports native direct event types to React Native for event binding in JS.
+     * Maps native event names to the registration name expected by React.
+     */
     override fun getExportedCustomDirectEventTypeConstants(): MutableMap<String, Any> {
         return mutableMapOf(
-            "onReady" to mapOf("registrationName" to "onReady"),
-            "onEnd" to mapOf("registrationName" to "onEnd"),
-            "onError" to mapOf("registrationName" to "onError")
+            "topReady" to mapOf("registrationName" to "onReady"),
+            "topEnd" to mapOf("registrationName" to "onEnd"),
+            "topError" to mapOf("registrationName" to "onError")
         )
     }
 }

package/index.d.ts

@@ -1,15 +1,16 @@
-import { ViewStyle } from 'react-native';
 import * as React from 'react';
+import {ViewStyle} from 'react-native';
 
 export interface Media3PlayerProps {
   style?: ViewStyle | ViewStyle[];
-  source: { uri: string };
+  source: {uri: string};
   autoplay?: boolean;
   play?: boolean;
   mute?: boolean;
   onReady?: () => void;
   onEnd?: () => void;
-  onError?: (error: any) => void;
+  onError?: (event: {nativeEvent: {message: string}}) => void;
 }
 
-export default class Media3Player extends React.Component<Media3PlayerProps> {}
+declare const Media3Player: React.FC<Media3PlayerProps>;
+export default Media3Player;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "react-native-media3-player",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "React Native Media3 Player component for Android (ExoPlayer 3 integration).",
   "main": "index.js",
+  "react-native": "index.js",
   "types": "index.d.ts",
   "keywords": [
     "react-native",
@@ -31,5 +32,13 @@
     "src",
     "index.js",
     "index.d.ts"
-  ]
+  ],
+  "codegenConfig": {
+    "name": "RNMedia3PlayerSpec",
+    "type": "components",
+    "jsSrcsDir": "src",
+    "android": {
+      "javaPackageName": "com.rnmedia3playerdemo"
+    }
+  }
 }

package/src/Media3Player.js

@@ -1,20 +1,20 @@
 import React from 'react';
-import {requireNativeComponent, StyleSheet} from 'react-native';
-
-// Link to native view
-const NativeMedia3Player = requireNativeComponent('Media3PlayerView');
+import {StyleSheet} from 'react-native';
+// Import the native codegen-wrapped player view component
+import NativeMedia3PlayerView from './Media3PlayerNativeComponent';
 
 /**
- * Media3Player
+ * Media3Player React component
  *
  * Props:
- * - source: { uri: string } ✅ required
- * - autoplay: boolean
- * - play: boolean
- * - mute: boolean
- * - onReady: function
- * - onEnd: function
- * - onError: function
+ * - style: (optional) additional style overrides
+ * - source: { uri: string } – required, the media URI to load
+ * - autoplay: (optional, default false) – whether playback should start automatically when ready
+ * - play: (optional, default false) – whether playback should currently be running (true = play, false = pause)
+ * - mute: (optional, default false) – whether audio should be muted
+ * - onReady: callback when player is ready
+ * - onEnd: callback when playback has ended
+ * - onError: callback when an error occurs during playback or loading
  */
 export default function Media3Player({
   style,
@@ -26,14 +26,16 @@ export default function Media3Player({
   onEnd,
   onError,
 }) {
+  // Validate that source.uri is provided; warn and render nothing if missing
   if (!source || !source.uri) {
-    console.warn('Media3Player: "source" prop with a valid "uri" is required.');
+    console.warn('Media3Player: "source.uri" is required.');
     return null;
   }
 
+  // Render the native player view, passing all relevant props and composing the style
   return (
-    <NativeMedia3Player
-      style={[styles.default, style]} // ensure style is never undefined
+    <NativeMedia3PlayerView
+      style={[styles.default, style]}
       source={source}
       autoplay={autoplay}
       play={play}
@@ -45,10 +47,11 @@ export default function Media3Player({
   );
 }
 
+// Default styling applied to the player view unless overridden via 'style' prop
 const styles = StyleSheet.create({
   default: {
-    width: '100%',
-    height: 250,
-    backgroundColor: 'black',
+    width: '100%', // Occupy full width of parent
+    height: 250, // Fixed height for the player
+    backgroundColor: 'black', // Default background color
   },
 });

package/src/Media3PlayerNativeComponent.ts

@@ -0,0 +1,37 @@
+// Import the base ViewProps type from React Native to extend the native component's props
+import type {ViewProps} from 'react-native';
+// Import the DirectEventHandler type used for native-to-JS event callback typings
+import type {DirectEventHandler} from 'react-native/Libraries/Types/CodegenTypes';
+// Import codegenNativeComponent to register the native UI component for use in React Native
+import codegenNativeComponent from 'react-native/Libraries/Utilities/codegenNativeComponent';
+
+// Event type emitted when the player is ready
+type OnReadyEvent = Readonly<{}>;
+// Event type emitted when playback reaches the end
+type OnEndEvent = Readonly<{}>;
+// Event type emitted when an error occurs during playback
+type OnErrorEvent = Readonly<{
+  message: string; // Error message describing what went wrong
+}>;
+
+// Props supported by the native Media3PlayerView component
+export interface NativeProps extends ViewProps {
+  // Source URI for the media to play
+  source?: Readonly<{uri: string}>;
+  // Whether playback should start automatically when ready
+  autoplay?: boolean;
+  // Whether playback should currently be running (true = play, false = pause)
+  play?: boolean;
+  // Whether audio should be muted
+  mute?: boolean;
+
+  // Callback invoked when the player is ready to play
+  onReady?: DirectEventHandler<OnReadyEvent>;
+  // Callback invoked when playback reaches the end of the media
+  onEnd?: DirectEventHandler<OnEndEvent>;
+  // Callback invoked when an error occurs in playback or loading
+  onError?: DirectEventHandler<OnErrorEvent>;
+}
+
+// Create and export the code-generated native component using the props interface
+export default codegenNativeComponent<NativeProps>('Media3PlayerView');