Merge pull request #4687 from remotion-dev/ai-jsdoc

packages/ai-improvements/.jsdoc/absolute-fill

@@ -0,0 +1,4 @@
+/**
+ * @description A helper component which renders an absolutely positioned <div> element with full width, height, and flex display suited for content layering.
+ * @see [Documentation](https://remotion.dev/docs/absolute-fill)
+ */

packages/ai-improvements/.jsdoc/artifact

@@ -0,0 +1,4 @@
+/**
+ * @description By rendering an `<Artifact>` tag in your Remotion markup, an extra file will get emitted during rendering.
+ * @see [Documentation](https://remotion.dev/docs/artifact)
+ */

packages/ai-improvements/.jsdoc/audio

@@ -0,0 +1,4 @@
+/**
+ * @description With this component, you can add audio to your video. All audio formats which are supported by Chromium are supported by the component.
+ * @see [Documentation](https://remotion.dev/docs/audio)
+ */

packages/ai-improvements/.jsdoc/audio-buffer-to-data-url

@@ -0,0 +1,4 @@
+/**
+ * @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)
+ */

packages/ai-improvements/.jsdoc/bundle

@@ -0,0 +1,4 @@
+/**
+ * @description Bundles a Remotion project using Webpack and prepares it for rendering.
+ * @see [Documentation](https://remotion.dev/docs/bundle)
+ */

packages/ai-improvements/.jsdoc/can-copy-audio-track

@@ -0,0 +1,4 @@
+/**
+ * @description Determines if an audio track can be copied to the output without re-encoding, based on the input and output media formats.
+ * @see [Documentation](https://www.remotion.dev/docs/webcodecs/can-copy-audio-track)
+ */

packages/ai-improvements/.jsdoc/can-copy-video-track

@@ -0,0 +1,4 @@
+/**
+ * @description Given a VideoTrack, determine if it can be copied to the output without re-encoding.
+ * @see [Documentation](https://www.remotion.dev/docs/webcodecs/can-copy-video-track)
+ */

packages/ai-improvements/.jsdoc/can-reencode-audio-track

@@ -0,0 +1,4 @@
+/**
+ * @description Given an `AudioTrack`, determine if it can be re-encoded to another track.
+ * @see [Documentation](https://www.remotion.dev/docs/webcodecs/can-reencode-audio-track)
+ */

packages/ai-improvements/.jsdoc/can-reencode-video-track

@@ -0,0 +1,4 @@
+/**
+ * @description Determines if a given video track can be re-encoded to another codec.
+ * @see [Documentation](https://www.remotion.dev/docs/webcodecs/can-reencode-video-track)
+ */

packages/ai-improvements/.jsdoc/cancel-render

@@ -0,0 +1,4 @@
+/**
+ * @description When you invoke this function, Remotion will stop rendering all the frames without any retries.
+ * @see [Documentation](https://remotion.dev/docs/cancel-render)
+ */

packages/ai-improvements/.jsdoc/captions/create-tiktok-style-captions

@@ -0,0 +1,4 @@
+/**
+ * @description Using this function, you can segment tokens to create "pages" of captions, as commonly seen on TikTok videos.
+ * @see [Documentation](https://remotion.dev/docs/captions/create-tiktok-style-captions)
+ */

packages/ai-improvements/.jsdoc/captions/ensure-max-characters-per-line

@@ -0,0 +1,4 @@
+/**
+ * @description Splits and rearranges captions into segments ensuring none exceed the maximum characters per line.
+ * @see [Documentation](https://remotion.dev/docs/captions/ensure-max-characters-per-line)
+ */

packages/ai-improvements/.jsdoc/captions/parse-srt

@@ -0,0 +1,4 @@
+/**
+ * @description Parses the contents of a SubRip file (.srt) and returns an array of Caption items.
+ * @see [Documentation](https://remotion.dev/docs/captions/parse-srt)
+ */

packages/ai-improvements/.jsdoc/captions/serialize-srt

@@ -0,0 +1,4 @@
+/**
+ * @description Converts a two-dimensional array of Caption items into a string in the SubRip format (`.srt`).
+ * @see [Documentation](https://remotion.dev/docs/captions/serialize-srt)
+ */

packages/ai-improvements/.jsdoc/composition

@@ -0,0 +1,4 @@
+/**
+ * @description This component is used to register a video to make it renderable and make it show in the sidebar, in dev mode.
+ * @see [Documentation](https://remotion.dev/docs/composition)
+ */

packages/ai-improvements/.jsdoc/continue-render

@@ -0,0 +1,4 @@
+/**
+ * @description Unblock a render that has been blocked by delayRender().
+ * @see [Documentation](https://remotion.dev/docs/continue-render)
+ */

packages/ai-improvements/.jsdoc/convert-media

@@ -0,0 +1,4 @@
+/**
+ * @description Re-encodes a video using WebCodecs and @remotion/media-parser.
+ * @see [Documentation](https://www.remotion.dev/docs/webcodecs/convert-media)
+ */

packages/ai-improvements/.jsdoc/default-on-audio-track-handler

@@ -0,0 +1,4 @@
+/**
+ * @description This is the default function if no onAudioTrack handler is provided to convertMedia(). You may use this function if you want to customize part of the track transformation logic, but fall back to the default behavior for the rest.
+ * @see [Documentation](https://www.remotion.dev/docs/webcodecs/default-on-audio-track-handler)
+ */

packages/ai-improvements/.jsdoc/default-on-video-track-handler

@@ -0,0 +1,4 @@
+/**
+ * @description This is the default function if no `onVideoTrack` handler is provided to `convertMedia()`. You may use this function if you want to customize part of the track transformation logic, but fall back to the default behavior for the rest.
+ * @see [Documentation](https://www.remotion.dev/docs/webcodecs/default-on-video-track-handler)
+ */

packages/ai-improvements/.jsdoc/delay-render

@@ -0,0 +1,4 @@
+/**
+ * @description Call this function to signal that a frame should not be rendered until an asynchronous task (such as data fetching) is complete. Use continueRender(handle) to proceed with rendering once the task is complete.
+ * @see [Documentation](https://remotion.dev/docs/delay-render)
+ */

packages/ai-improvements/.jsdoc/deletefunction

@@ -0,0 +1,4 @@
+/**
+ * @description Deletes a deployed Lambda function based on its name.
+ * @see [Documentation](https://remotion.dev/docs/lambda/deletefunction)
+ */

packages/ai-improvements/.jsdoc/deleterender

@@ -0,0 +1,4 @@
+/**
+ * @description Deletes a rendered video, audio or still and its associated metadata.
+ * @see [Documentation](https://remotion.dev/docs/lambda/deleterender)
+ */

packages/ai-improvements/.jsdoc/deleteservice

@@ -0,0 +1,4 @@
+/**
+ * @description Deletes a deployed Cloud Run service based on its name.
+ * @see [Documentation](https://remotion.dev/docs/cloudrun/deleteservice)
+ */

packages/ai-improvements/.jsdoc/deletesite

@@ -0,0 +1,4 @@
+/**
+ * @description Removes a Remotion project from your Cloud Storage bucket.
+ * @see [Documentation](https://remotion.dev/docs/cloudrun/deletesite)
+ */

packages/ai-improvements/.jsdoc/deployfunction

@@ -0,0 +1,4 @@
+/**
+ * @description Creates an AWS Lambda function in your account that will be able to render a video in the cloud.
+ * @see [Documentation](https://remotion.dev/docs/lambda/deployfunction)
+ */

packages/ai-improvements/.jsdoc/deployservice

@@ -0,0 +1,4 @@
+/**
+ * @description Creates a Cloud Run service in your project that will be able to render a video in GCP.
+ * @see [Documentation](https://remotion.dev/docs/cloudrun/deployservice)
+ */

packages/ai-improvements/.jsdoc/deploysite

@@ -0,0 +1,4 @@
+/**
+ * @description Deploys a Remotion project to a GCP storage bucket to prepare it for rendering on Cloud Run.
+ * @see [Documentation](https://remotion.dev/docs/cloudrun/deploysite)
+ */

packages/ai-improvements/.jsdoc/downloadmedia

@@ -0,0 +1,4 @@
+/**
+ * @description Downloads a rendered video, audio or still to the disk of the machine this API is called from.
+ * @see [Documentation](https://remotion.dev/docs/lambda/downloadmedia)
+ */

packages/ai-improvements/.jsdoc/easing

@@ -0,0 +1,4 @@
+/**
+ * @description The Easing module implements common easing functions. You can use it with the interpolate() API.
+ * @see [Documentation](https://remotion.dev/docs/easing)
+ */

packages/ai-improvements/.jsdoc/enable-scss/enable-scss

@@ -0,0 +1,4 @@
+/**
+ * @description A function that modifies the default Webpack configuration to make the necessary changes to support SASS/SCSS.
+ * @see [Documentation](https://remotion.dev/docs/enable-scss/enable-scss)
+ */

packages/ai-improvements/.jsdoc/ensure-browser

@@ -0,0 +1,4 @@
+/**
+ * @description Ensures a browser is locally installed so a Remotion render can be executed.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/ensure-browser)
+ */

packages/ai-improvements/.jsdoc/estimateprice

@@ -0,0 +1,4 @@
+/**
+ * @description Calculates the AWS costs incurred for AWS Lambda given the region, execution duration and memory size.
+ * @see [Documentation](https://remotion.dev/docs/lambda/estimateprice)
+ */

packages/ai-improvements/.jsdoc/extract-audio

@@ -0,0 +1,4 @@
+/**
+ * @description Extracts the audio from a video source and saves it to the specified output path. It does not convert the audio to a different format.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/extract-audio)
+ */

packages/ai-improvements/.jsdoc/folder

@@ -0,0 +1,4 @@
+/**
+ * @description By wrapping a <Composition /> inside a <Folder />, you can visually categorize it in your sidebar, should you have many compositions.
+ * @see [Documentation](https://remotion.dev/docs/folder)
+ */

packages/ai-improvements/.jsdoc/fonts-api/load-font

@@ -0,0 +1,4 @@
+/**
+ * @description Load a local font for use in Remotion, automatically blocking the render until the font is ready.
+ * @see [Documentation](https://remotion.dev/docs/fonts-api/load-font)
+ */

packages/ai-improvements/.jsdoc/freeze

@@ -0,0 +1,4 @@
+/**
+ * @description Freezes its children at the specified frame when rendering videos.
+ * @see [Documentation](https://remotion.dev/docs/freeze)
+ */

packages/ai-improvements/.jsdoc/get-audio-data

@@ -0,0 +1,4 @@
+/**
+ * @description Takes an audio src, loads it and returns data and metadata for the specified source.
+ * @see [Documentation](https://remotion.dev/docs/get-audio-data)
+ */

packages/ai-improvements/.jsdoc/get-audio-duration-in-seconds

@@ -0,0 +1,4 @@
+/**
+ * @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)
+ */

packages/ai-improvements/.jsdoc/get-available-audio-codecs

@@ -0,0 +1,4 @@
+/**
+ * @description Given a container, get a list of audio codecs that the container can hold.
+ * @see [Documentation](https://www.remotion.dev/docs/webcodecs/get-available-audio-codecs)
+ */

packages/ai-improvements/.jsdoc/get-available-containers

@@ -0,0 +1,4 @@
+/**
+ * @description Returns an array of available containers that can be used with the `convertMedia` function.
+ * @see [Documentation](https://www.remotion.dev/docs/webcodecs/get-available-containers)
+ */

packages/ai-improvements/.jsdoc/get-available-video-codecs

@@ -0,0 +1,4 @@
+/**
+ * @description Given a container, get a list of video codecs that the container can hold.
+ * @see [Documentation](https://remotion.dev/docs/webcodecs/get-available-video-codecs)
+ */

packages/ai-improvements/.jsdoc/get-compositions

@@ -0,0 +1,4 @@
+/**
+ * @description Gets a list of compositions defined in a Remotion project based on a Remotion Bundle by evaluating the Remotion Root.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/get-compositions)
+ */

packages/ai-improvements/.jsdoc/get-default-audio-codec

@@ -0,0 +1,4 @@
+/**
+ * @description Gets the default audio codec for a container that `@remotion/webcodecs` uses if no other audio codec was specified.
+ * @see [Documentation](https://remotion.dev/docs/webcodecs/get-default-audio-codec)
+ */

packages/ai-improvements/.jsdoc/get-default-video-codec

@@ -0,0 +1,4 @@
+/**
+ * @description Gets the default video codec for a container that `@remotion/webcodecs` uses if no other audio codec was specified.
+ * @see [Documentation](https://remotion.dev/docs/webcodecs/get-default-video-codec)
+ */

packages/ai-improvements/.jsdoc/get-gif-duration-in-seconds

@@ -0,0 +1,4 @@
+/**
+ * @description Gets the duration in seconds of a GIF.
+ * @see [Documentation](https://remotion.dev/docs/gif/get-gif-duration-in-seconds)
+ */

packages/ai-improvements/.jsdoc/get-image-dimensions

@@ -0,0 +1,4 @@
+/**
+ * @description Takes an image src, retrieves the dimensions of an image.
+ * @see [Documentation](https://remotion.dev/docs/get-image-dimensions)
+ */

packages/ai-improvements/.jsdoc/get-input-props

@@ -0,0 +1,4 @@
+/**
+ * @description Retrieves input properties passed from the command line or specified via the Node.JS API, useful when props are needed outside of a composition context.
+ * @see [Documentation](https://remotion.dev/docs/get-input-props)
+ */

packages/ai-improvements/.jsdoc/get-remotion-environment

@@ -0,0 +1,4 @@
+/**
+ * @description Provides information about the Remotion Environment
+ * @see [Documentation](https://remotion.dev/docs/get-remotion-environment)
+ */

packages/ai-improvements/.jsdoc/get-silent-parts

@@ -0,0 +1,4 @@
+/**
+ * @description Gets the silent parts of a video or audio in Node.js. Useful for cutting out silence from a video.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/get-silent-parts)
+ */

packages/ai-improvements/.jsdoc/get-video-metadata

@@ -0,0 +1,4 @@
+/**
+ * @description Takes a src to a video, loads it and returns metadata for the specified source.
+ * @see [Documentation](https://remotion.dev/docs/get-video-metadata)
+ */

packages/ai-improvements/.jsdoc/get-waveform-portion

@@ -0,0 +1,4 @@
+/**
+ * @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://remotion.dev/docs/get-waveform-portion)
+ */

packages/ai-improvements/.jsdoc/getawsclient

@@ -0,0 +1,4 @@
+/**
+ * @description Exposes full access to the AWS SDK used by Remotion, allowing interaction with AWS infrastructure beyond provided functionalities.
+ * @see [Documentation](https://remotion.dev/docs/lambda/getawsclient)
+ */

packages/ai-improvements/.jsdoc/getcompositionsonlambda

@@ -0,0 +1,4 @@
+/**
+ * @description Gets the compositions inside a Lambda function.
+ * @see [Documentation](https://remotion.dev/docs/lambda/getcompositionsonlambda)
+ */

packages/ai-improvements/.jsdoc/getfunctioninfo

@@ -0,0 +1,4 @@
+/**
+ * @description Gets information about a function given its name and region.
+ * @see [Documentation](https://remotion.dev/docs/lambda/getfunctioninfo)
+ */

packages/ai-improvements/.jsdoc/getfunctions

@@ -0,0 +1,4 @@
+/**
+ * @description Retrieves a list of functions that Remotion deployed to AWS Lambda in a certain region.
+ * @see [Documentation](https://remotion.dev/docs/lambda/getfunctions)
+ */

packages/ai-improvements/.jsdoc/getorcreatebucket

@@ -0,0 +1,4 @@
+/**
+ * @description Creates a Cloud Storage bucket for Remotion Cloud Run in your GCP project. If one already exists, it will get returned instead.
+ * @see [Documentation](https://remotion.dev/docs/cloudrun/getorcreatebucket)
+ */

packages/ai-improvements/.jsdoc/getregions

@@ -0,0 +1,4 @@
+/**
+ * @description Gets an array of all supported GCP regions of this release of Remotion Cloud Run.
+ * @see [Documentation](https://remotion.dev/docs/cloudrun/getregions)
+ */

packages/ai-improvements/.jsdoc/getrenderprogress

@@ -0,0 +1,4 @@
+/**
+ * @description Gets the current status of a render originally triggered via renderMediaOnLambda().
+ * @see [Documentation](https://remotion.dev/docs/lambda/getrenderprogress)
+ */

packages/ai-improvements/.jsdoc/getrolepolicy

@@ -0,0 +1,4 @@
+/**
+ * @description Returns an inline JSON policy to be assigned to the 'remotion-lambda-role' role that needs to be created in your AWS account.
+ * @see [Documentation](https://remotion.dev/docs/lambda/getrolepolicy)
+ */

packages/ai-improvements/.jsdoc/getserviceinfo

@@ -0,0 +1,4 @@
+/**
+ * @description Retrieves detailed information about a specific Cloud Run service using the service name and region.
+ * @see [Documentation](https://remotion.dev/docs/cloudrun/getserviceinfo)
+ */

packages/ai-improvements/.jsdoc/getservices

@@ -0,0 +1,4 @@
+/**
+ * @description Lists Remotion Cloud Run render services deployed to GCP Cloud Run.
+ * @see [Documentation](https://remotion.dev/docs/cloudrun/getservices)
+ */

packages/ai-improvements/.jsdoc/getsites

@@ -0,0 +1,4 @@
+/**
+ * @description Gets an array of Remotion projects in Cloud Storage, in your GCP project.
+ * @see [Documentation](https://remotion.dev/docs/cloudrun/getsites)
+ */

packages/ai-improvements/.jsdoc/getstaticfiles

@@ -0,0 +1,4 @@
+/**
+ * @description Gets an array containing all files in the `public/` folder. You can reference them by using `staticFile()`.
+ * @see [Documentation](https://remotion.dev/docs/getstaticfiles)
+ */

packages/ai-improvements/.jsdoc/getuserpolicy

@@ -0,0 +1,4 @@
+/**
+ * @description Returns an inline JSON policy to be assigned to the AWS user whose credentials are being used for executing CLI commands or calling Node.JS functions.
+ * @see [Documentation](https://remotion.dev/docs/lambda/getuserpolicy)
+ */

packages/ai-improvements/.jsdoc/gif/gif

@@ -0,0 +1,4 @@
+/**
+ * @description Displays a GIF that synchronizes with Remotions useCurrentFrame().
+ * @see [Documentation](https://remotion.dev/docs/gif)
+ */

packages/ai-improvements/.jsdoc/iframe

@@ -0,0 +1,4 @@
+/**
+ * @description The <IFrame /> can be used like a regular <iframe> HTML tag.
+ * @see [Documentation](https://remotion.dev/docs/iframe)
+ */