Skip to main content

Audio

Displaydisplay

An audio player with its own controls (seek, play, time, scrubber, mute, volume) — voice replies, recordings, clips.

import { Audio } from "@elabs-ai/components-ui";
Install
npm install @elabs-ai/components-tokens @elabs-ai/components-ui

Skipping the @source line is the most common first failure: Tailwind does not scan node_modules, so every component renders unstyled. The one-time wiring

Prompt for your coding agent

Paste it into Claude Code, Cursor, Codex or any other coding agent. Text in [brackets] is yours to fill in.

Add the brand-ui Audio component (from @elabs-ai/components-ui) to this project.

1. Read https://elabs-ai.com/llms.txt first: it maps every package and the rules. If you can use MCP servers, connect https://elabs-ai.com/mcp and use its search, docs and tokens tools. If not, run the same lookups in the terminal: `npx -y @elabs-ai/components-cli search "<what you need>"` and `npx -y @elabs-ai/components-cli docs <Component>`.
2. Look Audio up before writing code: `npx -y @elabs-ai/components-cli docs Audio` prints its real props, variants, what it pairs with and what to avoid.
3. If @elabs-ai/components-ui is not installed yet: `pnpm add @elabs-ai/components-tokens @elabs-ai/components-ui` (or `npm install @elabs-ai/components-tokens @elabs-ai/components-ui`). If this is the first brand-ui package in the project, wire it once: import `@elabs-ai/components-tokens/styles.css` plus the `themes/light.css` and `themes/dark.css` stylesheets in the CSS entry, add one Tailwind `@source` line per installed @elabs-ai package (Tailwind does not scan node_modules, so without it everything renders unstyled), and wrap the app root in `ThemeProvider` from `@elabs-ai/components-tokens`.
4. Use it here: [the screen or file, and what it should show]
5. Rules: use only @elabs-ai/components-* components and the semantic tokens — no raw colours, no raw font sizes, no arbitrary Tailwind values. Look up each component's real props with the docs tool before you use it; never guess a prop.
6. Done means: the typecheck passes, `npx -y @elabs-ai/components-cli audit src --strict` reports nothing, and you have opened the app and looked at every screen you touched in the light and the dark theme.

Avoid

  • Reaching for a third-party media engine — compose the MediaPlayer parts.
  • `autoPlay` with sound — browsers block it; start from a control.

Works with

Contains

Used inside

Pairs with

Examples

8 live examples

Real Peaks

The app decoded the file and passed its `peaks`: the bars draw the real recording.

Bar

The plain time slider instead of the waveform.

Minimal

Play and the clock only — the smallest useful player, e.g. a voice note.

Custom Composition

The look the ai `AudioPlayer` presets keep: outline buttons grouped, inside a card.

Playback Rate

Keyboard

Error

A source the browser cannot decode: the bar is replaced by the compact error panel.

API

Audio

PropTypeDescription
controlsbooleanRender the default control bar. Default `true`.
variant"waveform" | "bar"The default bar's scrubber: `waveform` (default) draws the recording's bars, filling as it plays · `bar` is the plain time slider.
peaksreadonly number[]The recording's shape, 0–1, any length — the app supplies it (e.g. from `AudioBuffer.getChannelData`); the player never fetches or decodes. Omit for a stand-in shape drawn from `src`.
childrenReactNodeA full custom composition of `MediaPlayer*` parts, rendered after the `<audio>`; when given, the default bar is not rendered.

Also accepts: Omit<MediaPlayerProps, "kind" | "children" | MediaElementKey>, MediaElementPassthroughProps

MediaPlayer

PropTypeDescription
kindrequiredMediaKindWhich element `MediaPlayerElement` renders.
labelstringThe region's accessible name. Default "Audio player" / "Video player".
keyboardShortcutsbooleanHandle the player keyboard map (Space/k, ←/→, j/l, ↑/↓, m, f, 0–9). Default `true`.

Also accepts: HTMLAttributes<HTMLDivElement>

MediaPlayerControls

placement
docked (default)overlay

Also accepts: HTMLAttributes<HTMLDivElement>, VariantProps<typeof mediaPlayerControlsVariants>

Theming

The tokens each state resolves to. Change the token and every theme follows.

StateToken
surfacetransparent root — the bubble or card is the surface
errorStatePanel kind=error size=sm replaces the bar (role=alert)