CKlearEngineAdapter Class Reference

Abstract engine layer. More...

#include <CKlearEngineAdapter.h>

Inheritance diagram for CKlearEngineAdapter:

Public Member Functions
	CKlearEngineAdapter ()
	Constructor.
	CKlearEngineAdapter (QWidget *parent, const char *name)
	overloaded Constructor
virtual	~CKlearEngineAdapter ()
	Destructor.
virtual void	EnginePlayStream (const QString &PlayFile)=0
	tell backend system to play a new file or stream
virtual void	EngineStopStream ()=0
	stop currently played stream or file
virtual bool	EngineIsPlaying ()=0
	shows if a stream is currently playing
virtual void	hideMouse ()=0
	hides the mouspointer (with a static delay)
virtual QImage	getStreamSnapshot ()=0
	grabs a screen image and returns it with a QImage
virtual void	showOSDMessage (const QString &message, uint duration)=0
	shows a given Message via OSD System
virtual void	showInfoOSD (const QString CurrChannel)=0
	Shows the normal information OSD Message for the current channel.
virtual void	setVolume (int vol)
	Sets a new volume. This method is part of the player-independant sound-controller. You normally don't have to overwrite this function.
virtual int	getVolume ()
	Gets the current volume. This method is part of the player-independant sound-controller. You normally don't have to overwrite this function.
virtual void	toggleMute ()
	set / unset audio muting. This method is part of the player-independant sound-controller. You normally don't have to overwrite this function.
virtual void	toggleDeinterlacing ()=0
	set / unset default deinterlace filter
virtual bool	isMute ()=0
	returns true if sound is muted

---

Detailed Description

Abstract engine layer.

Author:

Klear.org

---

Constructor & Destructor Documentation

void CKlearEngineAdapter::CKlearEngineAdapter (   )

Constructor. Author: Marco Kraus <marco@klear.org>

void CKlearEngineAdapter::CKlearEngineAdapter (  QWidget *  parent, const char *  name )

overloaded Constructor Author: Patric Sherif <patric@klear.org> and Manuel Habermann <manuel@klear.org>

void CKlearEngineAdapter::~CKlearEngineAdapter (   )  [virtual]

Destructor. Author: Marco Kraus <marco@klear.org>

---

Member Function Documentation

void CKlearEngineAdapter::EngineIsPlaying (   )  [pure virtual]

shows if a stream is currently playing Author: Marco Kraus <marco@klear.org> Return values: bool  if current stream is playing Implemented in CKlearEngineXine.

void CKlearEngineAdapter::EnginePlayStream (  const QString &  PlayFile  )  [pure virtual]

tell backend system to play a new file or stream Author: Marco Kraus <marco@klear.org> Return values: void  no retval Parameters: PlayFile  file to be displayed Implemented in CKlearEngineXine.

void CKlearEngineAdapter::EngineStopStream (   )  [pure virtual]

stop currently played stream or file Author: Marco Kraus <marco@klear.org> Return values: void  no retval Implemented in CKlearEngineXine.

QImage CKlearEngineAdapter::getStreamSnapshot (   )  [pure virtual]

grabs a screen image and returns it with a QImage Author: Marco Kraus <marco@klear.org> Return values: QImage  The screenshots in a QImage fileformat Implemented in CKlearEngineXine.

int CKlearEngineAdapter::getVolume (   )  [virtual]

Gets the current volume. This method is part of the player-independant sound-controller. You normally don't have to overwrite this function. Author: Marco Kraus <marco@klear.org> Return values: int  volume Reimplemented in CKlearEngineXine.

void CKlearEngineAdapter::hideMouse (   )  [pure virtual]

hides the mouspointer (with a static delay) Author: Marco Kraus <marco@klear.org> Return values: void  no retval Implemented in CKlearEngineXine.

CKlearEngineAdapter::isMute (   )  [pure virtual]

returns true if sound is muted Author: Manuel Habermann <manuel@klear.org>, Patric Sherif <patric@klear.org> Return values: bool  mute status Implemented in CKlearEngineXine.

void CKlearEngineAdapter::setVolume (  int  vol  )  [virtual]

Sets a new volume. This method is part of the player-independant sound-controller. You normally don't have to overwrite this function. Author: Marco Kraus <marco@klear.org> Return values: void  no retval Parameters: vol  volume value between 0 and 100 (0 = mute) Reimplemented in CKlearEngineXine.

void CKlearEngineAdapter::showInfoOSD (  const QString  CurrChannel  )  [pure virtual]

Shows the normal information OSD Message for the current channel. Author: Marco Kraus <marco@klear.org> Return values: void  no retval Implemented in CKlearEngineXine.

void CKlearEngineAdapter::showOSDMessage (  const QString &  message, uint  duration )  [pure virtual]

shows a given Message via OSD System Author: Marco Kraus <marco@klear.org> Return values: void  no retval Parameters: message  The shown messagestring duration  The time in mSec to display the message Implemented in CKlearEngineXine.

void CKlearEngineAdapter::toggleDeinterlacing (   )  [pure virtual]

set / unset default deinterlace filter Author: Marco Kraus <marco@klear.org> Return values: void  no retval Implemented in CKlearEngineXine.

void CKlearEngineAdapter::toggleMute (   )  [virtual]

set / unset audio muting. This method is part of the player-independant sound-controller. You normally don't have to overwrite this function. Author: Marco Kraus <marco@klear.org> Return values: void  no retval Reimplemented in CKlearEngineXine.

---

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

• cvs/klear/src/App/Engines/CKlearEngineAdapter.h

---