Skip to main content

AudioPlayer

Media and Assetsai

Preset over ui's MediaPlayer parts for generated/recorded speech — real controls and keyboard shortcuts, no optional peer.

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

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 AudioPlayer component (from @elabs-ai/components-ai) 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 AudioPlayer up before writing code: `npx -y @elabs-ai/components-cli docs AudioPlayer` prints its real props, variants, what it pairs with and what to avoid.
3. If @elabs-ai/components-ai is not installed yet: `pnpm add @elabs-ai/components-tokens @elabs-ai/components-ui @elabs-ai/components-ai` (or `npm install @elabs-ai/components-tokens @elabs-ai/components-ui @elabs-ai/components-ai`). 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

  • Styling it through `--media-*` custom properties — no longer honoured; theme through tokens.
  • Autoplaying agent audio — playback is a user action; start it from a control, not on mount.
  • Shipping audio without Transcription — pair it so the content is readable, not only audible.

Works with

Contains

  • AudioPlayerControlBar
  • AudioPlayerPlayButton
  • AudioPlayerTimeRange

Pairs with

  • Transcription
  • SpeechInput

API

AudioPlayer

PropTypeDescription
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`.
autohidestring@deprecated Ignored (legacy controller attribute); removed in the next major.
autohideOverControlsboolean@deprecated Ignored (legacy controller attribute); removed in the next major.
breakpointsstring@deprecated Ignored (legacy controller attribute); removed in the next major.
breakpointsComputedboolean@deprecated Ignored (legacy controller attribute); removed in the next major.
defaultDurationnumber@deprecated Ignored (legacy controller attribute); removed in the next major.
defaultStreamTypestring@deprecated Ignored (legacy controller attribute); removed in the next major.
defaultSubtitlesboolean@deprecated Ignored (legacy controller attribute); removed in the next major.
gesturesDisabledboolean@deprecated Ignored (legacy controller attribute); removed in the next major.
keyboardControlboolean@deprecated Use `keyboardShortcuts`. `false` turns the player's keyboard map off.
keysUsedstring@deprecated Ignored (legacy controller attribute); removed in the next major.
liveEdgeOffsetnumber@deprecated Ignored (legacy controller attribute); removed in the next major.
noAutohideboolean@deprecated Ignored (legacy controller attribute); removed in the next major.
noAutoSeekToLiveboolean@deprecated Ignored (legacy controller attribute); removed in the next major.
noDefaultStoreboolean@deprecated Ignored (legacy controller attribute); removed in the next major.
noHotkeysboolean@deprecated Use `keyboardShortcuts={false}`.
noMutedPrefboolean@deprecated Ignored (legacy controller attribute); removed in the next major.
noSubtitlesLangPrefboolean@deprecated Ignored (legacy controller attribute); removed in the next major.
noVolumePrefboolean@deprecated Ignored (legacy controller attribute); removed in the next major.
resolvedLangstring@deprecated Ignored (legacy controller attribute); removed in the next major.
userInteractiveboolean@deprecated Ignored (legacy controller attribute); removed in the next major.

Also accepts: Omit<MediaPlayerProps, "kind">, AudioPlayerLegacyProps

AudioPlayerControlBar

Also accepts: MediaPlayerControlsProps

AudioPlayerDurationDisplay

Also accepts: Omit<MediaPlayerTimeProps, "mode">

AudioPlayerElement

Also accepts: Omit<ComponentProps<"audio">, "src">, ( | { data: SpeechResult["audio"]; } | { src: string; } )

AudioPlayerMuteButton

PropTypeDescription
sizeIconButtonSizeIcon-only size axis. Default `"icon"`.
disabledReasonstringShown appended to the tooltip text, and — independently — exposed via `aria-describedby` through an `sr-only` node that is present whenever this prop is (i.e. it does NOT depend on the tooltip being open, and it is not rendered at all when there is no reason — so it can never be read as stray text), so assistive tech gets the reason even while the button is disabled (a disabled `<button>` still exposes its ARIA attributes; it just isn't focusable/hoverable itself, which is why the tooltip trigger wraps a focusable `<span>` instead — see the render below).
sideComponentProps<typeof TooltipContent>["side"]Tooltip placement. Default `"top"`.

Also accepts: MediaPlayerButtonProps

AudioPlayerPlayButton

PropTypeDescription
sizeIconButtonSizeIcon-only size axis. Default `"icon"`.
disabledReasonstringShown appended to the tooltip text, and — independently — exposed via `aria-describedby` through an `sr-only` node that is present whenever this prop is (i.e. it does NOT depend on the tooltip being open, and it is not rendered at all when there is no reason — so it can never be read as stray text), so assistive tech gets the reason even while the button is disabled (a disabled `<button>` still exposes its ARIA attributes; it just isn't focusable/hoverable itself, which is why the tooltip trigger wraps a focusable `<span>` instead — see the render below).
sideComponentProps<typeof TooltipContent>["side"]Tooltip placement. Default `"top"`.

Also accepts: MediaPlayerButtonProps

AudioPlayerSeekBackwardButton

PropTypeDescription
offsetnumberSeconds to skip, as a positive distance; the button sets the direction. Default 10.
seekOffsetnumber@deprecated Use `offset`.
sizeIconButtonSizeIcon-only size axis. Default `"icon"`.
disabledReasonstringShown appended to the tooltip text, and — independently — exposed via `aria-describedby` through an `sr-only` node that is present whenever this prop is (i.e. it does NOT depend on the tooltip being open, and it is not rendered at all when there is no reason — so it can never be read as stray text), so assistive tech gets the reason even while the button is disabled (a disabled `<button>` still exposes its ARIA attributes; it just isn't focusable/hoverable itself, which is why the tooltip trigger wraps a focusable `<span>` instead — see the render below).
sideComponentProps<typeof TooltipContent>["side"]Tooltip placement. Default `"top"`.

Also accepts: AudioPlayerSeekPresetProps

AudioPlayerSeekForwardButton

PropTypeDescription
mediaControllerstring@deprecated Ignored (legacy attribute); removed in the next major.
mediaCurrentTimenumber@deprecated Ignored (legacy attribute); removed in the next major.
noTooltipboolean@deprecated Ignored (legacy attribute); removed in the next major.
preventClickboolean@deprecated Ignored (legacy attribute); removed in the next major.
offsetnumberSeconds to skip, as a positive distance; the button sets the direction. Default 10.
seekOffsetnumber@deprecated Use `offset`.
sizeIconButtonSizeIcon-only size axis. Default `"icon"`.
disabledReasonstringShown appended to the tooltip text, and — independently — exposed via `aria-describedby` through an `sr-only` node that is present whenever this prop is (i.e. it does NOT depend on the tooltip being open, and it is not rendered at all when there is no reason — so it can never be read as stray text), so assistive tech gets the reason even while the button is disabled (a disabled `<button>` still exposes its ARIA attributes; it just isn't focusable/hoverable itself, which is why the tooltip trigger wraps a focusable `<span>` instead — see the render below).
sideComponentProps<typeof TooltipContent>["side"]Tooltip placement. Default `"top"`.

Also accepts: AudioPlayerSeekPresetProps

AudioPlayerTimeDisplay

Also accepts: Omit<MediaPlayerTimeProps, "mode">

AudioPlayerTimeRange

PropTypeDescription
thumbPropsSliderThumbProps | SliderThumbProps[]Escape hatch spread onto the thumb LAST — for `data-*`/`style`/etc, or to deliberately override `aria-label`/`aria-labelledby`/`aria-valuetext` (an explicit key here always wins over the matching top-level prop). The six keys that MAKE the element a slider are ignored on purpose: `role`, `aria-valuenow`, `aria-valuemin`, `aria-valuemax`, `aria-orientation` and `tabIndex`. Radix derives every one of them from the slider's live state and spreads consumer props AFTER its own, so passing them here would silently destroy the widget (a wrong `aria-valuenow` mis-announces the value; `role`/`tabIndex` make it unreachable). Change the VALUE (`value`/`min`/`max`/`orientation`/ `disabled`) on `Slider` instead; use `aria-valuetext` to change how the value is spoken. Radix renders one thumb per element of `value`/`defaultValue` — pass a single object to apply the same props to every thumb (the historical single-thumb shape, unchanged), or an ARRAY to give each thumb its own props, indexed positionally against `value`/`defaultValue` (#398). A missing array slot falls back to no per-thumb override for that thumb.

Also accepts: MediaPlayerTimeSliderProps

AudioPlayerVolumeRange

PropTypeDescription
thumbPropsSliderThumbProps | SliderThumbProps[]Escape hatch spread onto the thumb LAST — for `data-*`/`style`/etc, or to deliberately override `aria-label`/`aria-labelledby`/`aria-valuetext` (an explicit key here always wins over the matching top-level prop). The six keys that MAKE the element a slider are ignored on purpose: `role`, `aria-valuenow`, `aria-valuemin`, `aria-valuemax`, `aria-orientation` and `tabIndex`. Radix derives every one of them from the slider's live state and spreads consumer props AFTER its own, so passing them here would silently destroy the widget (a wrong `aria-valuenow` mis-announces the value; `role`/`tabIndex` make it unreachable). Change the VALUE (`value`/`min`/`max`/`orientation`/ `disabled`) on `Slider` instead; use `aria-valuetext` to change how the value is spoken. Radix renders one thumb per element of `value`/`defaultValue` — pass a single object to apply the same props to every thumb (the historical single-thumb shape, unchanged), or an ARRAY to give each thumb its own props, indexed positionally against `value`/`defaultValue` (#398). A missing array slot falls back to no per-thumb override for that thumb.

Also accepts: MediaPlayerVolumeSliderProps