Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ColumPaget/screenrecord.lua
simple ffmpeg screenrecord tool written in lua
https://github.com/ColumPaget/screenrecord.lua
ffmpeg lua screenrecord streaming
Last synced: about 2 months ago
JSON representation
simple ffmpeg screenrecord tool written in lua
- Host: GitHub
- URL: https://github.com/ColumPaget/screenrecord.lua
- Owner: ColumPaget
- License: gpl-3.0
- Created: 2020-07-12T17:24:46.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-08-17T14:19:57.000Z (about 1 year ago)
- Last Synced: 2024-04-16T02:42:35.840Z (6 months ago)
- Topics: ffmpeg, lua, screenrecord, streaming
- Language: Lua
- Size: 166 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SYNOPSIS
========
screenrecord.lua is a lua script that launches an ffmpeg process for screen-recording on xorg/X11. It can also record audio, with or without screen recording, using OSS, ALSA or PulseAudio (ALSA is recommended). For GUI it utilizes either zenity, yad, qarma or a simple text-based interface. Alternatively it can be completely configured at the command-line using the '-N' option. It requires libuseful (https://github.com/ColumPaget/libUseful) and libUseful-lua (https://github.com/ColumPaget/libUseful-lua) to be installed.
screenrecord.lua autodetects the gui-types that are available, and to some extent OSS, ALSA and PulseAudio sources that are available (though some of these may not work, as for many devices it's not easy to detect if the input is mono or stereo, and so both are offered but one will fail).
Qarma (https://github.com/luebking/qarma) seems to offer the best ui-experience of the dialog-apps.
AUTHOR
======
screenrecord.lua is (C) 2021 Colum Paget. It is released under the GPLv3 so you may do anything with them that the GPL allows.
Email: [email protected]
INSTALL
=======
The screenrecord.lua code is broken up into a number of submodules, with a simple makefile that concats these together into 'screenrecord.lua'. The resulting 'screenrecord.lua' can then be run by lua. So the default install is:
```
make
make install
```
the file 'screenrecord.lua' is the actual 'program' to be run by lua and is installed in '/usr/local/bin' by default. You can manually copy it to someplace else if you want. it can either be run as:
```
lua screenrecord.lua
```
or you can use linux's binfmt system to automatically invoke lua when the program is run.
USAGE
=====
lua screencast.lua [options]
OPTIONS
=======
```
-N no ui, just honor command-line arguments
-ui specify ui type to use. Values are qarma, zenity, yad or text
-s specify recording window size
-size specify recording window size
-fps frames per second to record at
-c seconds of countdown before recoding starts
-count seconds of countdown before recoding starts
-countdown seconds of countdown before recoding starts
-C list codecs supported by ffmpeg
-list-codecs list codecs supported by ffmpeg
-L list audio inputs supported by ffmpeg
-list-audio list audio inputs supported by ffmpeg
-codec name (e.g. 'mp4:h264:aac', 'ogv:flac') of codec to use
-a name (e.g. 'alsa:1:s', 'oss:0:m') of sound-input to use
-audio name (e.g. 'alsa:1:s', 'oss:0:m') of sound-input to use
-sound name (e.g. 'alsa:1:s', 'oss:0:m') of sound-input to use
-noise enable audio noise reduction
-nr enable audio noise reduction
-region show capture region
-follow 'follow mouse', either 'centered' or 'edge'
-outdir path to directory to store recordings in
-o full path to recording file to create
-? this help
-help this help
--help this help
--help this help
-version print program version
--version print program version
```