JavaFX - MediaPlayer stop() Method

In JavaFX, the stop() method in the MediaPlayer class is used to stop the playback of the media file. When the media has stopped, we won't be able to move to different positions in the video when we try to navigate forward or backward.

When we call the stop() method, the media player object resets playback to 'startTime', and resets 'currentCount' to zero. Once the player has actually stopped, the status will be set to MediaPlayer.Status.Stopped.

Syntax

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

public void stop()

Parameters

This method doesn't takes any parameter.

Return value

This method doesn't return any value.

Example 1

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

In this example, we create an application that displays a video file. We use the stop() method to stop the video. After stopping, we check the media player's status. If it's stopped, we display "Media has stopped" on a label, if it's playing, we display "Media is playing right now."

import javafx.animation.KeyFrame;
import javafx.animation.Timeline;
import javafx.application.Application;
import javafx.scene.Scene;
import javafx.scene.control.Label;
import javafx.scene.layout.VBox;
import javafx.scene.media.Media;
import javafx.scene.media.MediaPlayer;
import javafx.scene.media.MediaView;
import javafx.stage.Stage;
import javafx.util.Duration;

import java.io.File;

public class StoMediaExample extends Application {
   @Override
   public void start(Stage primaryStage) {
      File mediaPath = new File("./audio_video/sampleTP.mp4");
      // Create a Media object
      Media media = new Media(mediaPath.toURI().toString());
      // Create a MediaPlayer object and attach the Media object
      MediaPlayer mediaPlayer = new MediaPlayer(media);
      
      // Creating a MediaView object from the MediaPlayer Object
      MediaView viewMedia = new MediaView(mediaPlayer);
      viewMedia.setFitHeight(250);
      viewMedia.setFitWidth(450);
      
      // Create a VBox to hold the label and MediaView
      VBox root = new VBox();
      
      // Use String.valueOf to convert duration to String
      Label stopStatement = new Label("Media is playing right now");
      root.getChildren().addAll(viewMedia, stopStatement);
      
      Scene scene = new Scene(root, 550, 300);

      // Set the Scene to the Stage
      primaryStage.setScene(scene);
      primaryStage.setTitle("Example");
      primaryStage.show();

      mediaPlayer.play();

      // Schedule a stop after 10 seconds
      Duration duration = media.getDuration();
      Timeline timeline = new Timeline(new KeyFrame(Duration.seconds(10), event -> {
         mediaPlayer.stop();
         stopStatement.setText("Media has stopped");
      }));
      timeline.play();
   }

   public static void main(String[] args) {
      launch(args);
   }
}

Output

Following is the output of the code −

Example 2

In this example, we're building a JavaFX application that plays a media file using a MediaPlayer. After the media starts playing, we wait for 20 seconds, then we use the stop() method to stop the playback.

import javafx.application.Application;
import javafx.scene.Scene;
import javafx.scene.layout.StackPane;
import javafx.scene.media.Media;
import javafx.scene.media.MediaPlayer;
import javafx.scene.media.MediaView;
import javafx.stage.Stage;

import java.io.File;

public class StopExample extends Application {
   @Override
   public void start(Stage primaryStage) {
      File mediaPath = new File("./audio_video/sampleTP.mp4");
      Media media = new Media(mediaPath.toURI().toString());

      // Create a MediaPlayer object and attach the Media object
      MediaPlayer mediaPlayer = new MediaPlayer(media);
      MediaView mediaView = new MediaView(mediaPlayer);

      StackPane root = new StackPane();
      root.getChildren().add(mediaView);

      Scene scene = new Scene(root, 550, 270);

      primaryStage.setTitle("Media Player Stop Example");
      primaryStage.setScene(scene);
      primaryStage.show();

      // Start the media player
      mediaPlayer.play();

      // Stop the media player after a delay
      mediaPlayer.setOnReady(() -> {
         new Thread(() -> {
            try {
               // Simulate some processing time
               Thread.sleep(20000);
            } catch (InterruptedException e) {
               e.printStackTrace();
            }
            // Stop the media player
            mediaPlayer.stop();
         }).start();
      });
   }
   public static void main(String[] args) {
      launch(args);
   }
}

Output

Following is the output of the code, where the media will automatically stop after 20 seconds.