react-native-create-thumbnail

iOS/Android thumbnail generator with support for both local and remote videos. react-native-create-thumbnail is a wrapper around AVAssetImageGenerator (iOS) and MediaMetadataRetriever (Android)

Usage no npm install needed!

<script type="module">
  import reactNativeCreateThumbnail from 'https://cdn.skypack.dev/react-native-create-thumbnail';
</script>

README

react-native-create-thumbnail

iOS/Android thumbnail generator with support for both local and remote videos. react-native-create-thumbnail is a wrapper around AVAssetImageGenerator (iOS) and MediaMetadataRetriever (Android)

npm version npm downloads Maintenance Status

Getting started

  1. Install library from npm

    npm i react-native-create-thumbnail
    

    or

    yarn add react-native-create-thumbnail
    
  2. Link native code

    With autolinking (react-native 0.60+)

    cd ios && pod install
    

    Pre 0.60

    react-native link react-native-create-thumbnail
    

Usage

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 }));

Request Object

Property Type Description
url String (required) Path to video file (local or remote)
timeStamp Number (default 0) Thumbnail timestamp (in milliseconds)
format String (default jpeg) Thumbnail format, can be one of: jpeg, or png
dirSize Number (default 100) Maximum size of the cache directory (in megabytes)
headers Object Headers to load the video with. e.g. { Authorization: 'someAuthToken' }
cacheName String (optional) Cache name for this thumbnail to avoid duplicate generation. If specified, and a thumbnail already exists with the same cache name, it will be returned without generating a new one.

Response Object

Property Type Description
path String Path to generated thumbnail
size Number Size (in bytes) of thumbnail
mime String Mimetype of thumbnail
width Number Thumbnail width
height Number Thumbnail height

Notes

Requires following Permissions on android

READ_EXTERNAL_STORAGE, WRITE_EXTERNAL_STORAGE

Limitations

  • Remote videos aren't supported on android sdk_version < 14.
  • This is a Native Module, so it won't work in expo managed projects.

Credits

Maintenance Status

Active: Bug reports, feature requests and pull requests are welcome.