Skip to content
Platform docs
Auth, users, webhooks & more
Info:
This is beta documentation for Stream Video React SDK v2. For the latest stable version, see the latest version (v1).

Speaking while muted notification

The SpeakingWhileMuted component is based on Notification component that is a simple popover. The SDK attaches the component to ToggleAudioPublishingButton. The popover rendering is controlled by sound detection mechanism put in place by createSoundDetector() function.

Default UI of SpeakingWhileMutedNotification component

General usage

The component is used by wrapping the component to which it will refer:

<SpeakingWhileMutedNotification>
  <ToggleAudioPublishingButton />
</SpeakingWhileMutedNotification>

Props

text

Type Default
string | undefined 'You are muted. Unmute to speak.'

Text message displayed by the notification.

placement

Type Default
Placement | undefined 'top-start'

Controls where the notification is positioned relative to its anchor (a @floating-ui/react Placement).

Customization

To learn more about creating sound detection functionality, see our speaking-while-muted tutorial.