Kaffeine 0.5 Handbook

Jürgen Kofler <kaffeine@gmx.net>

Revision 0.05.00 (03/04/2004)

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 Media Player for KDE. http://kaffeine.sourceforge.net


Table of Contents

1. Kaffeine Shell
The Start Window
The Playlist Window
2. Player Parts
The Kaffeine Part
About xine
3. Command Line Options
4. The DCOP Interface
Overview
Functions
5. Keybindings
6. Questions and Answers
7. Reporting BUGS
8. Credits and License

Chapter 1. Kaffeine Shell

The Start Window


Screenshot

Provides fast access to the most important media sources.

The Playlist Window


Screenshot

Kaffeine supports multiple playlists. Choose the active one with the selector in the toolbar. To change playlist name edit it and confirm with Return.

You can find all playlist related functions in the Playlist-Menu and the context-menu (right-click on playlist).

Chapter 2. Player Parts

You'll find all available player parts in Settings-Player Engine.

The Kaffeine Part


Screenshot

This is the default, xine based, full featured player part for Kaffeine. Play almost everything...

About xine

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

Chapter 3. Command Line Options

Usage:

kaffeine [fpwaxd] [--fullscreen] [--play] [--audiodriver] [--videodriver] [--device] [--verbose] [--wizard] [file...]

-f,--fullscreen

Starts Kaffeine in fullscreen mode.

-p,--play

Starts with last played track.

-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 ,...

-d,--device (argument)

Sets the Audio-CD/VCD/DVD path to (argument).

--verbose

Outputs more debug messages.

-w,--wizard

Runs installation wizard.

file...

Files to play. Can be local files, a directory, an URL or "AudioCD", "VCD", "DVD".

Chapter 4. The DCOP Interface

Overview

You can use the DCOP interface in two kinds: From inside another application with KApplication::dcopClient()->send( "kaffeine", "KaffeineIface", "pause()" ) or from command line with dcop kaffeine KaffeineIface openURL best_song_of_the_world.mp3.

Functions

void openURL(QString URL)

Opens and plays the given URL.

void appendURL(QString URL)

Appends the URL to current playlist.

void play()

(Re)Starts playback.

bool isPlaying()

Returns "true" or "false" on command line.

void pause()

Toggles pause/playback.

void next()

Plays next playlist-item/chapter.

void previous()

Plays previous playlist-item/chapter.

void stop()

Stops playback.

QString title()

Returns the title of the current track.

void quit()

Quits Kaffeine.

void random()

Toggles between random and normal play.

void fullscreen()

Toggels between fullscreen and windowed mode.

void posPlus()

Increases stream position.

void posMinus()

Decreases stream position.

void volUp()

Increases volume.

void volDown()

Decreases volume.

void mute()

Toggles mute on/off.

Chapter 5. Keybindings

You can configure shortcuts using Settings-Configure Shortcuts.

Chapter 6. Questions and Answers

Kaffeine-FAQ

xine-FAQ

For Questions use the kaffeine-user mailinglist. (First check the archive if the question is still answered.)

Chapter 7. Reporting BUGS

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 have a 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)

Chapter 8. Credits and License

THANK YOU:

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.