Jürgen Kofler <kaffeine@gmx.net>
Revision 0.04.03
Copyright © 2004, 2004 Jürgen Kofler
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".
A xine based Media Player. http://kaffeine.sourceforge.net
Table of Contents
Kaffeine is a xine-based media player.
xine is a free multimedia player. It plays back CDs, DVDs, and VCDs. It also decodes multimedia files like AVI, MOV, WMV, and MP3 from local disk drives, and displays multimedia streamed over the Internet. It interprets many of the most common multimedia formats available - and some of the most uncommon formats, too. Detailed info about xine features you can find at: http://www.xinehq.de
Full Drag and Drop support for video window and playlist (from Konqueror, Mozilla, ...) You can also drop directories and playlist files. Following types should be auto detected: Kaffeine-playlists, Noatun-playlists, m3u-, asx- and pls-files.
Editable playlist (moving entries, copy and paste, ...)
mp3/ogg tags and length informations will be read on loading
The possibility to save a stream as local file
Support for (multiple) external subtitles (with autoloading)
Simple access to DVD menus
Network Broadcasting
A config dialog for xine's postprocessing filters
A profile file for kdelirc (KDE 3.2)
Full mouse wheel support
Bookmark editor
Support for saving screenshots in different formats
The ability to prevent screensaver from activating
OSD titles
Konqueror Plugin
Mozilla Starter Plugin
Equalizer
A system tray (accept drops from Konqueror)
A small left-click panel for fullscreen and minimal mode
Use tvtime plugin for deinterlacing
All shortcuts are configurable
Many translations
use mouse wheel to navigate through the stream
middle click toggles between fullscreen/windowed mode
in fullscreen or minimal mode: left click for context menu and right click for a small control panel
you can use arrow keys and Enter in DVD menus
Open Use Ctrl+Left to select more than one file. Can also be playlist files of a supported format.
Open URL
Open Recent Here you can find the last played files/URLs.
Save Screenshot You can select the formats PNG, BMP and XBM.
Quit
Endless Play Don't stop at the last playlist-entry.
Random Play Plays playlist-entrys in random order.
Use Subtitle File Turn on/off using external subtitle file. Use File-Open Subtitle File to open one.
Network Broadcasting Broadcast the stream over your network. Simple Define As Master one and then let so many Kaffeine Play As Slave as you want.
DVD Menus Use this to jump to a menu during DVD playback (Title, Angle,...) Press D to toggle between playback and menu.
CD Plays a Audio-CD. You can change the path to the CD-Drive over Config-Configure xine or you can set it via the command line option --device.
VCD Plays a Video-CD. Set VCD-Drive: See above.
DVD Plays a DVD.
DVB The Digital-TV plugin. You need a card like the Hauppauge WinTV Nova. For further information read doc/README int the xine-lib tarball.
[...] Here can be more so-called autoplay plugins. Depends on your installation. For a short description press Shift-F1 over the menu item. TIP: Run autoplay plugins from command line with (for example) kaffeine DVD.
Playlist Show Playlist
Fullscreen Toggle between fullscreen and windowed mode.
Minimal Mode Hides menu and control-panel.
Audio Visualization Choose your desired visualization plugin. Default: goom.
Deinterlace Needed for DVDs and TV streams. Is by default turned on - the tvtime plugin automatically disables deinterlacing for progressive streams. Press Ctrl+I to select deinterlace quality.
Enable Auto Resize Resize main window to video frame size
Aspect Ratio You can choose between auto, 4:3, 16:9 and 1:1.
Fit to Page Turn zoom off.
Zoom in Zoom the video up to 400%.
Zoom out
Add Bookmark Add current/last played URL to bookmarks.
Edit Bookmarks Launch the Bookmark-Editor.
New Bookmark Folder
Videosettings Here you can change some video and audio values: Hue, Saturation, Brightness, Contrast; Audio-Video Offset (if audio for example runs behind video) and Subtitle Offset.
Equalizer Shows the equalizer.
Deinterlace Quality Select the quality of deinterlacing.
Video Postprocessing Filters The "tvtime" filter is useful for deinterlacing a stream.
xine Engine Parameters Set xine parameters: audio- and video-driver and hundred of others. Most of them for experts only.
Configure Shortcuts Configure keyboard shortcuts.
Configure Kaffeine Set the behaviour of the UI
Default playback control elements. You can use the mouse wheel to change position in stream (that works also with pointer over the video window).
Right down you can choose the Audio Channel and the Subtitle Channel (or the subtitle file to use).
The "Record" Button: You can save a stream as a local file.
click on column header to sort the playlist
left click on a playlist entry for context menu
use Add Subtitle to add external subtitle files to a movie
for searching in titles enter a term in the textfield of the toolbar
New Clear the playlist.
Open Open a playlist.
Save Save the current playlist.
Save as... Save the playlist under a new name.
Import Import a Noatun playlist, M3U-, PLS- or ASX-Files.
Export to Export playlist as HTML-File.
Print You can use this to export playlist as PDF-File.
Close Hides the playlist window.
Quit Quits Kaffeine.
Add Directory Checks a directory for useable files. If there are any playlists in this directory, they will be imported too. Subdirectories will be scaned recursively.
Add File(s) Will be add to the end of the playlist. You can use Drag and Drop to insert files where ever you want. Playlists too.
Add URL
Sort by titles Sort playlist entries by titles. Click on a column header to sort by other criteria.
Cut Remove selected entries and put them as URLs to clipboard.
Copy Copy selected entries as URLs to clipboard.
Paste Insert URLs form clipboard after the selected entry. Copy+Paste works with Konqueror as well.
Usage:
kaffeine [-fmpeaxrd] [--fullscreen] [--minimal] [--play] [--enqueue] [--audiodriver] [--videodriver] [--rc] [--device] [--verbose] [file...]
-f,--fullscreen | Start Kaffeine in Fullscreen Mode. |
-m,--minimal | Start Kaffeine in Minimal Mode. With hidden menu and control panel. |
-p,--play | Start Kaffeine with playing the last playlist. |
-e,--enqueue | Append files to the current playlist. |
-a,--audiodriver (argument) | Sets the Audio-Driver. Arguments can be: alsa, arts, oss, ... |
-x,--videodriver (argument) | Sets the Video-Driver. Arguments can be: xv, xshm, dxr3 ,... |
-r,--rc (argument) | Remote Control, arguments are: play, pause, next, prev, stop, volup, voldown, incpos, decpos, quit |
-d,--device (argument) | Sets the Audio-CD/VCD/DVD path to (argument). |
--verbose | Output xine debug messages. |
file... | Files to load into playlist. Can also be a directory or the name of a plugin, such as CD, VCD,... Append "#subtitle:sub.txt" to load a external subtitle file or "#save:/home/test/save.mp3" to save the stream as... |
Provides embedded konqueror-preview for media files. For local files use from context menu Preview with...-Kaffeine.
Use the "coffee bean" button to start the file externally in Kaffeine and stop embedded preview.
You can use the DCOP interface in two kinds: From inside another application with KApplication::dcopClient()->send( "kaffeine", "Kaffeine", "togglePlayPause()" ) or from command line with dcop kaffeine Kaffeine togglePlayPause.
void playURL(QString URL) | Plays the given URL. |
void appendURL(QString URL) | Appends the URL to current playlist. |
void play() | Starts playback. |
bool isPlaying() | Returns "true" or "false" on command line. |
void pause() | Pauses playback. |
void togglePlayPause() | Toggle between pause and playing. |
void next() | Plays next entry/chapter. |
void previous() | Plays previous entry/chapter. |
void stop() | Stops playback. |
QString getTitle() | Returns the title of the current track. |
void playlist() | Shows/Hides playlist window. |
void quit() | Quits Kaffeine. |
void random() | Toggles between random and normal play. |
void fullscreen() | Toggels between fullscreen and windowed mode. |
void posPlus() | Increases position in stream. |
void posMinus() | Decreases position in stream. |
void volUp() | Increases volume. |
void volDown() | Decreases volume. |
int getPos() | Returns current position in stream: 0...65535 |
void setPos(int pos) | Sets stream position: 0...65535 |
int getVol() | Returns current volume: 0...100 |
void setPos(int vol) | Sets volume: 0...100 |
QString getTimeStr() | Returns current stream position as time string, something like "0:12:34" |
These are the default bindings. All shortcurts are configurable: Settings-Configure Shortcuts.
Ctrl+O | Open File(s) |
Ctrl+U | Open URL |
Ctrl+Q | Quit Kaffeine |
Ctrl+E | Activate/deactivate endless mode |
Ctrl+R | Activate/deactivate random mode |
F | Toggle between fullscreen and windowed view |
M | Toggle between Minimal Mode and the normal view |
I | Activate/deactivate deinterlace-filter |
A | Activate/deactivate auto resizing |
Ctrl++ | Zoom in |
Ctrl+- | Zoom out |
F5 | Automatic aspect ratio |
F6 | Aspect ratio 4:3 |
F7 | Aspect ratio 16:9 |
F8 | Aspect ratio 1:1 |
V | Show Videosettings dialog |
E | Show Equalizer dialog |
Ctrl+I | Show deinterlace quality dialog |
X | Show Video Postprocessing Filters dialog |
P | Show/hide playlist window |
Space | Toggle between play/pause |
Down | Play next playlist-entry (or next chapter) |
Up | Play previous playlist-entry (or previous chapter) |
Backspace | Stop playback |
+ | Increase volume |
- | Decrease volume |
Right | Increase stream position |
Left | Decrease stream position |
Ctrl+Left | DVD Menu: Left |
Ctrl+Right | DVD Menu: Right |
Ctrl+Up | DVD Menu: Up |
Ctrl+Down | DVD Menu: Down |
Return | DVD Menu: Select |
Ctrl+N | Clear Playlist |
Ctrl+O | Open Playlist |
Ctrl+S | Save Playlist |
Ctrl+Q | Quit Kaffeine |
Ctrl+F | Add File(s) to playlist |
Ctrl+U | Add URL to playlist |
Ctrl+D | Add a whole directory to playlist |
Return | Play current entry. |
Space | Toggle play/pause. |
Backspace | Stop playback. |
Del | Remove selected entrys from playlist |
S | Sort playlist-entrys by titles |
Ctrl+X | Cut selected entries |
Ctrl+C | Copy selected entries to clipboard |
Ctrl+V | Paste URLs from clipboard |
Ctrl+W | Close playlist window |
P | Show main window. |
For Questions use the kaffeine-user mailinglist. (First check the archive if the question is still answered.)
Before you report a bug, please first make sure the bug has not been reported yet in the bug tracking system at http://www.sourceforge.net/projects/kaffeine. Also look into the mailinglist archive.
Please use only the tracking system on sourceforge for reporting bugs and log in before submitting (if you've a sourceforge account).
When you submit a bug, please include all of the following information:
versions of Kaffeine, xine, KDE, X11
the backtrace from KDE's Crash Manager
console output (you can use --verbose to get more)
THANK YOU:
The xine developers for their great work http://www.xinehq.de
The kdevelop team http://www.kdevelop.org
The Blender Foundation http://www.blender3d.org
Program copyright 2003-2004, Jürgen Kofler <kaffeine@gmx.net>
Documentation copyright 2003-2004, Jürgen Kofler <kaffeine@gmx.net>
This documentation is licensed under the terms of the GNU Free Documentation License.
This program is licensed under the terms of the GNU General Public License.