media-quality-radio-group
A menu radio group for selecting video quality
Creates radio items from the player video rendition state and selects automatic or manual quality.
Anatomy
const quality = useQualityOptions();
<Menu.RadioGroup value={quality.value} onValueChange={quality.setValue}>
<Menu.GroupLabel>Quality</Menu.GroupLabel>
{quality.options.map((option) => (
<Menu.RadioItem key={option.value} value={option.value} disabled={option.disabled}>
{option.label}
<Menu.ItemIndicator checked={option.value === quality.value} />
</Menu.RadioItem>
))}
</Menu.RadioGroup>
<media-quality-radio-group>
<template>
<media-menu-radio-item>
<span data-part="label"></span>
<span data-part="tier"></span>
<span data-part="badge"></span>
<media-menu-item-indicator></media-menu-item-indicator>
</media-menu-radio-item>
</template>
</media-quality-radio-group>
Behavior
The group is available when the configured media exposes more than one video rendition. The first generated option is Auto; selecting it returns control to adaptive bitrate selection. Pass formatRendition to customize visible rendition labels.
useQualityOptions returns null when the quality feature is not configured. Use the returned options with Menu.RadioGroup.
<media-quality-radio-group> generates <media-menu-radio-item> children. Add an optional <template> with a single <media-menu-radio-item> to customize each generated item.
Styling
| Attribute | Values | Description |
|---|---|---|
data-quality
|
string
|
Current quality value. |
data-disabled
|
Present / absent | Present when quality selection is disabled. |
data-availability
|
"available" / "unavailable"
|
Whether multiple renditions are available. |
media-quality-radio-group[data-availability="unavailable"] {
display: none;
}
Accessibility
The group uses the menu radio group pattern. It receives an accessible label from the label prop or defaults to Quality.
API Reference
Props
| Prop | Type | Default | Details |
|---|---|---|---|
disabled
|
boolean
|
false
|
|
|
|||
formatRendition
|
function
|
formatRenditionLabel
|
|
|
|||
label
|
string | function
|
''
|
|
|
|||
State
render, className, and style props.
| Property | Type | Details |
|---|---|---|
renditions
|
QualityRadioGroupRendition[]
|
|
autoLabel
|
string
|
|
value
|
string
|
|
disabled
|
boolean
|
|
availability
|
'available' | 'unavailable'
|
|
label
|
string
|
Data attributes
| Attribute | Type | Details |
|---|---|---|
data-quality
|
string
|
|
|
||
data-disabled
|
||
|
||
data-availability
|
'available' | 'unavailable'
|
|
|
||