react-native-create-thumbnail

Before building the app, you must start Metro, the JavaScript build tool for React Native. Run the following command from the root of the project:

# Using npm
npm start

# OR using Yarn
yarn start

If you intend to publish this library as a Maven dependency, you must complete these steps before publishing a new version to npm:

1. Ensure the Android SDK and NDK are installed on your system.
2. Create or update a local.properties file in the android directory to point to your Android SDK and NDK locations.
3. Delete the existing maven folder to ensure a clean build.
4. Execute the Gradle task to install archives.
5. Verify that the newly generated files are present in the maven folder and contain the correct version number.

ndk.dir=/Users/{username}/Library/Android/sdk/ndk-bundle
sdk.dir=/Users/{username}/Library/Android/sdk

./gradlew installArchives

For iOS, you must first install CocoaPods dependencies.

1. If this is your first time running the project, install CocoaPods using Ruby bundler:

   bundle install

2. Every time you update native dependencies, run:

   bundle exec pod install

Once dependencies are installed, run the following command to launch the app on an iOS Simulator or connected device:

# Using npm
npm run ios

# OR using Yarn
yarn ios

To use this library in your React Native project, install it via npm or yarn and ensure native dependencies are linked.

Installation

npm i react-native-create-thumbnail

or

yarn add react-native-create-thumbnail

Linking Native Code

For React Native 0.60+ (Autolinking):

cd ios && pod install

For React Native < 0.60:

react-native link react-native-create-thumbnail

If you need to perform a full reload to reset the app state, use the following platform-specific methods:

• Android: Press the <kbd>R</kbd> key twice, or open the Dev Menu via <kbd>Ctrl</kbd> + <kbd>M</kbd> (Windows/Linux) or <kbd>Cmd ⌘</kbd> + <kbd>M</kbd> (macOS) and select "Reload".
• iOS: Press <kbd>R</kbd> in the iOS Simulator.

With Metro running, open a new terminal window and run the following command to build and launch the app on an Android emulator or connected device:

# Using npm
npm run android

# OR using Yarn
yarn android

Required Permissions

Ensure your Android application has the following permissions configured:

• READ_EXTERNAL_STORAGE
• WRITE_EXTERNAL_STORAGE

Limitations

• Remote Videos: Not supported on Android sdk_version < 14.
• Expo Go: This is a Native Module, so it will not work in Expo Go.
• Codec Support: Thumbnail generation depends on native APIs; it can only generate thumbnails from video formats/codecs supported by the device's OS.

Import createThumbnail to generate a thumbnail from a local or remote video file. The function returns a Promise that resolves with a response object containing the thumbnail's metadata or rejects with an error.

import { createThumbnail } from "react-native-create-thumbnail";

createThumbnail({
  url: '<path to video file>',
  timeStamp: 10000,
})
  .then(response => console.log({ response }))
  .catch(err => console.log({ err }));

The Promise returned by createThumbnail resolves to an object containing the following properties:

The createThumbnail function is the primary API for generating thumbnails from media files. It is exported as a named export from the package. It wraps the underlying CreateThumbnail native module.

import createThumbnail from 'react-native-create-thumbnail';

// Usage example (exact signature depends on native implementation):
// createThumbnail(requestObject).then(responseObject => ...)

The entire CreateThumbnail native module can be imported as a default export. This provides access to the underlying native methods directly.

import CreateThumbnail from 'react-native-create-thumbnail';

// Accessing the module directly
console.log(CreateThumbnail);