@remotion/media-utils 4.0.0-webhook.27 → 4.1.0-alpha2

package/dist/audio-buffer/audio-url-helpers.d.ts

@@ -1 +1,5 @@
+/**
+ * @description This API takes an AudioBuffer instance and converts it to a Base 64 Data URL so it can be passed to an <Audio /> tag.
+ * @see [Documentation](https://www.remotion.dev/docs/audio-buffer-to-data-url)
+ */
 export declare const audioBufferToDataUrl: (buffer: AudioBuffer) => string;

package/dist/audio-buffer/audio-url-helpers.js

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.audioBufferToDataUrl = void 0;
 const audio_buffer_to_wav_1 = require("./audio-buffer-to-wav");
+/**
+ * @description This API takes an AudioBuffer instance and converts it to a Base 64 Data URL so it can be passed to an <Audio /> tag.
+ * @see [Documentation](https://www.remotion.dev/docs/audio-buffer-to-data-url)
+ */
 const audioBufferToDataUrl = (buffer) => {
     const wavAsArrayBuffer = (0, audio_buffer_to_wav_1.audioBufferToWav)(buffer, {
         float32: true,

package/dist/get-audio-data.d.ts

@@ -1,2 +1,6 @@
 import type { AudioData } from './types';
+/**
+ * @description Takes an audio src, loads it and returns data and metadata for the specified source.
+ * @see [Documentation](https://www.remotion.dev/docs/get-audio-data)
+ */
 export declare const getAudioData: (src: string) => Promise<AudioData>;

package/dist/get-audio-data.js

@@ -54,6 +54,10 @@ const fn = async (src) => {
     metadataCache[src] = metadata;
     return metadata;
 };
+/**
+ * @description Takes an audio src, loads it and returns data and metadata for the specified source.
+ * @see [Documentation](https://www.remotion.dev/docs/get-audio-data)
+ */
 const getAudioData = (src) => {
     return limit(fn, src);
 };

package/dist/get-audio-duration-in-seconds.d.ts

@@ -1,8 +1,9 @@
 /**
- * Get the audio file passed in parameter duration in seconds
+ * @default Get the audio file passed in parameter duration in seconds
  * @async
  * @param src path to the audio file
  * @return {number} duration of the audio file in seconds
+ * @see [Documentation](https://www.remotion.dev/docs/get-audio-duration-in-seconds)
  */
 export declare const getAudioDurationInSeconds: (src: string) => Promise<number>;
 /**

package/dist/get-audio-duration-in-seconds.js

@@ -33,10 +33,11 @@ const fn = (src) => {
     });
 };
 /**
- * Get the audio file passed in parameter duration in seconds
+ * @default Get the audio file passed in parameter duration in seconds
  * @async
  * @param src path to the audio file
  * @return {number} duration of the audio file in seconds
+ * @see [Documentation](https://www.remotion.dev/docs/get-audio-duration-in-seconds)
  */
 const getAudioDurationInSeconds = (src) => {
     return limit(fn, src);

package/dist/get-video-metadata.d.ts

@@ -1,2 +1,6 @@
 import type { VideoMetadata } from './types';
+/**
+ * @description Takes a src to a video, loads it and returns metadata for the specified source.
+ * @see [Documentation](https://www.remotion.dev/docs/get-video-metadata)
+ */
 export declare const getVideoMetadata: (src: string) => Promise<VideoMetadata>;

package/dist/get-video-metadata.js

@@ -45,6 +45,10 @@ const fn = (src) => {
         video.addEventListener('error', onError, { once: true });
     });
 };
+/**
+ * @description Takes a src to a video, loads it and returns metadata for the specified source.
+ * @see [Documentation](https://www.remotion.dev/docs/get-video-metadata)
+ */
 const getVideoMetadata = (src) => {
     return limit(fn, src);
 };

package/dist/get-waveform-portion.d.ts

@@ -1,8 +1,12 @@
 import type { AudioData } from './types';
-declare type Bar = {
+type Bar = {
     index: number;
     amplitude: number;
 };
+/**
+ * @description Takes bulky waveform data (for example fetched by getAudioData()) and returns a trimmed and simplified version of it, for simpler visualization
+ * @see [Documentation](https://www.remotion.dev/docs/get-waveform-portion)
+ */
 export declare const getWaveformPortion: ({ audioData, startTimeInSeconds, durationInSeconds, numberOfSamples, }: {
     audioData: AudioData;
     startTimeInSeconds: number;

package/dist/get-waveform-portion.js

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getWaveformPortion = void 0;
 const get_wave_form_samples_1 = require("./get-wave-form-samples");
+/**
+ * @description Takes bulky waveform data (for example fetched by getAudioData()) and returns a trimmed and simplified version of it, for simpler visualization
+ * @see [Documentation](https://www.remotion.dev/docs/get-waveform-portion)
+ */
 const getWaveformPortion = ({ audioData, startTimeInSeconds, durationInSeconds, numberOfSamples, }) => {
     const startSample = Math.floor((startTimeInSeconds / audioData.durationInSeconds) *
         audioData.channelWaveforms[0].length);

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-export declare type AudioData = {
+export type AudioData = {
     channelWaveforms: Float32Array[];
     sampleRate: number;
     durationInSeconds: number;
@@ -6,7 +6,7 @@ export declare type AudioData = {
     resultId: string;
     isRemote: boolean;
 };
-export declare type VideoMetadata = {
+export type VideoMetadata = {
     durationInSeconds: number;
     width: number;
     height: number;

package/dist/use-audio-data.d.ts

@@ -1,2 +1,9 @@
 import type { AudioData } from './types';
+/**
+ * @description Wraps the getAudioData() function into a hook and does 3 things:
+ * @description Keeps the audio data in a state
+ * @description Wraps the function in a delayRender() / continueRender() pattern.
+ * @description Handles the case where the component gets unmounted while the fetching is in progress and a React error is thrown.
+ * @see [Documentation](https://www.remotion.dev/docs/use-audio-data)
+ */
 export declare const useAudioData: (src: string) => AudioData | null;

package/dist/use-audio-data.js

@@ -4,6 +4,13 @@ exports.useAudioData = void 0;
 const react_1 = require("react");
 const remotion_1 = require("remotion");
 const get_audio_data_1 = require("./get-audio-data");
+/**
+ * @description Wraps the getAudioData() function into a hook and does 3 things:
+ * @description Keeps the audio data in a state
+ * @description Wraps the function in a delayRender() / continueRender() pattern.
+ * @description Handles the case where the component gets unmounted while the fetching is in progress and a React error is thrown.
+ * @see [Documentation](https://www.remotion.dev/docs/use-audio-data)
+ */
 const useAudioData = (src) => {
     if (!src) {
         throw new TypeError("useAudioData requires a 'src' parameter");

package/dist/visualize-audio.d.ts

@@ -1,5 +1,5 @@
 import type { AudioData } from './types';
-declare type FnParameters = {
+type FnParameters = {
     audioData: AudioData;
     frame: number;
     fps: number;

package/dist/visualize-audio.js

@@ -4,6 +4,11 @@ exports.visualizeAudio = void 0;
 const get_visualization_1 = require("./fft/get-visualization");
 const max_value_cached_1 = require("./fft/max-value-cached");
 const cache = {};
+/**
+ * @description Takes in AudioData (preferably fetched by the useAudioData() hook) and processes it in a way that makes visualizing the audio that is playing at the current frame easy.
+ * @description part of @remotion/media-utils
+ * @see [Documentation](https://www.remotion.dev/docs/visualize-audio)
+ */
 const visualizeAudioFrame = ({ audioData: metadata, frame, fps, numberOfSamples, }) => {
     const cacheKey = metadata.resultId + frame + fps + numberOfSamples;
     if (cache[cacheKey]) {

package/package.json

@@ -1,48 +1,47 @@
 {
-	"name": "@remotion/media-utils",
-	"version": "4.0.0-webhook.27+eb81308ee",
-	"description": "Utility functions for audio and video",
-	"main": "dist/index.js",
-	"sideEffects": false,
-	"scripts": {
-		"lint": "eslint src --ext ts,tsx",
-		"watch": "tsc -w",
-		"build": "tsc -d"
-	},
-	"author": "",
-	"license": "MIT",
-	"repository": {
-		"url": "https://github.com/remotion-dev/remotion"
-	},
-	"bugs": {
-		"url": "https://github.com/remotion-dev/remotion/issues"
-	},
-	"dependencies": {
-		"remotion": "4.0.0-webhook.27+eb81308ee"
-	},
-	"peerDependencies": {
-		"react": ">=16.8.0",
-		"react-dom": ">=16.8.0"
-	},
-	"devDependencies": {
-		"@jonny/eslint-config": "3.0.266",
-		"@types/node": "^16.7.5",
-		"@types/react": "18.0.1",
-		"eslint": "8.13.0",
-		"prettier": "^2.0.5",
-		"prettier-plugin-organize-imports": "^2.3.4",
-		"typescript": "^4.7.0"
-	},
-	"keywords": [
-		"remotion",
-		"ffmpeg",
-		"video",
-		"react",
-		"puppeteer",
-		"player"
-	],
-	"publishConfig": {
-		"access": "public"
-	},
-	"gitHead": "eb81308ee07a402f4a8dd9ff24306bb07dd78175"
-}
+  "name": "@remotion/media-utils",
+  "version": "4.1.0-alpha2",
+  "description": "Utility functions for audio and video",
+  "main": "dist/index.js",
+  "sideEffects": false,
+  "author": "Jonny Burger <jonny@remotion.dev>",
+  "license": "MIT",
+  "repository": {
+    "url": "https://github.com/remotion-dev/remotion"
+  },
+  "bugs": {
+    "url": "https://github.com/remotion-dev/remotion/issues"
+  },
+  "dependencies": {
+    "remotion": "4.1.0-alpha2"
+  },
+  "peerDependencies": {
+    "react": ">=16.8.0",
+    "react-dom": ">=16.8.0"
+  },
+  "devDependencies": {
+    "@jonny/eslint-config": "3.0.266",
+    "@types/node": "18.14.6",
+    "@types/react": "18.0.26",
+    "eslint": "8.42.0",
+    "prettier": "^2.7.1",
+    "prettier-plugin-organize-imports": "^2.3.4",
+    "typescript": "4.9.5"
+  },
+  "keywords": [
+    "remotion",
+    "ffmpeg",
+    "video",
+    "react",
+    "player"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "formatting": "prettier src --check",
+    "lint": "eslint src --ext ts,tsx",
+    "watch": "tsc -w",
+    "build": "tsc -d"
+  }
+}

package/.prettierrc.js

@@ -1,14 +0,0 @@
-module.exports = {
-	singleQuote: true,
-	bracketSpacing: false,
-	useTabs: true,
-	overrides: [
-		{
-			files: ['*.yml'],
-			options: {
-				singleQuote: false,
-			},
-		},
-	],
-	plugins: [require.resolve('prettier-plugin-organize-imports')],
-};

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-	"extends": "../tsconfig.settings.json",
-	"compilerOptions": {
-		"composite": true,
-		"rootDir": "src",
-		"outDir": "dist"
-	},
-	"include": ["src"],
-	"references": [{"path": "../core"}]
-}