Screen Recording (Video) of Java Webdriver script

Sauce lab provided screen capturing functionality to test scripts execution, I was looking same type functionality to work on local machine and came up across “Monte Media Library” java based library developed by Werner Randelshofer.. In this post I have described a way to capture screen cast/ Video recording of selenium/webdriver test script execution.

Step to implement Monte Media library to selenium/Webdriver test scripts.

1. Download “MonteScreenRecorder.jar” from link http://www.randelshofer.ch/monte/
2. Add this jar file to your selenium/webdriver eclipse project.
3. This jar file contain “ScreenRecorder” class, we need to create this class object by following way.

GraphicsConfiguration gc = GraphicsEnvironment
      .getLocalGraphicsEnvironment()
      .getDefaultScreenDevice()
      .getDefaultConfiguration();


ScreenRecorder  screenRecorder = new ScreenRecorder(gc,
      new Format(MediaTypeKey, MediaType.FILE, MimeTypeKey, MIME_AVI),
      new Format(MediaTypeKey, MediaType.VIDEO, EncodingKey, ENCODING_AVI_TECHSMITH_SCREEN_CAPTURE,
              CompressorNameKey, ENCODING_AVI_TECHSMITH_SCREEN_CAPTURE,
              DepthKey, 24, FrameRateKey, Rational.valueOf(15),
              QualityKey, 1.0f, KeyFrameIntervalKey, 15 * 60),
              new Format(MediaTypeKey, MediaType.VIDEO, EncodingKey, "black",
              FrameRateKey, Rational.valueOf(30)),null);

   4. Need to call “screenRecorder.start()” methods at starting of your test scripts and "screenRecorder.stop()” at the end of execution.

   5. Below is complete test script example

package com.TestScripts;

import java.awt.*;
import java.io.File; 
import org.monte.media.Format;
import org.monte.media.math.Rational;
import org.monte.screenrecorder.ScreenRecorder;
import org.openqa.selenium.By;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.firefox.FirefoxDriver;
import static org.monte.media.AudioFormatKeys.*;
import static org.monte.media.VideoFormatKeys.*;
 
public class VideoReord {
    private ScreenRecorder screenRecorder;
   
     public static void main(String[] args) throws Exception {
                                                                  
          VideoReord  videoReord = new VideoReord();
          videoReord.startRecording();                                         
                        
          WebDriver driver = new FirefoxDriver();                                      
          driver.get("http://www.google.com");
                          
          WebElement element = driver.findElement(By.name("q"));                                       
          element.sendKeys("testing");                                      
          element.submit();                   
          System.out.println("Page title is: " +driver.getTitle());                                                                        
          driver.quit();                                
          videoReord.stopRecording();
    }
   

       public void startRecording() throws Exception
       {
                            
            GraphicsConfiguration gc = GraphicsEnvironment
               .getLocalGraphicsEnvironment()
               .getDefaultScreenDevice()
               .getDefaultConfiguration();

           this.screenRecorder = new ScreenRecorder(gc,
               new Format(MediaTypeKey, MediaType.FILE, MimeTypeKey, MIME_AVI),
               new Format(MediaTypeKey, MediaType.VIDEO, EncodingKey, ENCODING_AVI_TECHSMITH_SCREEN_CAPTURE,
                    CompressorNameKey, ENCODING_AVI_TECHSMITH_SCREEN_CAPTURE,
                    DepthKey, 24, FrameRateKey, Rational.valueOf(15),
                    QualityKey, 1.0f,
                    KeyFrameIntervalKey, 15 * 60),
               new Format(MediaTypeKey, MediaType.VIDEO, EncodingKey, "black",
                    FrameRateKey, Rational.valueOf(30)),
               null);
          this.screenRecorder.start();
        
       }

       public void stopRecording() throws Exception
       {
         this.screenRecorder.stop();
       }
}

   6. After execution test script, video file is generated under “Video” folder of current user folder in   Windows machine and “Movies” folder on Mac machine.

I am getting some comments for saving video in a desire location, I am going to update my post as Michael’s suggestion. Thanks again for his help.
If you need to save video file in desire location, then you need to override “createMovieFile” function of “ScreenRecorder” class class for creating a new folder and file. For this you need to create another class like “SpecializedScreenRecorder” and extend “ScreenRecorder” class as below:

package com.test;

import java.awt.AWTException;
import java.awt.GraphicsConfiguration;
import java.awt.Rectangle;
import java.io.File;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;
import org.monte.media.Format;
import org.monte.media.Registry;
import org.monte.screenrecorder.ScreenRecorder;

public class SpecializedScreenRecorder extends ScreenRecorder {

    private String name;

    public SpecializedScreenRecorder(GraphicsConfiguration cfg,
           Rectangle captureArea, Format fileFormat, Format screenFormat,
           Format mouseFormat, Format audioFormat, File movieFolder,
           String name) throws IOException, AWTException {
         super(cfg, captureArea, fileFormat, screenFormat, mouseFormat,
                  audioFormat, movieFolder);
         this.name = name;
    }

    @Override
    protected File createMovieFile(Format fileFormat) throws IOException {
          if (!movieFolder.exists()) {
                movieFolder.mkdirs();
          } else if (!movieFolder.isDirectory()) {
                throw new IOException("\"" + movieFolder + "\" is not a directory.");
          }
                          
          SimpleDateFormat dateFormat = new SimpleDateFormat(
                   "yyyy-MM-dd HH.mm.ss");
                        
          return new File(movieFolder, name + "-" + dateFormat.format(new Date()) + "."
                  + Registry.getInstance().getExtension(fileFormat));
    }
 }

Now you need to create object of  “SpecializedScreenRecorder” instead of creating “Screen” class object.

package com.test;

import java.awt.*;
import java.io.File;
import org.monte.media.Format;
import org.monte.media.math.Rational;
import org.monte.screenrecorder.ScreenRecorder;
import org.openqa.selenium.By;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.firefox.FirefoxDriver;
import static org.monte.media.AudioFormatKeys.*;
import static org.monte.media.VideoFormatKeys.*;

public class VideoReord {
    private ScreenRecorder screenRecorder;
 
     public static void main(String[] args) throws Exception {
                                                                
             VideoReord  videoReord = new VideoReord();
             videoReord.startRecording();                                       
                      
             WebDriver driver = new FirefoxDriver();                                    
             driver.get("http://www.google.com");
                         
             WebElement element = driver.findElement(By.name("q"));                                     
             element.sendKeys("testing");                                    
             element.submit();                   
             System.out.println("Page title is: " + driver.getTitle());                                                                       
             driver.quit();                              
             videoReord.stopRecording();
       }
 

       public void startRecording() throws Exception
       {    
              File file = new File("D:\\Videos");
                           
              Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
              int width = screenSize.width;
              int height = screenSize.height;
                            
              Rectangle captureSize = new Rectangle(0,0, width, height);
                            
            GraphicsConfiguration gc = GraphicsEnvironment
               .getLocalGraphicsEnvironment()
               .getDefaultScreenDevice()
               .getDefaultConfiguration();

           this.screenRecorder = new SpecializedScreenRecorder(gc, captureSize,
               new Format(MediaTypeKey, MediaType.FILE, MimeTypeKey, MIME_AVI),
               new Format(MediaTypeKey, MediaType.VIDEO, EncodingKey, ENCODING_AVI_TECHSMITH_SCREEN_CAPTURE,
                    CompressorNameKey, ENCODING_AVI_TECHSMITH_SCREEN_CAPTURE,
                    DepthKey, 24, FrameRateKey, Rational.valueOf(15),
                    QualityKey, 1.0f,
                    KeyFrameIntervalKey, 15 * 60),
               new Format(MediaTypeKey, MediaType.VIDEO, EncodingKey, "black",
                    FrameRateKey, Rational.valueOf(30)),
               null, file, "MyVideo");
          this.screenRecorder.start();
      
       }

       public void stopRecording() throws Exception
       {
         this.screenRecorder.stop();
       }
}

Above code explanation: Create a File class object and pass path where you want to save your video

   File file = new File("D:\\Videos");

Create dimension of your screen to capture video, I have created object for default screen.

   Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();

   int width = screenSize.width;

   int height = screenSize.height;

                            

    Rectangle captureSize = new Rectangle(0,0, width, height);

Now Create object of “SpecializedScreenRecorder” and pass Rectangle object, File object, and file name as a last argument and rest are same.
Run your test, you will see that a video will generate under your desire location.