Prerequisites
Sound effects must first be added to the
remotion.media
repository. The source of truth is
generate.ts
in that repo. A sound effect must exist there before it can be added to
@remotion/sfx
.
Sound effects must be:
WAV format
CC0 (Creative Commons 0) licensed
Normalized to peak at -3dB
Steps
1. Add to
remotion.media
repo (must be done first)
In the
remotion-dev/remotion.media
repo:
Add the WAV file to the root of the repo
Add an entry to the
soundEffects
array in
generate.ts
:
{
fileName
:
"my-sound.wav"
,
attribution
:
"Description by Author -- https://source-url -- License: Creative Commons 0"
,
}
,
Run
bun generate.ts
to copy it to
files/
and regenerate
variants.json
Deploy
2. Add the export to
packages/sfx/src/index.ts
Use camelCase for the variable name. Avoid JavaScript reserved words (e.g. use
uiSwitch
not
switch
).
export
const
mySound
=
'https://remotion.media/my-sound.wav'
;
3. Create a doc page at
packages/docs/docs/sfx/
add-sfx
安装
npx skills add https://github.com/remotion-dev/remotion --skill add-sfx