#include <player.h>

Public Member Functions
	cControl (cPlayer *Player, bool Hidden=false)
virtual	~cControl () override
virtual void	Hide (void)=0
virtual cOsdObject *	GetInfo (void)
virtual const cRecording *	GetRecording (void)
virtual cString	GetHeader (void)
virtual void	ClearEditingMarks (void)
void	SetPlayer (cPlayer *Player)
double	FramesPerSecond (void) const
bool	GetIndex (int &Current, int &Total, bool SnapToIFrame=false) const
bool	GetFrameNumber (int &Current, int &Total) const
bool	GetReplayMode (bool &Play, bool &Forward, int &Speed) const
Public Member Functions inherited from cOsdObject
	cOsdObject (bool FastResponse=false)
virtual	~cOsdObject ()
virtual bool	NeedsFastResponse (void)
bool	IsMenu (void) const
virtual void	Show (void)
virtual eOSState	ProcessKey (eKeys Key)

Static Public Member Functions
static void	Launch (cControl *Control)
static void	Attach (void)
static void	Shutdown (void)
static cControl *	Control (cMutexLock &MutexLock, bool Hidden=false, bool *LockedOtherwise=NULL)

Protected Attributes
cPlayer *	player

Private Attributes
bool	attached
bool	hidden

Static Private Attributes
static cControl *	control = NULL
static cMutex	mutex

Additional Inherited Members
Protected Member Functions inherited from cOsdObject
void	SetNeedsFastResponse (bool NeedsFastResponse)

Detailed Description

Definition at line 85 of file player.h.

Constructor & Destructor Documentation

◆ cControl()

cControl::cControl	(	cPlayer *	Player,
		bool	Hidden = false )

Definition at line 45 of file player.c.

References attached, hidden, and player.

Referenced by cDvbPlayerControl::cDvbPlayerControl(), Control(), cPictureControl::cPictureControl(), cTransferControl::cTransferControl(), Launch(), and Shutdown().

◆ ~cControl()

cControl::~cControl ( )

overridevirtual

Definition at line 52 of file player.c.

References control.

Member Function Documentation

◆ Attach()

void cControl::Attach ( void )

static

Definition at line 98 of file player.c.

References attached, control, cPlayer::IsAttached(), mtError, mutex, player, cDevice::PrimaryDevice(), cSkins::QueueMessage(), Shutdown(), Skins, and tr.

Referenced by cSVDRPServer::CmdPLAY(), main(), and cRecordControls::PauseLiveVideo().

◆ ClearEditingMarks()

virtual void cControl::ClearEditingMarks ( void )

inlinevirtual

Clears any editing marks this player might be showing.

Deletion of the marks themselves is handled separately, calling this function merely tells the player to no longer display the marks, if it has any.

Reimplemented in cReplayControl.

Definition at line 110 of file player.h.

◆ Control()

cControl * cControl::Control	(	cMutexLock &	MutexLock,
		bool	Hidden = false,
		bool *	LockedOtherwise = NULL )

static

Returns the current replay control (if any) in case it is currently visible.

If Hidden is true, the control will be returned even if it is currently hidden. The given MutexLock must live as long as the replay control is accessed, and must go out of scope as soon as the control is no longer accessed. If called from a thread other than the main thread, waits for up to 100 milliseconds before giving up if the control is locked otherwise. The optional pointer to the boolean LockedOtherwise can be used to detect this case (only valid if the function returns NULL).

Definition at line 75 of file player.c.

References cControl(), control, CONTROL_LOCK_TIMEOUT, hidden, cThread::IsMainThread(), cMutexLock::Lock(), and mutex.

Referenced by cMenuRecordingEdit::DeleteMarks(), cSkinLCARSDisplayMenu::Flush(), Launch(), main(), and cMenuMain::Update().

◆ FramesPerSecond()

double cControl::FramesPerSecond ( void ) const

inline

Definition at line 116 of file player.h.

References DEFAULTFRAMESPERSECOND, cPlayer::FramesPerSecond(), and player.

Referenced by cReplayControl::EditTest(), cReplayControl::MarkJump(), cReplayControl::ShowProgress(), and cReplayControl::TimeSearchProcess().

◆ GetFrameNumber()

bool cControl::GetFrameNumber	(	int &	Current,
		int &	Total ) const

inline

Definition at line 118 of file player.h.

References cPlayer::GetFrameNumber(), and player.

◆ GetHeader()

cString cControl::GetHeader ( void )

virtual

This can be used by players that don't play a cRecording, but rather do something completely different.

The resulting string may be used by skins as a last resort, in case they want to display the state of the current player. The return value is expected to be a short, single line string. The default implementation returns an empty string.

Reimplemented in cPictureControl.

Definition at line 68 of file player.c.

Referenced by cSkinLCARSDisplayMenu::DrawPlay(), and Hide().

◆ GetIndex()

bool cControl::GetIndex	(	int &	Current,
		int &	Total,
		bool	SnapToIFrame = false ) const

inline

Definition at line 117 of file player.h.

References cPlayer::GetIndex(), and player.

Referenced by cSkinLCARSDisplayMenu::DrawPlay().

◆ GetInfo()

cOsdObject * cControl::GetInfo ( void )

virtual

Returns an OSD object that displays information about the currently played programme.

If no such information is available, NULL will be returned.

Reimplemented in cReplayControl.

Definition at line 58 of file player.c.

References cOsdObject::cOsdObject().

Referenced by Hide(), and main().

◆ GetRecording()

const cRecording * cControl::GetRecording ( void )

virtual

Returns the cRecording that is currently being replayed, or NULL if this player is not playing a cRecording.

Reimplemented in cReplayControl.

Definition at line 63 of file player.c.

Referenced by cSkinLCARSDisplayMenu::DrawPlay(), and Hide().

◆ GetReplayMode()

bool cControl::GetReplayMode	(	bool &	Play,
		bool &	Forward,
		int &	Speed ) const

inline

Definition at line 119 of file player.h.

References cPlayer::GetReplayMode(), and player.

◆ Hide()

virtual void cControl::Hide ( void )

pure virtual

Implemented in cPictureControl, cReplayControl, and cTransferControl.

References cOsdObject::cOsdObject(), GetHeader(), GetInfo(), and GetRecording().

Referenced by main().

◆ Launch()

void cControl::Launch ( cControl * Control )

static

Definition at line 91 of file player.c.

References cControl(), Control(), control, and mutex.

Referenced by cSVDRPServer::CmdPLAY(), main(), cRecordControls::PauseLiveVideo(), cPictureMenu::SelectItem(), and cDevice::SetChannel().

◆ SetPlayer()

void cControl::SetPlayer ( cPlayer * Player )

inline

Definition at line 115 of file player.h.

References player.

Referenced by cDvbPlayerControl::cDvbPlayerControl(), cPictureControl::cPictureControl(), and cTransferControl::cTransferControl().

◆ Shutdown()

void cControl::Shutdown ( void )

static

Definition at line 111 of file player.c.

References cControl(), control, and mutex.

Referenced by cMenuSetupCAM::Activate(), Attach(), cSVDRPServer::CmdPLAY(), cMenuRecordings::Delete(), main(), cDisplayChannel::NextAvailableChannel(), cCutter::Stop(), cDevice::StopReplay(), cDevice::SwitchChannel(), and cDevice::SwitchChannel().

Member Data Documentation

◆ attached

bool cControl::attached

private

Definition at line 89 of file player.h.

Referenced by Attach(), and cControl().

◆ control

cControl * cControl::control = NULL

staticprivate

Definition at line 87 of file player.h.

Referenced by Attach(), Control(), Launch(), Shutdown(), and ~cControl().

◆ hidden

bool cControl::hidden

private

Definition at line 90 of file player.h.

Referenced by cControl(), and Control().

◆ mutex

cMutex cControl::mutex

staticprivate

Definition at line 88 of file player.h.

Referenced by Attach(), Control(), Launch(), and Shutdown().

◆ player

cPlayer* cControl::player

protected

Definition at line 92 of file player.h.

Referenced by Attach(), cControl(), FramesPerSecond(), GetFrameNumber(), GetIndex(), GetReplayMode(), SetPlayer(), and cDvbPlayerControl::Stop().

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cControl()

◆ ~cControl()

Member Function Documentation

◆ Attach()

◆ ClearEditingMarks()

◆ Control()

◆ FramesPerSecond()

◆ GetFrameNumber()

◆ GetHeader()

◆ GetIndex()

◆ GetInfo()

◆ GetRecording()

◆ GetReplayMode()

◆ Hide()

◆ Launch()

◆ SetPlayer()

◆ Shutdown()

Member Data Documentation

◆ attached

◆ control

◆ hidden

◆ mutex

◆ player