Looking for the old docs? Go here

Display

Announcer

This component is used to announce important updates to screen readers.

The announcer component serves as a vital accessibility feature by dispatching important state updates to screen readers. This component ensures that users with visual impairments are kept informed about the status of media state in real-time. At the moment, this includes playback, volume, captions, fullscreen, picture-in-picture and seeking.
WARNING

Do not include this component if you’re using the Default or Plyr layouts as it’s already included.

API Reference

Section titled API Reference
HTMLAttributes
Ref<HTMLElement> 
import { MediaAnnouncer, type MediaAnnouncerProps } from "@vidstack/react";
<MediaAnnouncer />

Props

Section titled Props
PropTypeDefault
translations
Partial<MediaAnnouncerTranslations>
null

Callbacks

Section titled Callbacks
CallbackType
onChange
function
Previous
Plyr Layout
Next
Poster