expo-video-metadata 0.1.0 → 1.0.0

package/README.md

@@ -2,9 +2,11 @@
 
 Provides a function that let you get some metadata from video files, like the duration, width, height, fps, codec, hasAudio, orientation, audioChannels, audioCodec, audioSampleRate etc. Check the exported types for more information. Web support is not available yet but it is planned.
 
+<img src="https://raw.githubusercontent.com/hirbod/expo-video-metadata/assets/preview.png" width="500" />
+
 # Installation in bare React Native projects
 
-This package needs **Expo SDK 50** or **higher**, as it uses FileSystem APIs that were added in that version. This package adds native code to your project and does not work with Expo Go. Please use a custom dev client or build a standalone app.
+This package needs **Expo SDK 50** or **higher**, as it uses FileSystem APIs that were added in that version. This package adds native code to your project and does not work with Expo Go. Please use a custom dev client or build a standalone app. Works with Fabric. Needs RN 0.73+ (Java JDK 17)
 
 For bare React Native projects, you must ensure that you have [installed and configured the `expo` package](https://docs.expo.dev/bare/installing-expo-modules/) before continuing (SDK 50+). This just adds ~150KB to your final app size and is the easiest way to get started and it works with and without Expo projects.
 
@@ -28,14 +30,20 @@ No additional set up necessary.
 import { getVideoInfoAsync } from 'expo-video-metadata';
 
 /**
- * Gets metadata from a video file.
+ * Retrieves video metadata.
+ *
  * @param sourceFilename An URI of the video, local or remote.
- * @return Returns a promise that resolves to a `VideoInfoResult` object.
+ * @param options Pass `headers` object in case `sourceFilename` is a remote URI, e.g { headers: "Authorization": "Bearer some-token" } etc.
+ *
+ * @return Returns a promise which fulfils with [`VideoInfoResult`](#Videoinforesult).
  */
-const videoInfo = await getVideoInfoAsync(sourceFileName: string): Promise<VideoInfo>;
 
+const result = await getVideoInfoAsync(
+  sourceFilename: string,
+  options: VideoInfoOptions = {},
+): Promise<VideoInfoResult> {
+  return await ExpoVideoMetadataModule.getVideoInfo(sourceFilename, options);
+}
 ```
 
-# Info
-
-I am planning to add more metadata to the result object. If you need something specific, please open an issue or a PR.
+See [VideoInfoResult](https://github.com/hirbod/expo-video-metadata/blob/b9239224eed46f455b2fb9f1b29e69ac49da6683/src/ExpoVideoMetadata.types.ts#L1) type for more information.

package/build/index.d.ts

@@ -1,7 +1,7 @@
 import { VideoInfoOptions, VideoInfoResult } from "./ExpoVideoMetadata.types";
 export { VideoInfoOptions, VideoInfoResult };
 /**
- * Create an image thumbnail from video provided via `sourceFilename`.
+ * Retrieves video metadata.
  *
  * @param sourceFilename An URI of the video, local or remote.
  * @param options Pass `headers` object in case `sourceFilename` is a remote URI, e.g { headers: "Authorization": "Bearer some-token" } etc.

package/build/index.js

@@ -2,7 +2,7 @@ import ExpoVideoMetadataModule from "./ExpoVideoMetadataModule";
 // Import the native module. On web, it will be resolved to ExpoVideoMetadata.web.ts
 // and on native platforms to ExpoVideoMetadata.ts
 /**
- * Create an image thumbnail from video provided via `sourceFilename`.
+ * Retrieves video metadata.
  *
  * @param sourceFilename An URI of the video, local or remote.
  * @param options Pass `headers` object in case `sourceFilename` is a remote URI, e.g { headers: "Authorization": "Bearer some-token" } etc.

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,uBAAuB,MAAM,2BAA2B,CAAC;AAIhE,oFAAoF;AACpF,kDAAkD;AAElD;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,cAAsB,EACtB,UAA4B,EAAE;IAE9B,OAAO,MAAM,uBAAuB,CAAC,YAAY,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;AAC7E,CAAC","sourcesContent":["import { VideoInfoOptions, VideoInfoResult } from \"./ExpoVideoMetadata.types\";\nimport ExpoVideoMetadataModule from \"./ExpoVideoMetadataModule\";\n\nexport { VideoInfoOptions, VideoInfoResult };\n\n// Import the native module. On web, it will be resolved to ExpoVideoMetadata.web.ts\n// and on native platforms to ExpoVideoMetadata.ts\n\n/**\n * Create an image thumbnail from video provided via `sourceFilename`.\n *\n * @param sourceFilename An URI of the video, local or remote.\n * @param options Pass `headers` object in case `sourceFilename` is a remote URI, e.g { headers: \"Authorization\": \"Bearer some-token\" } etc.\n *\n * @return Returns a promise which fulfils with [`VideoInfoResult`](#Videoinforesult).\n */\nexport async function getVideoInfoAsync(\n  sourceFilename: string,\n  options: VideoInfoOptions = {},\n): Promise<VideoInfoResult> {\n  return await ExpoVideoMetadataModule.getVideoInfo(sourceFilename, options);\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,uBAAuB,MAAM,2BAA2B,CAAC;AAIhE,oFAAoF;AACpF,kDAAkD;AAElD;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,cAAsB,EACtB,UAA4B,EAAE;IAE9B,OAAO,MAAM,uBAAuB,CAAC,YAAY,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;AAC7E,CAAC","sourcesContent":["import { VideoInfoOptions, VideoInfoResult } from \"./ExpoVideoMetadata.types\";\nimport ExpoVideoMetadataModule from \"./ExpoVideoMetadataModule\";\n\nexport { VideoInfoOptions, VideoInfoResult };\n\n// Import the native module. On web, it will be resolved to ExpoVideoMetadata.web.ts\n// and on native platforms to ExpoVideoMetadata.ts\n\n/**\n * Retrieves video metadata.\n *\n * @param sourceFilename An URI of the video, local or remote.\n * @param options Pass `headers` object in case `sourceFilename` is a remote URI, e.g { headers: \"Authorization\": \"Bearer some-token\" } etc.\n *\n * @return Returns a promise which fulfils with [`VideoInfoResult`](#Videoinforesult).\n */\nexport async function getVideoInfoAsync(\n  sourceFilename: string,\n  options: VideoInfoOptions = {}\n): Promise<VideoInfoResult> {\n  return await ExpoVideoMetadataModule.getVideoInfo(sourceFilename, options);\n}\n"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "expo-video-metadata",
-  "version": "0.1.0",
-  "description": "Module to retrieve informations from a video",
+  "version": "1.0.0",
+  "description": "Module to retrieve metadata from a video with Expo and React Native",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "scripts": {
@@ -19,13 +19,18 @@
     "react-native",
     "expo",
     "expo-video-metadata",
-    "ExpoVideoMetadata"
+    "ExpoVideoMetadata",
+    "react native",
+    "video module",
+    "video metadata",
+    "video",
+    "metadata"
   ],
   "repository": "https://github.com/hirbod/expo-video-metadata",
   "bugs": {
     "url": "https://github.com/hirbod/expo-video-metadata/issues"
   },
-  "author": "Hirbod Mirjavadi <hm@nightstomp.com> (https://github.com/hirbod)",
+  "author": "Hirbod Mirjavadi (https://github.com/hirbod)",
   "license": "MIT",
   "homepage": "https://github.com/hirbod/expo-video-metadata#readme",
   "dependencies": {},

package/src/index.ts

@@ -7,7 +7,7 @@ export { VideoInfoOptions, VideoInfoResult };
 // and on native platforms to ExpoVideoMetadata.ts
 
 /**
- * Create an image thumbnail from video provided via `sourceFilename`.
+ * Retrieves video metadata.
  *
  * @param sourceFilename An URI of the video, local or remote.
  * @param options Pass `headers` object in case `sourceFilename` is a remote URI, e.g { headers: "Authorization": "Bearer some-token" } etc.
@@ -16,7 +16,7 @@ export { VideoInfoOptions, VideoInfoResult };
  */
 export async function getVideoInfoAsync(
   sourceFilename: string,
-  options: VideoInfoOptions = {},
+  options: VideoInfoOptions = {}
 ): Promise<VideoInfoResult> {
   return await ExpoVideoMetadataModule.getVideoInfo(sourceFilename, options);
 }