~kazam-team/kazam/stable

30 by rugby471 at gmail
moved frontend and backend stuff into separate dirs
1
           Kazam v1.4.4 "NCC-80102"
138 by David Klasinc
Version bump in the readme file.
2
98.1.6 by David Klasinc
Merged Oneiric and Gstreamer changes.
3
4
Introduction
5
------------
6
7
Kazam is a simple screen recording program that will capture the content
8
of your screen and record a video file that can be played by any video
9
player that supports VP8/WebM video format.
10
11
Optionally you can record sound from any sound input device that is
12
supported and visible by PulseAudio.
13
14
15
Latest version
16
--------------
17
18
Kazam is always available from Launchpad under https://launchpad.net/kazam
19
20
Latest stable release is 1.4.4.
138 by David Klasinc
Version bump in the readme file.
21
Latest unstable release is 1.3.99
98.25.4 by David Klasinc
Update of release files.
22
98.1.150 by David Klasinc
Readme & co. changes.
23
24
Installation - stable release
25
-----------------------------
26
27
If you are using Ubuntu 14.04 or 13.10 then stable version (1.0.x)
138 by David Klasinc
Version bump in the readme file.
28
is available from universe repository. You can find it in Ubuntu Softare
98.1.88 by David Klasinc
Some code cleanup, added system detection.
29
Center or install it from the terminal with the following command:
30
31
$ sudo apt-get install kazam
32
33
For other Ubuntu based distributions the best way to install Kazam is
98.25.4 by David Klasinc
Update of release files.
34
to add a PPA repository and then use apt-get command or Software Center.
35
98.1.88 by David Klasinc
Some code cleanup, added system detection.
36
$ sudo add-apt-repository ppa:kazam-team/stable-series
37
$ sudo apt-get update
38
$ sudo apt-get install kazam
39
98.1.6 by David Klasinc
Merged Oneiric and Gstreamer changes.
40
For distribution independent installation you will have to get the latest
41
tarball release from Launchpad:
98.1.64 by David Klasinc
README and config fixes.
42
43
http://launchpad.net/kazam/stable/1.4.4/+download/kazam_1.4.4.tar.gz
138 by David Klasinc
Version bump in the readme file.
44
98.1.64 by David Klasinc
README and config fixes.
45
Unpack it and then run setup:
46
47
   $ tar -xzf kazam_1.4.4.tar.gz
138 by David Klasinc
Version bump in the readme file.
48
   $ cd kazam-1.4.4
49
98.1.64 by David Klasinc
README and config fixes.
50
Run installation as root user, or use sudo:
51
52
   # python3 setup.py install
122.1.2 by David Klasinc
Version bump info.
53
98.1.64 by David Klasinc
README and config fixes.
54
98.1.232 by David Klasinc
Added transparency issues description to README.
55
Installation - unstable version
98.25.4 by David Klasinc
Update of release files.
56
-------------------------------
57
58
Installing current unstable build from a PPA can be done by adding
59
unstable series PPA.
60
61
$ sudo add-apt-repository ppa:kazam-team/unstable-series
62
$ sudo apt-get update
63
$ sudo apt-get install kazam
64
65
98.1.64 by David Klasinc
README and config fixes.
66
Installation - development version
98.1.150 by David Klasinc
Readme & co. changes.
67
----------------------------------
68
69
If you want bleeding edge, development version then you will have to get
98.1.64 by David Klasinc
README and config fixes.
70
source code from Launchpad by running the following command:
98.1.6 by David Klasinc
Merged Oneiric and Gstreamer changes.
71
72
   $ bzr branch lp:kazam
73
74
Then you need to run setup.py to build and install Kazam:
75
76
   $ cd kazam
77
   # python3 setup.py install
122.1.2 by David Klasinc
Version bump info.
78
98.1.6 by David Klasinc
Merged Oneiric and Gstreamer changes.
79
You will have to run setup as root user or use sudo. Default installation
80
path is /usr/local.
81
82
83
Running Kazam
98.7.1 by David Klasinc
Added info how to run kazam from source tree.
84
-------------
85
86
If you want to run Kazam from the source tree, there are a few limitations
87
that you have to take into account. Every icon has to be taken from
98.25.4 by David Klasinc
Update of release files.
88
currently installed icon theme. Toolbars will not show any icons and you
89
will not see Unity AppIndicator.
90
98.7.1 by David Klasinc
Added info how to run kazam from source tree.
91
To run Kazam simply execute te following commands in the source tree:
92
93
$ cd bin
94
$ ./kazam
95
96
If you already have Kazam installed then Kazam icons will be displayed
98.25.4 by David Klasinc
Update of release files.
97
properly.
98
98.7.1 by David Klasinc
Added info how to run kazam from source tree.
99
98.1.232 by David Klasinc
Added transparency issues description to README.
100
Keyboard shortcuts
98.1.109 by David Klasinc
Additional fixes for lp:983827.
101
------------------
102
103
SUPER-CTRL-Q - Quit
104
SUPER-CTRL-W - Show/Hide main window
105
SUPER-CTRL-R - Start Recording
106
SUPER-CTRL-F - Finish Recording
107
108
Keyboard shortcuts will work on Precise Pangolin only if you installed
98.1.304 by David Klasinc
Fix for not working framerate setting.
109
Kazam 1.4.x from the PPA, keybinder 3.0 is a dependency and will be installed
110
automatically.
111
98.1.150 by David Klasinc
Readme & co. changes.
112
For Ubuntu 12.10 and newer keyboard binder is available in the universe
98.1.304 by David Klasinc
Fix for not working framerate setting.
113
repositories and there is no need to use PPA to get keybinder installed.
114
98.1.191 by David Klasinc
Desktop file changes.
115
98.1.232 by David Klasinc
Added transparency issues description to README.
116
Recording Tips
98.1.306 by David Klasinc
Refactored constants.py into prefs.py and fixed one issue with audio volume.
117
--------------
118
119
Framerates above 20fps are unlikely to work well because of software and
120
hardware limitations. If you increase framerate and framerate in
121
resulting video drops, that is because encoder can't keep up.
122
123
Always do a sound check. Especially if you are recording a live commentary
124
with background sound. I got the best results when I used earphones to listen
125
to the audio while recording. This way your mic will not pick up any audio
126
coming from speakers.
127
128
If you _really_ want loss-less quality, then you will have to record in RAW
129
format. This is possible, but without an SSD with a lot of free space your
130
results will be terrible. 1920x1080 at 15 frames per second will need
131
around 45 MB of disk space per second. Most people will want to record at
132
20 or 25 frames per second. Most disk will not handle that and your
133
system will start to crawl.
134
135
Your next best bet is HUFFYUV format, which is a little bit friendlier on
136
disk bandwidth with 28 MB per second at 15 frames per second. The problem?
137
Not many video editors and players can handle HUFFYUV, let alone video
138
sharing services.
139
140
141
Known Issues
98.1.6 by David Klasinc
Merged Oneiric and Gstreamer changes.
142
------------
143
144
- Trouble with recording audio from certain Monitor sources. I noticed
98.25.4 by David Klasinc
Update of release files.
145
this with Logitech G110 USB Keyboard that can play audio. Pulse
146
Audio will see two devices: USP PnP Stereo Device and 'Monitor of USB PnP
147
Stereo Device'. When recording from the monitor, volume controls for
148
both devices will affect the volume in the final recording.
149
98.1.40 by David Klasinc
A minor fix to region recording.
150
- I have no idea where to put Mute/Unmute button, so right now every audio
98.1.150 by David Klasinc
Readme & co. changes.
151
source you select is automatically unmuted.
152
98.1.41 by David Klasinc
Lots of debug info added and few other minor changes.
153
- It was reported that sound is disappearing after couple of minutes into
107.1.1 by David Klasinc
Release preparation for 1.2.1.
154
the recording. I wasn't able to reproduce this bug and any more info is
155
appreciated. See https://bugs.launchpad.net/kazam/+bug/933835 for more
156
details.
157
98.1.41 by David Klasinc
Lots of debug info added and few other minor changes.
158
- Two memory leaks were noticed, one with VP8 encoder and one with Intel
98.1.220 by David Klasinc
Updated README.
159
graphics cards. Still investigating if this is a driver, Xorg or
160
GStreamer problem.
161
162
- Non compositing window managers are not able to render transparent
98.1.232 by David Klasinc
Added transparency issues description to README.
163
windows. Area selection and countdown timers will be affected by this.
164
Mint users can turn on window compositing in Desktop Settings.
165
166
- When taking a screenshot of a preselected window with window decorations
98.1.306 by David Klasinc
Refactored constants.py into prefs.py and fixed one issue with audio volume.
167
you have to make sure that your window is not covered by other windows.
122.1.2 by David Klasinc
Version bump info.
168
169
98.1.232 by David Klasinc
Added transparency issues description to README.
170
98.1.43 by David Klasinc
Version changes.
171
Debugging & reporting problems
172
------------------------------
173
174
If you encounter a bug or any kind of unexpected behavior please try to
175
reproduce it while you run Kazam from standard terminal with --debug option.
176
Use Launchpad to report bugs (https://bugs.launchpad.net/kazam/+filebug) and
177
include generated output.
98.1.150 by David Klasinc
Readme & co. changes.
178
102 by David Klasinc
Version bump before stable release.
179