KMediaPlayer::Player Class Reference

#include <player.h>

Inheritance diagram for KMediaPlayer::Player:

Public Types
enum	State { Empty, Stop, Pause, Play }
Public Types inherited from KXMLGUIClient
enum	ReverseStateChange

Public Slots
virtual void	pause (void)=0
virtual void	play (void)=0
virtual void	seek (qlonglong msec)=0
void	setLooping (bool)
virtual void	stop (void)=0
Public Slots inherited from KParts::ReadOnlyPart
virtual bool	openUrl (const KUrl &url)

Signals
void	loopingChanged (bool)
void	stateChanged (int)
Signals inherited from KParts::ReadOnlyPart
void	canceled (const QString &errMsg)
void	completed ()
void	completed (bool pendingAction)
void	started (KIO::Job *)
void	urlChanged (const KUrl &url)
Signals inherited from KParts::Part
void	setStatusBarText (const QString &text)
void	setWindowCaption (const QString &caption)

Public Member Functions
	Player (QObject *parent)
	Player (QWidget *parentWidget, const char *widgetName, QObject *parent)
virtual	~Player (void)
virtual bool	hasLength (void) const =0
bool	isLooping (void) const
virtual bool	isSeekable (void) const =0
virtual qlonglong	length (void) const =0
virtual qlonglong	position (void) const =0
int	state (void) const
virtual View *	view (void)=0
Public Member Functions inherited from KParts::ReadOnlyPart
	ReadOnlyPart (QObject *parent=0)
virtual	~ReadOnlyPart ()
OpenUrlArguments	arguments () const
BrowserExtension *	browserExtension () const
bool	closeStream ()
virtual bool	closeUrl ()
bool	isProgressInfoEnabled () const
bool	openStream (const QString &mimeType, const KUrl &url)
void	setArguments (const OpenUrlArguments &arguments)
void	setProgressInfoEnabled (bool show)
void	showProgressInfo (bool show)
KUrl	url () const
bool	writeStream (const QByteArray &data)
Public Member Functions inherited from KParts::Part
	Part (QObject *parent=0)
virtual	~Part ()
virtual void	embed (QWidget *parentWidget)
virtual Part *	hitTest (QWidget *widget, const QPoint &globalPos)
KIconLoader *	iconLoader ()
bool	isSelectable () const
PartManager *	manager () const
void	setAutoDeletePart (bool autoDeletePart)
void	setAutoDeleteWidget (bool autoDeleteWidget)
virtual void	setManager (PartManager *manager)
virtual void	setSelectable (bool selectable)
virtual QWidget *	widget ()
Public Member Functions inherited from KXMLGUIClient
	KXMLGUIClient ()
	KXMLGUIClient (KXMLGUIClient *parent)
virtual	~KXMLGUIClient ()
QAction *	action (const char *name) const
virtual QAction *	action (const QDomElement &element) const
virtual KActionCollection *	actionCollection () const
void	addStateActionDisabled (const QString &state, const QString &action)
void	addStateActionEnabled (const QString &state, const QString &action)
void	beginXMLPlug (QWidget *)
QList< KXMLGUIClient * >	childClients ()
KXMLGUIBuilder *	clientBuilder () const
virtual KComponentData	componentData () const
virtual QDomDocument	domDocument () const
void	endXMLPlug ()
KXMLGUIFactory *	factory () const
StateChange	getActionsToChangeForState (const QString &state)
void	insertChildClient (KXMLGUIClient *child)
virtual QString	localXMLFile () const
KXMLGUIClient *	parentClient () const
void	plugActionList (const QString &name, const QList< QAction * > &actionList)
void	prepareXMLUnplug (QWidget *)
void	reloadXML ()
void	removeChildClient (KXMLGUIClient *child)
void	replaceXMLFile (const QString &xmlfile, const QString &localxmlfile, bool merge=false)
void	setClientBuilder (KXMLGUIBuilder *builder)
void	setFactory (KXMLGUIFactory *factory)
void	setXMLGUIBuildDocument (const QDomDocument &doc)
void	unplugActionList (const QString &name)
virtual QString	xmlFile () const
QDomDocument	xmlguiBuildDocument () const

Protected Slots
void	setState (int)
Protected Slots inherited from KParts::Part
void	slotWidgetDestroyed ()

Properties
bool	hasLength
qlonglong	length
bool	looping
qlonglong	position
bool	seekable
int	state
Properties inherited from KParts::ReadOnlyPart
KUrl	url

Additional Inherited Members
Static Public Member Functions inherited from KXMLGUIClient
static QString	findMostRecentXMLFile (const QStringList &files, QString &doc)
Protected Member Functions inherited from KParts::ReadOnlyPart
	ReadOnlyPart (ReadOnlyPartPrivate &dd, QObject *parent)
void	abortLoad ()
virtual void	guiActivateEvent (GUIActivateEvent *event)
bool	isLocalFileTemporary () const
QString	localFilePath () const
virtual bool	openFile ()
void	setLocalFilePath (const QString &localFilePath)
void	setLocalFileTemporary (bool temp)
void	setUrl (const KUrl &url)
Protected Member Functions inherited from KParts::Part
	Part (PartPrivate &dd, QObject *parent)
virtual void	customEvent (QEvent *event)
QWidget *	hostContainer (const QString &containerName)
void	loadPlugins ()
virtual void	partActivateEvent (PartActivateEvent *event)
virtual void	partSelectEvent (PartSelectEvent *event)
virtual void	setWidget (QWidget *widget)
Protected Member Functions inherited from KXMLGUIClient
void	loadStandardsXmlFile ()
virtual void	setComponentData (const KComponentData &componentData)
virtual void	setDOMDocument (const QDomDocument &document, bool merge=false)
virtual void	setLocalXMLFile (const QString &file)
virtual void	setXML (const QString &document, bool merge=false)
virtual void	setXMLFile (const QString &file, bool merge=false, bool setXMLDoc=true)
virtual void	stateChanged (const QString &newstate, ReverseStateChange reverse=StateNoReverse)
virtual void	virtual_hook (int id, void *data)

Detailed Description

Player is the center of the KMediaPlayer interface.

It provides all of the necessary media player operations, and optionally provides the GUI to control them.

There are two servicetypes for Player: 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.

Definition at line 45 of file player.h.

Member Enumeration Documentation

enum KMediaPlayer::Player::State

The possible states of the Player.

Enumerator
Empty	No track is loaded.
Stop	Not playing.
Pause	Playing is temporarily suspended.
Play	The media is currently being output.

Definition at line 116 of file player.h.

Constructor & Destructor Documentation

KMediaPlayer::Player::Player

(

QObject *

parent

)

This constructor is what to use when no GUI is required, as in the case of a KMediaPlayer/Engine.

Definition at line 36 of file player.cpp.

KMediaPlayer::Player::Player	(	QWidget *	parentWidget,
		const char *	widgetName,
		QObject *	parent
	)

This constructor is what to use when a GUI is required, as in the case of a KMediaPlayer/Player.

Definition at line 27 of file player.cpp.

KMediaPlayer::Player::~Player ( void  )

virtual

Definition at line 45 of file player.cpp.

Member Function Documentation

virtual bool KMediaPlayer::Player::hasLength ( void  ) const

pure virtual

Returns whether the current track has a length.

Some streams are endless, and do not have one.

bool KMediaPlayer::Player::isLooping

(

void

)

const

Return the current looping state.

Definition at line 58 of file player.cpp.

virtual bool KMediaPlayer::Player::isSeekable ( void  ) const

pure virtual

Returns whether the current track honors seek requests.

virtual qlonglong KMediaPlayer::Player::length ( void  ) const

pure virtual

Returns the length of the current track.

void KMediaPlayer::Player::loopingChanged ( bool  )

signal

Emitted when the looping state is changed.

virtual void KMediaPlayer::Player::pause ( void  )

pure virtualslot

Pause playback of the media track.

virtual void KMediaPlayer::Player::play ( void  )

pure virtualslot

Begin playing the media track.

virtual qlonglong KMediaPlayer::Player::position ( void  ) const

pure virtual

Returns the current playback position in the track.

virtual void KMediaPlayer::Player::seek ( qlonglong  msec )

pure virtualslot

Move the current playback position to the specified time in milliseconds, if the track is seekable.

Some streams may not be seeked.

void KMediaPlayer::Player::setLooping ( bool  b )

slot

Set whether the Player should continue playing at the beginning of the track when the end of the track is reached.

Definition at line 49 of file player.cpp.

void KMediaPlayer::Player::setState ( int  s )

protectedslot

Implementers use this to control what users see as the current state.

Definition at line 63 of file player.cpp.

int KMediaPlayer::Player::state

(

void

)

const

Return the current state of the player.

Definition at line 72 of file player.cpp.

void KMediaPlayer::Player::stateChanged ( int  )

signal

Emitted when the state changes.

virtual void KMediaPlayer::Player::stop ( void  )

pure virtualslot

Stop playback of the media track and return to the beginning.

virtual View* KMediaPlayer::Player::view ( void  )

pure virtual

A convenience function returning a pointer to the View for this Player, or 0 if this Player has no GUI.

Property Documentation

bool KMediaPlayer::Player::hasLength

read

Definition at line 48 of file player.h.

qlonglong KMediaPlayer::Player::length

read

Definition at line 49 of file player.h.

bool KMediaPlayer::Player::looping

readwrite

Definition at line 50 of file player.h.

qlonglong KMediaPlayer::Player::position

read

Definition at line 51 of file player.h.

bool KMediaPlayer::Player::seekable

read

Definition at line 52 of file player.h.

int KMediaPlayer::Player::state

readwrite

Definition at line 53 of file player.h.

---

The documentation for this class was generated from the following files:

• player.h
• player.cpp