MuteButton
A button component for muting and unmuting audio playback
Anatomy
<MuteButton /><media-mute-button></media-mute-button>Examples
Basic Usage
import { createPlayer, features, MuteButton, Video } from '@videojs/react';
import './BasicUsage.css';
const Player = createPlayer({ features: [...features.video] });
export default function BasicUsage() {
return (
<Player.Provider>
<Player.Container className="mute-button-basic">
<Video
src="https://stream.mux.com/lhnU49l1VGi3zrTAZhDm9LUUxSjpaPW9BL4jY25Kwo4/highest.mp4"
autoPlay
muted
playsInline
loop
/>
<MuteButton
className="mute-button-basic__button"
render={(props, state) => <button {...props}>{state.muted ? 'Unmute' : 'Mute'}</button>}
/>
</Player.Container>
</Player.Provider>
);
}
.mute-button-basic {
position: relative;
}
.mute-button-basic video {
width: 100%;
}
.mute-button-basic__button {
padding-block: 8px;
position: absolute;
bottom: 10px;
left: 10px;
background: rgba(255, 255, 255, 0.7);
backdrop-filter: blur(10px);
color: black;
border: 1px solid rgba(255, 255, 255, 0.3);
border-radius: 9999px;
padding-inline: 20px;
cursor: pointer;
}
<video-player class="mute-button-basic">
<video
src="https://stream.mux.com/lhnU49l1VGi3zrTAZhDm9LUUxSjpaPW9BL4jY25Kwo4/highest.mp4"
autoplay
muted
playsinline
loop
></video>
<media-mute-button class="mute-button-basic__button">
<span class="show-when-muted">Unmute</span>
<span class="show-when-unmuted">Mute</span>
</media-mute-button>
</video-player>
.mute-button-basic {
position: relative;
}
.mute-button-basic video {
width: 100%;
}
.mute-button-basic__button {
padding-block: 8px;
position: absolute;
bottom: 10px;
left: 10px;
background: rgba(255, 255, 255, 0.7);
backdrop-filter: blur(10px);
color: black;
border: 1px solid rgba(255, 255, 255, 0.3);
border-radius: 9999px;
padding-inline: 20px;
cursor: pointer;
}
.mute-button-basic__button .show-when-muted {
display: none;
}
.mute-button-basic__button .show-when-unmuted {
display: none;
}
.mute-button-basic__button[data-muted] .show-when-muted {
display: inline;
}
.mute-button-basic__button:not([data-muted]) .show-when-unmuted {
display: inline;
}
import '@videojs/html/video/player';
import '@videojs/html/ui/mute-button';
API Reference
Props
| Prop | Type | Default | |
|---|---|---|---|
disabled | boolean | false | |
| |||
label | string | function | '' | |
| |||
State
State is accessible via the
render, className, and style props.
State is reflected as data attributes for CSS styling.
| Property | Type | |
|---|---|---|
volumeLevel | 'off' | 'low' | 'medium' | 'high' | |
| ||
muted | boolean | |
| ||
Data attributes
| Attribute | Description |
|---|---|
data-muted | Present when the media is muted. |
data-volume-level | Indicates the volume level. |