add-sfx

작성자: remotion-dev

@remotion/sfx에 새로운 음향 효과 추가

npx skills add https://github.com/remotion-dev/remotion --skill add-sfx

Prerequisites

Sound effects must first be added to the remotion.media package.
Then it can be deployed using bun run build. The .env may be missing if we are in a worktree, but on the main non-worktree branch it should be present.

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:

  1. Add the WAV file to the root of the repo
  2. 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",
    },
    
  3. Run bun generate.ts to copy it to files/ and regenerate variants.json
  4. 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/<name>.mdx

Follow the pattern of existing pages (e.g. whip.mdx). Include:

  • Frontmatter with image, title (camelCase export name), crumb: '@remotion/sfx'
  • <AvailableFrom> tag with the next release version
  • <PlayButton> import and usage
  • Description
  • Example code using @remotion/media's <Audio> component
  • Value section with the URL in a fenced code block
  • Duration section (fetch the file and use afinfo on macOS to get duration/format)
  • Attribution section with source link and license
  • Convert section with a full-link sentence: [Open this file on remotion.dev/convert](https://remotion.dev/convert?url=<encoded-sfx-url>)
  • See also section linking to related sound effects

4. Register in sidebar and table of contents

  • packages/docs/sidebars.ts — add 'sfx/<name>' to the @remotion/sfx category items
  • packages/docs/docs/sfx/table-of-contents.tsx — add a <TOCItem> with a <PlayButton size={32}>

5. Regenerate SFX waveforms

After the sound is added to packages/remotion-media and exported from packages/sfx/src/index.ts, regenerate the waveform samples used by the docs:

bun packages/docs/generate-sfx-waveforms.ts

This uses ffmpeg to sample every exported sound effect into around 2000 waveform samples and updates packages/docs/components/sfx-demos/sfx-waveforms.ts.

6. Update the skills rule file

Add the new URL to the list in packages/skills/skills/remotion-markup/sfx.md.

7. Build

cd packages/sfx && bun run make

Naming conventions

File nameExport name
my-sound.wavmySound
switch.wavuiSwitch (reserved word)
page-turn.wavpageTurn

Version

Use the current version from packages/core/src/version.ts. For docs <AvailableFrom>, increment the patch version by 1.

remotion-dev의 다른 스킬

3d
remotion-dev
Remotion에서 Three.js와 React Three Fiber를 사용한 3D 콘텐츠.
accept-element
remotion-dev
외부 Remotion Element 기여를 수락하려면 커밋된 미리보기를 확인하고, R2에 업로드하고, 임시 자산을 제거하고, 준비를…
add-bug
remotion-dev
packages/bugs/api/[v].ts에 새로운 Remotion 버그 항목을 추가합니다. 사용자가 버그와 영향을 받는 Remotion 버전을 설명할 때 사용하며, 이를 통해 표면화되어야 합니다…
add-cli-option
remotion-dev
새로운 Remotion CLI 또는 설정 옵션을 추가하려면 AnyRemotionOption을 생성하고, CLI 파싱을 등록하고, 설정 세터를 연결하고, 문서를 업데이트하세요. 다음 경우에 사용하세요…
add-effect
remotion-dev
@remotion/effects에 새로운 효과를 추가합니다. 여기에는 구현, 패키지 내보내기, 문서, 데모, 미리보기 이미지, Remotion 스킬 업데이트, 테스트, 포맷팅 등이 포함됩니다.
add-expert
remotion-dev
Remotion 전문가 페이지에 새 전문가를 추가합니다
add-new-package
remotion-dev
Remotion 모노레포에 새 패키지를 추가하며, 패키지 스캐폴딩, 모노레포 등록, 문서, 빌드 스크립트, 테스트, 릴리스 체크리스트를 포함합니다…
add-webcodecs-bug
remotion-dev
브라우저 WebCodecs 버그를 Remotion Mediabunny WebCodecs 버그 문서 페이지에 추가합니다. 추적해야 하는 Chromium, WebKit 또는 Firefox 이슈 URL이 주어졌을 때 사용합니다…