.TH "KMediaPlayer::Player" kde3 "11 Jun 2005" "Version Version 3.4.1" "interfaces Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KMediaPlayer::Player \- \fBPlayer\fP is the center of the \fBKMediaPlayer\fP interface.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <player.h>\fP
.PP
Inherits \fBKParts::ReadOnlyPart\fP, and KMediaPlayer::PlayerDCOPObject.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBState\fP { \fBEmpty\fP, \fBStop\fP, \fBPause\fP, \fBPlay\fP }"
.br
.in -1c
.SS "Public Slots"

.in +1c
.ti -1c
.RI "virtual void \fBpause\fP (void)=0"
.br
.ti -1c
.RI "virtual void \fBplay\fP (void)=0"
.br
.ti -1c
.RI "virtual void \fBstop\fP (void)=0"
.br
.ti -1c
.RI "virtual void \fBseek\fP (unsigned long msec)=0"
.br
.ti -1c
.RI "void \fBsetLooping\fP (bool)"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBloopingChanged\fP (bool)"
.br
.ti -1c
.RI "void \fBstateChanged\fP (int)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBPlayer\fP (\fBQObject\fP *\fBparent\fP, const char *\fBname\fP)"
.br
.ti -1c
.RI "\fBPlayer\fP (\fBQWidget\fP *parentWidget, const char *widgetName, \fBQObject\fP *\fBparent\fP, const char *\fBname\fP)"
.br
.ti -1c
.RI "virtual \fBView\fP * \fBview\fP (void)=0"
.br
.ti -1c
.RI "virtual bool \fBisSeekable\fP (void) const =0"
.br
.ti -1c
.RI "virtual unsigned long \fBposition\fP (void) const =0"
.br
.ti -1c
.RI "virtual bool \fBhasLength\fP (void) const =0"
.br
.ti -1c
.RI "virtual unsigned long \fBlength\fP (void) const =0"
.br
.ti -1c
.RI "bool \fBisLooping\fP (void) const "
.br
.ti -1c
.RI "int \fBstate\fP (void) const "
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBsetState\fP (int)"
.br
.in -1c
.SH "Detailed Description"
.PP 
\fBPlayer\fP is the center of the \fBKMediaPlayer\fP interface. 

It provides all of the necessary media player operations, and optionally provides the GUI to control them.
.PP
There are two servicetypes for \fBPlayer\fP: KMediaPlayer/Player and KMediaPlayer/Engine. KMediaPlayer/Player provides a widget (accessable through view as well as XML GUI KActions. KMediaPlayer/Engine omits the user interface facets, for those who wish to provide their own interface. 
.PP
Definition at line 46 of file player.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKMediaPlayer::Player::State\fP"
.PP
The possible states of the \fBPlayer\fP. 
.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fIEmpty \fP\fP
No track is loaded. 
.TP
\fB\fIStop \fP\fP
Not playing. 
.TP
\fB\fIPause \fP\fP
Playing is temporarily suspended. 
.TP
\fB\fIPlay \fP\fP
The media is currently being output. 
.PP
Definition at line 111 of file player.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KMediaPlayer::Player::Player (\fBQObject\fP * parent, const char * name)"
.PP
This constructor is what to use when no GUI is required, as in the case of a KMediaPlayer/Engine. 
.PP

.PP
Definition at line 39 of file player.cpp.
.SS "KMediaPlayer::Player::Player (\fBQWidget\fP * parentWidget, const char * widgetName, \fBQObject\fP * parent, const char * name)"
.PP
This constructor is what to use when a GUI is required, as in the case of a KMediaPlayer/Player. 
.PP

.PP
Definition at line 31 of file player.cpp.
.SH "Member Function Documentation"
.PP 
.SS "virtual \fBView\fP* KMediaPlayer::Player::view (void)\fC [pure virtual]\fP"
.PP
A convenience function returning a pointer to the \fBView\fP for this \fBPlayer\fP, or 0 if this \fBPlayer\fP has no GUI. 
.PP

.SS "virtual void KMediaPlayer::Player::pause (void)\fC [pure virtual, slot]\fP"
.PP
Pause playback of the media track. 
.PP
.SS "virtual void KMediaPlayer::Player::play (void)\fC [pure virtual, slot]\fP"
.PP
Begin playing the media track. 
.PP
.SS "virtual void KMediaPlayer::Player::stop (void)\fC [pure virtual, slot]\fP"
.PP
Stop playback of the media track and return to the beginning. 
.PP
.SS "virtual void KMediaPlayer::Player::seek (unsigned long msec)\fC [pure virtual, slot]\fP"
.PP
Move the current playback position to the specified time in milliseconds, if the track is seekable. 
.PP
Some streams may not be seeked.
.SS "virtual bool KMediaPlayer::Player::isSeekable (void) const\fC [pure virtual]\fP"
.PP
Returns whether the current track honors seek requests. 
.PP
.SS "virtual unsigned long KMediaPlayer::Player::position (void) const\fC [pure virtual]\fP"
.PP
Returns the current playback position in the track. 
.PP
.SS "virtual bool KMediaPlayer::Player::hasLength (void) const\fC [pure virtual]\fP"
.PP
Returns whether the current track has a length. 
.PP
Some streams are endless, and do not have one. 
.SS "virtual unsigned long KMediaPlayer::Player::length (void) const\fC [pure virtual]\fP"
.PP
Returns the length of the current track. 
.PP
.SS "void KMediaPlayer::Player::setLooping (bool)\fC [slot]\fP"
.PP
Set whether the \fBPlayer\fP should continue playing at the beginning of the track when the end of the track is reached. 
.PP

.PP
Definition at line 51 of file player.cpp.
.PP
References loopingChanged().
.SS "bool KMediaPlayer::Player::isLooping (void) const"
.PP
Return the current looping state. 
.PP
Definition at line 60 of file player.cpp.
.SS "void KMediaPlayer::Player::loopingChanged (bool)\fC [signal]\fP"
.PP
Emitted when the looping state is changed. 
.PP
Referenced by setLooping().
.SS "int KMediaPlayer::Player::state (void) const"
.PP
Return the current state of the player. 
.PP
Definition at line 74 of file player.cpp.
.SS "void KMediaPlayer::Player::stateChanged (int)\fC [signal]\fP"
.PP
Emitted when the state changes. 
.PP
Referenced by setState().
.SS "void KMediaPlayer::Player::setState (int)\fC [protected, slot]\fP"
.PP
Implementers use this to control what users see as the current state. 
.PP
Definition at line 65 of file player.cpp.
.PP
References stateChanged().

.SH "Author"
.PP 
Generated automatically by Doxygen for interfaces Library from the source code.
