|image0| Kazam - Linux Desktop Screen Recorder and Broadcaster
==================================================================
|Documentation Status| |CodeCov| |Github release| |lic|
Kazam is a simple screen recording program that will capture the content of your screen and record a video file that can be played by any video player that supports VP8/WebM video format. Optionally you can record sound from any sound input device that is supported and visible by PulseAudio.
📌 **Please use the latest version kazam 1.5.8. Make sure the version is the latest when you report issues.**
📥 Installation
============================
.. code:: bash
pip install -U kazam
Kazam need some dependency libraries like `dbus`, `cairo` to work, in Ubuntu 22.04, you can use the following command to install them:
.. code:: bash
sudo apt install build-essential libpython3-dev \
libdbus-1-dev libcairo2-dev libgirepository1.0-dev \
gir1.2-gudev-1.0 gir1.2-keybinder-3.0 python3-gi python3-gst-1.0 -y
In Ubuntu 20.04, make sure pulseaudio gstream plugin is installed, if not, run:
.. code:: bash
sudo apt reinstall gstreamer1.0-pulseaudio -y
🧸 Screenshot
============================
.. figure:: https://github.com/henrywoo/kazam/blob/master/img/Kazam_001.png?raw=true
:alt: Kazam GUI Screenshot
.. figure:: https://github.com/henrywoo/kazam/blob/master/img/Kazam_002.png?raw=true
:alt: Kazam Preferences Screenshot
💎 Running Kazam
============================
From Source Code
~~~~~~~~~~~~~~~~~~~~~~
If you want to run Kazam from the source tree, there are a few limitations that you have to take into account. Every icon has to be taken from currently installed icon theme. Toolbars will not show any icons and you will not see Unity AppIndicator.
To run Kazam simply execute te following commands in the source tree:
.. code:: bash
$ pip install -r requirements.txt
$ cd bin
$ ./kazam
From Command Line
~~~~~~~~~~~~~~~~~~~~~~
Make sure **~/.local/bin** into you PATH, and run `kazam` in your terminal should work.
🔮 From GUI
~~~~~~~~~~~~~~~~~~~~~~
If you already have Kazam installed then Kazam icons will be displayed properly.
⌨️ Keyboard shortcuts
============================
.. code:: bash
SUPER-CTRL-Q - Quit
SUPER-CTRL-W - Show/Hide main window
SUPER-CTRL-R - Start Recording
SUPER-CTRL-F - Finish Recording
In a normal logitech keyboard, SUPER-CTRL is Ctrl+CMD.
💡 Recording Tips
============================
Choose small numerb of framerate. My personal setup is framerate equal to 3. Framerates above 20fps are unlikely to work well because of software and hardware limitations. If you increase framerate and framerate in resulting video drops, that is because encoder can't keep up.
Always do a sound check. Especially if you are recording a live commentary with background sound. I got the best results when I used earphones to listen to the audio while recording. This way your mic will not pick up any audio coming from speakers.
If you _really_ want loss-less quality, then you will have to record in RAW format. This is possible, but without an SSD with a lot of free space your results will be terrible. 1920x1080 at 15 frames per second will need around 45 MB of disk space per second. Most people will want to record at 20 or 25 frames per second. Most disk will not handle that and your
system will start to crawl.
Your next best bet is HUFFYUV format, which is a little bit friendlier on disk bandwidth with 28 MB per second at 15 frames per second. The problem? Not many video editors and players can handle HUFFYUV, let alone video sharing services.
💣 Debugging & reporting problems
========================================================
If you encounter a bug or any kind of unexpected behavior please try to reproduce it while you run Kazam from standard terminal with --debug option. Please report bugs at (https://github.com/henrywoo/kazam/issues) and include generated output.
----
.. |image0| image:: https://raw.githubusercontent.com/henrywoo/kazam/master/kazam.png
.. |Documentation Status| image:: https://readthedocs.org/projects/hiq/badge/?version=latest
:target: https://hiq.readthedocs.io/en/latest/?badge=latest
.. |CodeCov| image:: https://codecov.io/gh/uber/athenadriver/branch/master/graph/badge.svg
:target: https://hiq.readthedocs.io/en/latest/index.html
.. |Github release| image:: https://img.shields.io/badge/release-v1.5.8-red
:target: https://github.com/uber/athenadriver/releases
.. |lic| image:: https://img.shields.io/badge/License-Apache--2.0-red
:target: https://github.com/uber/athenadriver/blob/master/LICENSE
Raw data
{
"_id": null,
"home_page": "https://github.com/henrywoo/kazam",
"name": "kazam",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "screencast screenshot capture audio sound video recorder kazam",
"author": "Henry Fuheng Wu, David Klasinc",
"author_email": "wufuheng@gmail.com",
"download_url": null,
"platform": null,
"description": "|image0| Kazam - Linux Desktop Screen Recorder and Broadcaster\n==================================================================\n\n|Documentation Status| |CodeCov| |Github release| |lic|\n\n\nKazam is a simple screen recording program that will capture the content of your screen and record a video file that can be played by any video player that supports VP8/WebM video format. Optionally you can record sound from any sound input device that is supported and visible by PulseAudio.\n\n\n\ud83d\udccc **Please use the latest version kazam 1.5.8. Make sure the version is the latest when you report issues.**\n\n\n\ud83d\udce5 Installation\n============================\n\n.. code:: bash\n\n pip install -U kazam\n\n\nKazam need some dependency libraries like `dbus`, `cairo` to work, in Ubuntu 22.04, you can use the following command to install them:\n\n.. code:: bash\n\n sudo apt install build-essential libpython3-dev \\\n libdbus-1-dev libcairo2-dev libgirepository1.0-dev \\\n gir1.2-gudev-1.0 gir1.2-keybinder-3.0 python3-gi python3-gst-1.0 -y\n\n\nIn Ubuntu 20.04, make sure pulseaudio gstream plugin is installed, if not, run:\n\n.. code:: bash\n\n sudo apt reinstall gstreamer1.0-pulseaudio -y\n\n\n\ud83e\uddf8 Screenshot\n============================\n\n.. figure:: https://github.com/henrywoo/kazam/blob/master/img/Kazam_001.png?raw=true\n :alt: Kazam GUI Screenshot\n\n\n.. figure:: https://github.com/henrywoo/kazam/blob/master/img/Kazam_002.png?raw=true\n :alt: Kazam Preferences Screenshot\n\n\n\n\ud83d\udc8e Running Kazam\n============================\n\nFrom Source Code\n~~~~~~~~~~~~~~~~~~~~~~\n\nIf you want to run Kazam from the source tree, there are a few limitations that you have to take into account. Every icon has to be taken from currently installed icon theme. Toolbars will not show any icons and you will not see Unity AppIndicator.\n\nTo run Kazam simply execute te following commands in the source tree:\n\n.. code:: bash\n\n $ pip install -r requirements.txt\n $ cd bin\n $ ./kazam\n\n\nFrom Command Line\n~~~~~~~~~~~~~~~~~~~~~~\n\nMake sure **~/.local/bin** into you PATH, and run `kazam` in your terminal should work.\n\n\n\ud83d\udd2e From GUI\n~~~~~~~~~~~~~~~~~~~~~~\nIf you already have Kazam installed then Kazam icons will be displayed properly.\n\n\n\u2328\ufe0f Keyboard shortcuts\n============================\n\n.. code:: bash\n\n SUPER-CTRL-Q - Quit\n SUPER-CTRL-W - Show/Hide main window\n SUPER-CTRL-R - Start Recording\n SUPER-CTRL-F - Finish Recording\n\nIn a normal logitech keyboard, SUPER-CTRL is Ctrl+CMD.\n\n\n\n\ud83d\udca1 Recording Tips\n============================\n\nChoose small numerb of framerate. My personal setup is framerate equal to 3. Framerates above 20fps are unlikely to work well because of software and hardware limitations. If you increase framerate and framerate in resulting video drops, that is because encoder can't keep up.\n\nAlways do a sound check. Especially if you are recording a live commentary with background sound. I got the best results when I used earphones to listen to the audio while recording. This way your mic will not pick up any audio coming from speakers.\n\nIf you _really_ want loss-less quality, then you will have to record in RAW format. This is possible, but without an SSD with a lot of free space your results will be terrible. 1920x1080 at 15 frames per second will need around 45 MB of disk space per second. Most people will want to record at 20 or 25 frames per second. Most disk will not handle that and your\nsystem will start to crawl.\n\nYour next best bet is HUFFYUV format, which is a little bit friendlier on disk bandwidth with 28 MB per second at 15 frames per second. The problem? Not many video editors and players can handle HUFFYUV, let alone video sharing services.\n\n\n\n\ud83d\udca3 Debugging & reporting problems\n========================================================\n\nIf you encounter a bug or any kind of unexpected behavior please try to reproduce it while you run Kazam from standard terminal with --debug option. Please report bugs at (https://github.com/henrywoo/kazam/issues) and include generated output.\n\n\n----\n\n.. |image0| image:: https://raw.githubusercontent.com/henrywoo/kazam/master/kazam.png\n.. |Documentation Status| image:: https://readthedocs.org/projects/hiq/badge/?version=latest\n :target: https://hiq.readthedocs.io/en/latest/?badge=latest\n.. |CodeCov| image:: https://codecov.io/gh/uber/athenadriver/branch/master/graph/badge.svg\n :target: https://hiq.readthedocs.io/en/latest/index.html\n.. |Github release| image:: https://img.shields.io/badge/release-v1.5.8-red\n :target: https://github.com/uber/athenadriver/releases\n.. |lic| image:: https://img.shields.io/badge/License-Apache--2.0-red\n :target: https://github.com/uber/athenadriver/blob/master/LICENSE\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A screencasting program created with design in mind.",
"version": "1.5.8",
"project_urls": {
"Homepage": "https://github.com/henrywoo/kazam"
},
"split_keywords": [
"screencast",
"screenshot",
"capture",
"audio",
"sound",
"video",
"recorder",
"kazam"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7ec3c309b3b6a8f383b7836d804fd60be043e78e84797a5b3bfc03e687aa15f4",
"md5": "695ec6aa30e26123e56c2d09b29cab5d",
"sha256": "e78a88f21b85a2bee167f03ef4ce201331a26aaf6ac289bff3c929b16eb7bb11"
},
"downloads": -1,
"filename": "kazam-1.5.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "695ec6aa30e26123e56c2d09b29cab5d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 325927,
"upload_time": "2024-04-21T03:49:12",
"upload_time_iso_8601": "2024-04-21T03:49:12.126570Z",
"url": "https://files.pythonhosted.org/packages/7e/c3/c309b3b6a8f383b7836d804fd60be043e78e84797a5b3bfc03e687aa15f4/kazam-1.5.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-21 03:49:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "henrywoo",
"github_project": "kazam",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "kazam"
}
JSON
