Skip to content

Latest commit

 

History

History
77 lines (45 loc) · 1.89 KB

README.md

File metadata and controls

77 lines (45 loc) · 1.89 KB

Castro

Screen recording library for Node

Awesome features!

  • Uses the AV Foundation framework to record the highest-quality video you possibly could record.

  • Records in the popular MPEG-4 file format.

  • Simple API. Start and stop -- that's all you need to know!

  • Automation friendly. Combine with test automation tools like Appium or Selenium to record movies of your tests. Screen recordings can be useful for debugging test failures.

  • Open source. (MIT License)

Install

npm install castro

Example usage

castro = require('castro')
movie = new castro.Castro()
movie.start()
// Do something awesome
movie.stop()

Where's my movie?

Movies are stored on the Desktop...

> movie.location
'/Users/hugs/Desktop/Castro_5wmi.mp4'

In other words:
'<home>/Desktop/Castro_<short_random_string>.mp4'

... but you can change the location before you start recording.

> movie = new castro.Castro()
> movie.setLocation('/Users/me/epic-movies/totes-epic.mp4')
> movie.start()

Requirements

Castro was tested with:

$ node -v
v4.5.0

$ sw_vers
ProductName:	Mac OS X
ProductVersion:	10.11.6
BuildVersion:	15G1004

Only works on OS X for now.

Example movies recorded with Castro

Castro