@remotion/media-utils 4.0.243 → 4.0.245

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

@@ -1,5 +1 @@
-/**
- * @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,9 +2,9 @@
 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)
+/*
+ * @description 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://remotion.dev/docs/audio-buffer-to-data-url)
  */
 const audioBufferToDataUrl = (buffer) => {
     const wavAsArrayBuffer = (0, audio_buffer_to_wav_1.audioBufferToWav)(buffer, {

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

@@ -2,9 +2,5 @@ import type { AudioData } from './types';
 type Options = {
     sampleRate?: number;
 };
-/**
- * @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, options?: Options) => Promise<AudioData>;
 export {};

package/dist/get-audio-data.js

@@ -36,9 +36,9 @@ const fn = async (src, options) => {
     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)
+ * @see [Documentation](https://remotion.dev/docs/get-audio-data)
  */
 const getAudioData = (src, options) => {
     return limit(fn, src, options);

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

@@ -1,10 +1,3 @@
-/**
- * @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>;
 /**
  * @deprecated Renamed to `getAudioDurationInSeconds`

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

@@ -39,12 +39,9 @@ const fn = (src) => {
         audio.addEventListener('error', onError, { once: true });
     });
 };
-/**
- * @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)
+/*
+ * @description Gets the duration in seconds of an audio source by creating an invisible `<audio>` tag, loading the audio, and returning the duration.
+ * @see [Documentation](https://remotion.dev/docs/get-audio-duration-in-seconds)
  */
 const getAudioDurationInSeconds = (src) => {
     return limit(fn, src);

package/dist/get-image-dimensions.d.ts

@@ -1,6 +1,2 @@
 import type { ImageDimensions } from './types';
-/**
- * @description Takes an image src, retrieves the dimensions of an image.
- * @see [Documentation](https://www.remotion.dev/docs/get-image-dimensions)
- */
 export declare function getImageDimensions(src: string): Promise<ImageDimensions>;

package/dist/get-image-dimensions.js

@@ -23,9 +23,9 @@ const fn = async (src) => {
     imageDimensionsCache[src] = imageDimensions;
     return imageDimensions;
 };
-/**
+/*
  * @description Takes an image src, retrieves the dimensions of an image.
- * @see [Documentation](https://www.remotion.dev/docs/get-image-dimensions)
+ * @see [Documentation](https://remotion.dev/docs/get-image-dimensions)
  */
 function getImageDimensions(src) {
     return limit(fn, src);

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

@@ -1,6 +1,2 @@
 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

@@ -56,9 +56,9 @@ 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)
+ * @see [Documentation](https://remotion.dev/docs/get-video-metadata)
  */
 const getVideoMetadata = (src) => {
     return limit(fn, src);

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

@@ -3,10 +3,6 @@ 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,9 +2,9 @@
 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)
+ * @see [Documentation](https://remotion.dev/docs/get-waveform-portion)
  */
 const getWaveformPortion = ({ audioData, startTimeInSeconds, durationInSeconds, numberOfSamples, }) => {
     const startSample = Math.floor((startTimeInSeconds / audioData.durationInSeconds) *

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

@@ -1,9 +1,2 @@
 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,11 +4,8 @@ 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.
+/*
+ * @description Wraps the getAudioData() function into a hook and does three things: keeps the audio data in a state, wraps the function in a delayRender() / continueRender() pattern, and handles the case where the component gets unmounted while fetching is in progress to prevent React errors.
  * @see [Documentation](https://www.remotion.dev/docs/use-audio-data)
  */
 const useAudioData = (src) => {

package/package.json

@@ -3,7 +3,7 @@
     "url": "https://github.com/remotion-dev/remotion/tree/main/packages/media-utils"
   },
   "name": "@remotion/media-utils",
-  "version": "4.0.243",
+  "version": "4.0.245",
   "description": "Utilities for working with media files",
   "main": "dist/index.js",
   "sideEffects": false,
@@ -13,7 +13,7 @@
     "url": "https://github.com/remotion-dev/remotion/issues"
   },
   "dependencies": {
-    "remotion": "4.0.243"
+    "remotion": "4.0.245"
   },
   "peerDependencies": {
     "react": ">=16.8.0",
@@ -21,7 +21,7 @@
   },
   "devDependencies": {
     "eslint": "9.14.0",
-    "@remotion/eslint-config-internal": "4.0.243"
+    "@remotion/eslint-config-internal": "4.0.245"
   },
   "keywords": [
     "remotion",