• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KMediaPlayer

KMediaPlayer::Player

KMediaPlayer::Player Class Reference

Player is the center of the KMediaPlayer interface. More...

#include <player.h>

Inheritance diagram for KMediaPlayer::Player:

Inheritance graph
[legend]

List of all members.


Public Types

enum  State { Empty, Stop, Pause, Play }

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

Signals

void loopingChanged (bool)
void stateChanged (int)

Public Member Functions

virtual bool hasLength (void) const =0
bool isLooping (void) const
virtual bool isSeekable (void) const =0
virtual qlonglong length (void) const =0
 Player (QWidget *parentWidget, const char *widgetName, QObject *parent)
 Player (QObject *parent)
virtual qlonglong position (void) const =0
int state (void) const
virtual View * view (void)=0
virtual ~Player (void)

Protected Slots

void setState (int)

Properties

bool hasLength
qlonglong length
bool looping
qlonglong position
bool seekable
int state

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 virtual, slot]

Pause playback of the media track.

virtual void KMediaPlayer::Player::play ( void   )  [pure virtual, slot]

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 virtual, slot]

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  )  [protected, slot]

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 virtual, slot]

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 [read, write]

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 [read, write]

Definition at line 53 of file player.h.


The documentation for this class was generated from the following files:
  • player.h
  • player.cpp

KMediaPlayer

Skip menu "KMediaPlayer"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal