Thavarshan / xoomp

A PHP video thumbnail generator.

Xoomp PHP Video Thumbnail Generator

Xoomp is a simple PHP package that generates a thumbnail image of a given video file. This is done by scanning the video and capturing a single frame of it at a set or random time.

Getting Started

Installing

Xoomp is easy to install into your project. simply install xoomp by using composer to pull it in and it's dependencies.

composer require thavarshan/xoomp

Basic Usage

$thumbnail = new Xoomp\Thumbnail();

$thumbnailLocation = '/path/where/thumbnail/should/be/saved';
$video = '/path/where/video/file/is/saved.mp4';

$thumbnail->from($video)
          ->saveTo($thumbnailLocation)
          ->generate();

Running the tests

Xoomp uses PHPUnit for testing. To clone xoomp into your local machine and run tests, simple open up your prefered terminal application, navigate into xoomp project root directory and run the following command..

git clone [e-mail]:Thavarshan/xoomp.git
cd xoomp
composer install
vendor/bin/phpunit

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

• Thavarshan Thayananthajothy - Initial work - Thavarshan

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details