PHP Screen Recorder: Capture videos of the current screen with ffmpeg

Recommend this page to a friend!

Picture of Dawood Ikhlaq
Name: Dawood Ikhlaq <contact>
Classes: 6 packages by
Country: Italy Italy
Age: 26
All time rank: 224288 in Italy Italy
Week rank: 80 5 in Italy Italy
Innovation award
Innovation award
Nominee: 3x

  Detailed description   Download .zip .tar.gz   Install with Composer  
This class can capture videos of the current screen with ffmpeg.

It executes the ffmpeg program passing some options to configure details of the recording such as the screen size to capture.

The video file is saved to a configurable file in Flash Video.


PHP Screen Recorder

A lightweight php wrapper around ffmpeg to record the screen, best for recording your acceptance tests using selenium, it's easy to use and clean OOP interface.


I was given a task to make an acceptance test suite which included recording videos of the tests. I was using selenium for the task and for the video recording, however, I was unable to find an elegant solution which is why i created this library.


One of the best features of this library is its ease of use.

The startRecording method is called when the user wants to start the recording after which this library will start the video recording in the background. When the user has completed their task they can call stopRecording to stop the recording .


The library is easily installed as a package through composer:

composer require dawood/phpscreenrecorder

that's it, nothing else is required for the installation


There are examples provided in examples folder as well.

Make sure, that you include the composer autoloader somewhere in your codebase.

Capture the screen

include "../vendor/autoload.php";

use dawood\PhpScreenRecorder\ScreenRecorder;

$screenRecorder=new ScreenRecorder();

sleep(5+2);//doing random stuff
//when done stop recording

print "video is saved at :\"".$screenRecorder->getVideo().'"'.PHP_EOL;

Selenium test example

public function testLoginUserCorrectly()
    $loginInput = [
        'username' => 'test',
        'password' => 'password'
        ->submitForm("#loginform > form",$loginInput)


Setting options

The ffmpeg shell command can accept different options: for a complete list of options you can visit:

Wrapper Methods

* setOptions accepts the options in the array. You can provide any option in following way:


> Note: you have to write complete option including "-" , i had to do this way because there are some options which need "-" this and some which not so it's difficult to know for which option i have to set that that's why you have to provide complete option.

  • `setScreenSizeToCapture` screen size to capture, it accepts two arguments the first being the width and other being the height.
  • `startRecording` call this method after you have set all the desired options, this will start the screen recording. The method accepts two optional arguments, firstly the desired location to save the video file and secondly the number of seconds to sleep after starting the process. This is useful because ffmpeg takes 1-2 seconds to start the recording, the default value for this is 2 seconds. You can may change this according to your requirements.
  • `stopRecording` this will stop the screen recording. The method can also take one optional argument, the number of seconds to sleep after starting the process. This is useful because ffmpeg takes 1-2 seconds to start the recording.
  • `getVideo` returns the saved video file.
  • `setBinary` for this library you do not require any binary as everything is already included, however, if you need to use any other binary you can provide it using this method.
  • `getCommandToRun` returns the generated command that will be executed by library. This is useful to check how you have set the options or to debug.
  • `getOptions` returns an array of all the set options.
  • `getBinary` returns the currently set binary file i.e ffmpeg.


The PHP Screen Recorder is open-sourced software licensed under the MIT license.


Thanks to all of the contributors , fork this repository and send me a pull request


Dawood Ikhlaq and Open source community

  Classes of Dawood Ikhlaq  >  PHP Screen Recorder  >  Download .zip .tar.gz  >  Support forum (5)  >  Blog  >  Latest changes  
Name: PHP Screen Recorder
Base name: phpscreenrecorder
Description: Capture videos of the current screen with ffmpeg
Version: 1.0.1
PHP version: 5
License: MIT/X Consortium License
All time users: 371 users
All time rank: 6681
Week users: 3 users
Week rank: 68
  Groups   User ratings   Applications   Files  

PHP 5 Classes using PHP 5 specific features View top rated classes
Graphics Colors, images, charts and picture formats View top rated classes
Debug Debug data dumping, bug detection and reporting View top rated classes
Audio Voice and music data generation and manipulation View top rated classes
Video Movies and video data generation and manipulation View top rated classes

  Innovation Award  
PHP Programming Innovation award nominee
August 2017
Number 2

Prize: PhpStorm IDE 1 year individual subscription
Capturing videos from the user computer screen is useful to help developers understand the way users are interacting with their applications.

This class can capture the current screen by using the ffmpeg program.

Manuel Lemos

  User ratings  
RatingsUtility Consistency Documentation Examples Tests Videos Overall Rank
All time: Good (91%) Good (83%) Good (83%) Good (83%) - - Sufficient (70%) 351
Month: Not yet rated by the users

  Applications that use this package  
No pages of applications that use this class were specified.

If you know an application of this package, send a message to the author to add a link here.

File Role Description
examples (1 file)
src (1 file)
tests (1 file)
composer.json Data Auxiliary data
phpunit.xml Data Auxiliary data Doc. Documentation

  Files  /  examples  
File Role Description
   index.php Example Example script

  Files  /  src  
File Role Description
   ScreenRecorder.php Class Class source

  Files  /  tests  
File Role Description
   ScreenRecorderTestSuite.php Class Class source

Install with Composer - Download all files: phpscreenrecorder.tar.gz
NOTICE: if you are using a download manager program like 'GetRight', please Login before trying to download this archive.

For more information send a message to info at phpclasses dot org.