1.2.3 • Published 4 years ago
@nextstepdev/react-native-create-thumbnail v1.2.3
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)
Getting started
Install library from
npm
npm i react-native-create-thumbnail
or
yarn add react-native-create-thumbnail
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' } |
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
react-native-thumbnail
- A great source of inspiration- This project was bootstrapped with
create-react-native-module
Maintenance Status
Active: Bug reports, feature requests and pull requests are welcome.
1.2.3
4 years ago