ReferenceMenus

AudioTrackRadioGroup

A menu radio group for selecting an audio track

Creates radio items from the player audio track state and selects the enabled track.

Import

import { AudioTrackRadioGroup } from '@videojs/react/ui/audio-track-radio-group';

Anatomy

<AudioTrackRadioGroup.Root>
  <Menu.Trigger>
    <AudioTrackRadioGroup.Value />
  </Menu.Trigger>
  <Menu.Content>
    <AudioTrackRadioGroup.Options
      renderItem={(props, item) => (
        <Menu.RadioItem {...props}>
          {item.label}
          <Menu.ItemIndicator checked={item.checked} />
        </Menu.RadioItem>
      )}
    />
  </Menu.Content>
</AudioTrackRadioGroup.Root>

Behavior

The group is available when the configured media exposes more than one audio track. Labels use the track label, then language, then kind. Pass formatTrack to customize the visible labels.

AudioTrackRadioGroup.Root uses useAudioTrackOptions to own selection and renders no element. Wrap the menu’s Menu.Trigger and Menu.Content in it so the trigger inherits the group’s disabled and hidden state and exposes data-availability. AudioTrackRadioGroup.Options renders the items: its required renderItem callback renders the Menu.RadioItem root and receives item state containing the translated label and current checked value. AudioTrackRadioGroup.Value displays the selected label, typically inside the trigger. Options and Value render null when the audio track feature is not configured.

The AudioTrackRadioGroup export from the @videojs/react root is a compatibility component that composes Root and Options behind the former single-component props. Prefer the parts for new code.

Styling

Attribute	Values	Description
`data-audio-track`	`string`	Current audio track value.
`data-disabled`	Present / absent	Present when audio track selection is disabled.
`data-hidden`	Present / absent	Present when multiple audio tracks are unavailable.
`data-availability`	`"available"` / `"unavailable"`	Whether multiple audio tracks are available.

Unavailable groups receive the native hidden attribute.

Accessibility

The group uses the menu radio group pattern.

AudioTrackRadioGroup.Options receives its accessible label from the label prop on AudioTrackRadioGroup.Root or defaults to Audio. Override it with aria-label or aria-labelledby on AudioTrackRadioGroup.Options.

Examples

Basic usage

import { Container, createPlayer, Menu } from '@videojs/react';
import { HlsJsVideo } from '@videojs/react/media/hlsjs-video';
import { AudioTrackRadioGroup } from '@videojs/react/ui/audio-track-radio-group';
import { videoFeatures } from '@videojs/react/video';
import type { ReactNode } from 'react';

const { Player } = createPlayer({ features: videoFeatures });
const src = 'https://stream.mux.com/s41JYeqIpBMBzE4OzxDyGR2yrp2hD1CQ6gJN9SlVGDQ.m3u8';

function AudioMenu(): ReactNode {
  return (
    <Menu.Root side="top" align="end">
      <AudioTrackRadioGroup.Root>
        <Menu.Trigger className="settings-trigger" render={<button type="button" />}>
          Audio
          <AudioTrackRadioGroup.Value className="menu-hint" />
        </Menu.Trigger>
        <Menu.Popup className="menu">
          <Menu.Content>
            <AudioTrackRadioGroup.Options
              className="menu-group"
              renderItem={(props, item) => (
                <Menu.RadioItem {...props} className="menu-item">
                  {item.label}
                  <Menu.ItemIndicator checked={item.checked} forceMount className="menu-indicator">
                    ✓
                  </Menu.ItemIndicator>
                </Menu.RadioItem>
              )}
            />
          </Menu.Content>
        </Menu.Popup>
      </AudioTrackRadioGroup.Root>
    </Menu.Root>
  );
}

export default function BasicUsage() {
  return (
    <Player>
      <Container className="media-container">
        <HlsJsVideo src={src} autoPlay crossOrigin="anonymous" muted playsInline loop />
        <div className="menu-bar">
          <AudioMenu />
        </div>
      </Container>
    </Player>
  );
}

.media-container {
  position: relative;
}

.media-container video {
  width: 100%;
}

.menu-bar {
  position: absolute;
  right: 10px;
  bottom: 10px;
}

.settings-trigger {
  padding: 6px 16px;
  color: black;
  cursor: pointer;
  background: rgba(255, 255, 255, 0.75);
  border: 1px solid rgba(255, 255, 255, 0.35);
  border-radius: 9999px;
  backdrop-filter: blur(10px);
}

.menu-hint {
  margin-left: 8px;
  color: rgba(0, 0, 0, 0.6);
}

.menu-hint:empty {
  display: none;
}

.menu {
  --media-menu-side-offset: 8px;
  box-sizing: border-box;
  display: grid;
  gap: 2px;
  min-width: 180px;
  max-width: var(--media-menu-available-width, var(--media-popover-available-width, none));
  max-height: var(--media-menu-available-height, var(--media-popover-available-height, none));
  padding: 6px;
  margin: 0;
  overflow: auto;
  overscroll-behavior: none;
  font-size: 14px;
  color: white;
  background: rgba(0, 0, 0, 0.88);
  border: 0;
  border-radius: 8px;
  backdrop-filter: blur(10px);
}

.menu-group {
  display: grid;
  gap: 2px;
}

.menu-item {
  display: flex;
  gap: 8px;
  align-items: center;
  justify-content: space-between;
  min-height: 32px;
  padding: 0 10px;
  font: inherit;
  color: inherit;
  cursor: pointer;
  background: none;
  border: 0;
  border-radius: 6px;
}

.menu-item[data-highlighted] {
  background: rgba(255, 255, 255, 0.16);
}

.menu-indicator {
  opacity: 0;
}

[role="menuitemradio"][aria-checked="true"] .menu-indicator {
  opacity: 1;
}

API Reference

Root

Owns audio-track option state and shares it with an enclosing menu. Does not render a DOM element.

Props

Prop	Type	Default
`disabled`	`boolean`	`false`
Description Whether audio track selection is disabled.
`formatTrack`	`function`	`formatTrackLabel`
Description Custom formatter for visible track labels. Type `((track: MediaAudioTrack) => Text \| string)`
`label`	`object`	`''`
Description Custom label for the options group. Type `{ key: string; text: string } \| string \| ((state: AudioTrackRadioGroupState) => Text \| string)`

State

State is accessible via the render, className, and style props.

Property	Type	Details
`label`	`{ key: string; text: string } \| string`
`value`	`string`
Description Current radio-group value.
`options`	`readonly Option[]`
Description Ordered options displayed by platform adapters.
`disabled`	`boolean`
Description Whether the entire option group is disabled.
`hidden`	`boolean`
Description Whether the option group is hidden because no meaningful selection is available.
`availability`	`'available' \| 'unavailable'`
Description Whether the media exposes a meaningful selection.

Data attributes

Attribute	Type	Details
`data-audio-track`	`string`
Description Current audio track value.
`data-disabled`	—
Description Present when audio track selection is disabled.
`data-hidden`	—
Description Present when audio track selection is unavailable.
`data-availability`	`'available' \| 'unavailable'`
Description Indicates audio track availability (`available` or `unavailable`).

Options

Renders menu radio items for the player's available audio tracks.

Props

Prop	Type	Default
`className`	`string \| function`	—
Description Class name or function returning class name from state. Type `string \| ((state: AudioTrackRadioGroupState) => string \| undefined)`
`render`	`ReactElement \| function`	—
Description Render prop for custom element. Type `ReactElement \| ((props: HTMLProps, state: AudioTrackRadioGroupState) => ReactElement \| null)`
`renderItem`	`function`	—
Description Render one consumer-owned menu radio item for every audio track. Type `((props: AudioTrackRadioGroupItemProps, state: AudioTrackRadioGroupItemState) => ReactElement)`
`style`	`CSSProperties \| function`	—
Description Style or function returning style from state. Type `CSSProperties \| ((state: AudioTrackRadioGroupState) => CSSProperties \| undefined)`

Value

Displays the selected audio-track label.

Props

Prop	Type	Default
`className`	`string \| function`	—
Description Class name or function returning class name from state. Type `string \| ((state: AudioTrackOptionsResult) => string \| undefined)`
`render`	`ReactElement \| function`	—
Description Render prop for custom element. Type `ReactElement \| ((props: HTMLProps, state: AudioTrackOptionsResult) => ReactElement \| null)`
`style`	`CSSProperties \| function`	—
Description Style or function returning style from state. Type `CSSProperties \| ((state: AudioTrackOptionsResult) => CSSProperties \| undefined)`