Content-type: text/html
Man page of KINETOPHONE
KINETOPHONE
Section: User Commands (1)
Updated: June 10, 2013
Index
Return to Main Contents
NAME
kinetophone_narrator - GUI for narration over still images
SYNOPSIS
kinetophone_narrator
--help
kinetophone_narrator
--list-devices
kinetophone_narrator [
image_directory
|
PDF_file
[
output_file
]
] [
flags
]
DESCRIPTION
The
kinetophone_narrator
program captures voice-over narration for images using a graphical
user interface. The program is part of the Kinetophone sound
recording and narration system. It produces a sound recording and
session information which can be used for creating video footage by
the Kinetophone builder program.
The source of images can either be a directory of still images (in
TIFF, JPG, and other common image formats) or a PDF file. The user
can enter notes for each slide using the GUI and import/export notes
through the saved session file. The narrator will use text
annotations from a PDF file as notes, if present.
When using a PDF as an image source, the pages are displayed in order.
For a directory, the order of the images in the viewer can be
controlled by the name of the images in the directory, which are
sorted in increasing alphanumeric order (increasing order: 0-9, A-Z,
and a-z).
The program can use JACK, OSS, or ALSA audio devices.
OPTIONS
Use
kinetophone_narrator
-h
to get a complete list of command line and configuration file options.
CONFIGURATION FILE
By default, if you have a
~/.kinetophone
file the program will parse it for options. This file is used among
all the programs in the Kinetophone project. You can also specify a
configuration file with
-i
or
--config
on the command line. Options should be specified one per
line, with the same syntax as the command line except for any leading
dashes. For example, when the following line is present in the
configuration file:
audio-info=yes
Kinetophone narrator will show details of the audio recording in
the status area of the main window.
OPTION PRECEDENCE
You may specify (valid) combinations of command line and configuration
file options. Command line options override configuration file
options.
KEYBOARD CONTROL SHORTCUTS
The following keyboard shortcuts allow you to control the program's
GUI from the keyboard (some are only active in certain modes, such as
when recording):
CTRL-l -- reset level meter clipped indicator (when recording is
enabled only)
CTRL-m -- toggle muting of sound input (when recording is enabled
only)
CTRL-o -- reset overflow counts (displayed in the status area at the
bottom, when present)
CTRL-p -- toggle pause (when recording only)
CTRL-r -- toggle recording (when recording is enabled only)
CTRL-<right arrow> -- next slide
CTRL-<left arrow> -- previous slide
CTRL-<backspace> -- retake slide (when recording only)
EXIT STATUS
Exits with 0 on success, non-zero (the Kinetophone error code) on
failure.
NOTES
PERFORMANCE
Kinetophone narrator is a "soft" real-time program. To get the best
performance from Kinetophone narrator, try to minimize unnecessary
programs and services running while recording. Temporarily disable
sleep and screen saver features to avoid interrupting the program.
Use the
-O
option to show input/output overflow (dropout) counts.
The JACK audio subsystem has features which allow changing the
priority and scheduling policy for the input thread used by
Kinetophone narrator. Such changes might also improve the performance
of Kinetophone when using JACK devices. See the JACK documentation
for further details.
BUGS
When accessing an input device already in use, the program outputs
"Invalid number of channels" rather than the appropriate message.
EXAMPLE
The command:
kinetophone_narrator
-D /data/project1/images -d 3 -t aiff -s 48000 -c 2
will record from audio device number 3 and output to a new temporary
sound file, with images taken from /data/project1/images. The
temporary sound file will be in AIFF format with 16 bit samples at
48000 stereo samples per second. Device numbers can be obtained using
kinetophone_narrator
--list-devices
AUTHOR
This man page was written by the Roan Trail, Inc. development team.
SEE ALSO
kinetophone_builder
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- OPTIONS
-
- CONFIGURATION FILE
-
- OPTION PRECEDENCE
-
- KEYBOARD CONTROL SHORTCUTS
-
- EXIT STATUS
-
- NOTES
-
- PERFORMANCE
-
- BUGS
-
- EXAMPLE
-
- AUTHOR
-
- SEE ALSO
-
This document was created by
man2html,
using the manual pages.
Time: 20:14:20 GMT, April 06, 2014