JavaFX - MediaPlayer setMute() Method

In JavaFX, the setMute() method in the MediaPlayer class is a method that allows us to control whether the sound is muted or not by setting the 'muteProperty'. By default, the muteProperty is set to false.

The muteProperty indicates whether the player audio is muted. When set to true, it means that no audio is being produced. Notably, muting or unmuting the audio won't affect the volume level, unless you’ve also changed the volume setting.

Syntax

Following is the syntax of the 'setMute()' method of 'MediaPlayer' class −

public final void setMute(boolean value)

Parameters

This method takes one parameter −

• value − A 'boolean' value, if true, mutes the audio; if false, unmute it.

Return value

This method does not returns any value.

Example 1

Following is a basic example demonstrating the setMute() method of 'MediaPlayer' class −

In this example, we create an instance of the MediaPlayer and set the 'mute' and 'unmute' values using the setMute() method.

import javafx.application.Platform;
import javafx.scene.media.Media;
import javafx.scene.media.MediaPlayer;
import java.io.File;
public class SetMute {
   public static void main(String[] args) {
	  // Initialize the JavaFX runtime
      Platform.startup(() -> {
         File mediaPath = new File("./audio_video/sampleTP.mp4");
         // Create a Media object
         Media media = new Media(mediaPath.toURI().toString());
         // Create a MediaPlayer object using the Media object
         MediaPlayer mediaPlayer = new MediaPlayer(media);
	     
         // Mute the audio
         mediaPlayer.setMute(true);
         System.out.println("Audio is now muted.");	     
         // Unmute the audio
         mediaPlayer.setMute(false);
         System.out.println("Audio is now unmuted.");
      });
   }
}

Output

Following is the output of the code −

Audio is now muted.
Audio is now unmuted.

Example 2

In this example, we check if the audio is muted using isMute(), which returns true if muted. Depending on the state, it prints "Muted" or "Unmuted". Then, we mute the audio with setMute(true), check the state again, and print the result. Finally, we unmute the audio with setMute(false) and print the state once more.

import javafx.application.Platform;
import javafx.scene.media.Media;
import javafx.scene.media.MediaPlayer;
import java.io.File;
public class SetMuteExample {
   public static void main(String[] args) {
      Platform.startup(() -> {
         File mediaPath = new File("./audio_video/sampleTP.mp4");
         // Create a Media object
         Media media = new Media(mediaPath.toURI().toString());
         MediaPlayer mediaPlayer = new MediaPlayer(media);
	     
         // Check if the audio is currently muted
         if(mediaPlayer.isMute()) {
            System.out.println("Muted");
         } else {
            System.out.println("Unmuted");
         }
	     
         // Mute the audio
         mediaPlayer.setMute(true);
         // Check again if the audio is muted
         if(mediaPlayer.isMute()) {
            System.out.println("Muted");
         } else {
            System.out.println("Unmuted");
         }
	     
         // Unmute the audio
         mediaPlayer.setMute(false);
         // Check again if the audio is muted
         if(mediaPlayer.isMute()) {
            System.out.println("Muted");
         } else {
            System.out.println("Unmuted");
         }
      });
   }
}

Output

Following is the output of the code −

Unmuted
Muted
Unmuted