Provides an interface to both local and remote TVRec's for the mythbackend. More...

#include <encoderlink.h>

Public Member Functions
	EncoderLink (int capturecardnum, PlaybackSock *lsock, QString lhostname)
	This is the EncoderLink constructor for non-local recorders.
	EncoderLink (int capturecardnum, TVRec *ltv)
	This is the EncoderLink constructor for local recorders.
	~EncoderLink ()
	Destructor does nothing for non-local EncoderLink instances, but deletes the TVRec for local EncoderLink instances.
void	SetSocket (PlaybackSock *lsock)
	Used to set the socket for a non-local EncoderLink.
PlaybackSock *	GetSocket (void)
	Returns the socket, if set, for a non-local EncoderLink.
void	SetSleepStatus (SleepStatus newStatus)
	Used to set the asleep status of an encoder.
QDateTime	GetSleepStatusTime (void) const
	Get the last time the sleep status was changed.
QDateTime	GetLastSleepTime (void) const
	Get the last time the encoder was put to sleep.
void	SetLastWakeTime (QDateTime newTime)
	Used to set the last wake time of an encoder.
QDateTime	GetLastWakeTime (void) const
	Get the last time the encoder was awakened.
QString	GetHostName (void) const
	Returns the remote host for a non-local EncoderLink.
bool	IsLocal (void) const
	Returns true for a local EncoderLink.
bool	IsConnected (void) const
	Returns true if the EncoderLink instance is usable.
bool	IsAwake (void) const
	Returns true if the encoder is awake.
bool	IsAsleep (void) const
	Returns true if the encoder is asleep.
bool	IsWaking (void) const
	Returns true if the encoder is waking up.
bool	IsFallingAsleep (void) const
	Returns true if the encoder is falling asleep.
bool	CanSleep (void) const
	Returns true if the encoder can sleep.
SleepStatus	GetSleepStatus (void) const
	Returns the current Sleep Status of the encoder.
int	GetCardID (void) const
	Returns the cardid used to refer to the recorder in the DB.
TVRec *	GetTVRec (void)
	Returns the TVRec used by a local EncoderLink instance.
bool	GoToSleep (void)
	Tell a slave backend to go to sleep.
int	LockTuner (void)
	Lock the tuner for exclusive use.
void	FreeTuner (void)
	Unlock the tuner.
bool	IsTunerLocked (void) const
	Returns true iff the tuner is locked.
bool	CheckFile (ProgramInfo *pginfo)
	Checks if program is stored locally.
void	GetDiskSpace (QStringList &o_strlist)
	Appends total and used disk space in Kilobytes.
long long	GetMaxBitrate (void)
	Returns maximum bits per second this recorder might output.
int	SetSignalMonitoringRate (int rate, int notifyFrontend)
	Sets the signal monitoring rate.
bool	IsBusy (TunedInputInfo *busy_input=NULL, int time_buffer=5)
	Returns true if the recorder is busy, or will be within the next time_buffer seconds.
bool	IsBusyRecording (void)
	Returns true if the TVRec state is in a recording state.
TVState	GetState ()
	Returns the TVState of the recorder.
uint	GetFlags (void) const
	Returns the flag state of the recorder.
bool	IsRecording (const ProgramInfo *rec)
	Returns true if rec is scheduled for recording.
bool	MatchesRecording (const ProgramInfo *rec)
	Returns true if rec is actually being recorded by TVRec.
void	RecordPending (const ProgramInfo *rec, int secsleft, bool hasLater)
	Tells TVRec there is a pending recording "rec" in "secsleft" seconds.
RecStatusType	StartRecording (const ProgramInfo *rec)
	Tells TVRec to Start recording the program "rec" as soon as possible.
RecStatusType	GetRecordingStatus (void)
void	StopRecording (bool killFile=false)
	Tells TVRec to stop recording immediately.
void	FinishRecording (void)
	Tells TVRec to stop recording, but only after "overrecord" seconds.
void	FrontendReady (void)
	Tells TVRec that the frontend is ready for data.
void	CancelNextRecording (bool)
	Tells TVRec to cancel the next recording.
bool	WouldConflict (const ProgramInfo *rec)
	Checks a recording against any recording current or pending recordings on the recorder represented by this EncoderLink.
bool	IsReallyRecording (void)
	Checks if the RecorderBase held by TVRec is actually recording.
ProgramInfo *	GetRecording (void)
	Returns TVRec's current recording.
float	GetFramerate (void)
	Returns the recording frame rate from TVRec.
long long	GetFramesWritten (void)
	Returns number of frames written to disk by TVRec's RecorderBase instance.
long long	GetFilePosition (void)
	Returns total number of bytes written by TVRec's RingBuffer.
int64_t	GetKeyframePosition (uint64_t desired)
	Returns byte position in RingBuffer of a keyframe.
bool	GetKeyframePositions (int64_t start, int64_t end, frm_pos_map_t &)
void	SpawnLiveTV (LiveTVChain *chain, bool pip, QString startchan)
	Tells TVRec to Spawn a "Live TV" recorder.
QString	GetChainID (void)
	Get the LiveTV chain id that's in use.
void	StopLiveTV (void)
	Tells TVRec to stop a "Live TV" recorder.
void	PauseRecorder (void)
	Tells TVRec to pause a recorder, used for channel and input changes.
void	SetLiveRecording (int)
	Tells TVRec to keep a LiveTV recording if 'recording' is 1.
void	SetNextLiveTVDir (QString dir)
	Tells TVRec where to put the next LiveTV recording.
vector< InputInfo >	GetFreeInputs (const vector< uint > &excluded_cards) const
	Returns TVRec's recorders connected inputs.
QString	GetInput (void) const
	Returns TVRec's recorders current input.
QString	SetInput (QString)
	Tells TVRec's recorder to change to the specified input.
void	ToggleChannelFavorite (QString)
	Toggles whether the current channel should be on our favorites list.
void	ChangeChannel (ChannelChangeDirection channeldirection)
	Changes to the next or previous channel.
void	SetChannel (const QString &name)
	Changes to a named channel on the current tuner.
int	GetPictureAttribute (PictureAttribute attr)
	Changes brightness/contrast/colour/hue of a recording.
int	ChangePictureAttribute (PictureAdjustType type, PictureAttribute attr, bool direction)
	Changes brightness/contrast/colour/hue of a recording.
bool	CheckChannel (const QString &name)
	Checks if named channel exists on current tuner.
bool	ShouldSwitchToAnotherCard (const QString &channelid)
	Checks if named channel exists on current tuner, or another tuner.
bool	CheckChannelPrefix (const QString &, uint &, bool &, QString &)
	Checks a prefix against the channels in the DB.
void	GetNextProgram (BrowseDirection direction, QString &title, QString &subtitle, QString &desc, QString &category, QString &starttime, QString &endtime, QString &callsign, QString &iconpath, QString &channelname, uint &chanid, QString &seriesid, QString &programid)
	Returns information about the program that would be seen if we changed the channel using ChangeChannel(int) with "direction".
bool	GetChannelInfo (uint &chanid, uint &sourceid, QString &callsign, QString &channum, QString &channame, QString &xmltv) const
bool	SetChannelInfo (uint chanid, uint sourceid, QString oldchannum, QString callsign, QString channum, QString channame, QString xmltv)
Private Attributes
int	m_capturecardnum
PlaybackSock *	sock
QString	hostname
long long	freeDiskSpaceKB
TVRec *	tv
bool	local
bool	locked
SleepStatus	sleepStatus
QDateTime	sleepStatusTime
QDateTime	lastSleepTime
QDateTime	lastWakeTime
QDateTime	endRecordingTime
QDateTime	startRecordingTime
uint	chanid

Detailed Description

Provides an interface to both local and remote TVRec's for the mythbackend.

This class be instantiated for either a local or remote TVRec's. Many of the methods will work with either, but many only work for a local TVRec's and these are labeled appropriately in this document.

When used with a remote TVRec all calls go through a PlaybackSock instance.

This class is used primarily by the MainServer, Scheduler and AutoExpire classes.

Definition at line 16 of file encoderlink.h.

Constructor & Destructor Documentation

EncoderLink::EncoderLink	(	int	capturecardnum,
		PlaybackSock *	lsock,
		QString	lhostname
	)

This is the EncoderLink constructor for non-local recorders.

Definition at line 40 of file encoderlink.cpp.

EncoderLink::EncoderLink	(	int	capturecardnum,
		TVRec *	ltv
	)

This is the EncoderLink constructor for local recorders.

Definition at line 60 of file encoderlink.cpp.

EncoderLink::~EncoderLink ( void )

Destructor does nothing for non-local EncoderLink instances, but deletes the TVRec for local EncoderLink instances.

Definition at line 77 of file encoderlink.cpp.

Member Function Documentation

void EncoderLink::SetSocket ( PlaybackSock * lsock )

Used to set the socket for a non-local EncoderLink.

Increases refcount on lsock, decreases refcount on old sock, if exists.

Definition at line 91 of file encoderlink.cpp.

Referenced by MainServer::connectionClosed(), and MainServer::HandleAnnounce().

PlaybackSock* EncoderLink::GetSocket ( void ) [inline]

Returns the socket, if set, for a non-local EncoderLink.

Definition at line 27 of file encoderlink.h.

Referenced by MainServer::connectionClosed().

void EncoderLink::SetSleepStatus ( SleepStatus newStatus )

Used to set the asleep status of an encoder.

Sets the sleep status of a recorder.

Definition at line 118 of file encoderlink.cpp.

Referenced by Scheduler::HandleRecording(), Scheduler::PutInactiveSlavesToSleep(), SetSocket(), and Scheduler::WakeUpSlave().

QDateTime EncoderLink::GetSleepStatusTime ( void ) const [inline]

Get the last time the sleep status was changed.

Definition at line 32 of file encoderlink.h.

Referenced by Scheduler::HandleWakeSlave().

QDateTime EncoderLink::GetLastSleepTime ( void ) const [inline]

Get the last time the encoder was put to sleep.

Definition at line 34 of file encoderlink.h.

void EncoderLink::SetLastWakeTime ( QDateTime newTime ) [inline]

Used to set the last wake time of an encoder.

Definition at line 36 of file encoderlink.h.

Referenced by Scheduler::WakeUpSlave().

QDateTime EncoderLink::GetLastWakeTime ( void ) const [inline]

Get the last time the encoder was awakened.

Definition at line 38 of file encoderlink.h.

Referenced by Scheduler::HandleRecording(), and Scheduler::HandleWakeSlave().

QString EncoderLink::GetHostName ( void ) const [inline]

Returns the remote host for a non-local EncoderLink.

Definition at line 41 of file encoderlink.h.

Referenced by AutoExpire::ExpireRecordings(), HttpStatus::FillStatusXML(), Dvr::GetEncoderList(), Scheduler::GetNextLiveTVDir(), MainServer::HandleAnnounce(), MainServer::HandleGetFreeRecorder(), MainServer::HandleGetNextFreeRecorder(), MainServer::HandleGetRecorderFromNum(), MainServer::HandleLockTuner(), Scheduler::HandleRecording(), Scheduler::HandleWakeSlave(), Scheduler::PutInactiveSlavesToSleep(), Scheduler::WakeUpSlave(), and Scheduler::WakeUpSlaves().

bool EncoderLink::IsLocal ( void ) const [inline]

Returns true for a local EncoderLink.

Definition at line 43 of file encoderlink.h.

Referenced by MainServer::connectionClosed(), MainServer::DoHandleStopRecording(), AutoExpire::ExpireRecordings(), HttpStatus::FillStatusXML(), Dvr::GetEncoderList(), Scheduler::GetNextLiveTVDir(), GoToSleep(), MainServer::HandleCheckRecordingActive(), MainServer::HandleGetFreeRecorder(), MainServer::HandleGetNextFreeRecorder(), MainServer::HandleGetRecorderFromNum(), MainServer::HandleLockTuner(), IsConnected(), Scheduler::PutInactiveSlavesToSleep(), and Scheduler::WakeUpSlaves().

bool EncoderLink::IsConnected ( void ) const [inline]

bool EncoderLink::IsAwake ( void ) const [inline]

Returns true if the encoder is awake.

Definition at line 47 of file encoderlink.h.

Referenced by Scheduler::PutInactiveSlavesToSleep().

bool EncoderLink::IsAsleep ( void ) const [inline]

Returns true if the encoder is asleep.

Definition at line 49 of file encoderlink.h.

Referenced by Scheduler::AddNewRecords(), MainServer::HandleAnnounce(), and Scheduler::HandleWakeSlave().

bool EncoderLink::IsWaking ( void ) const [inline]

Returns true if the encoder is waking up.

Definition at line 51 of file encoderlink.h.

Referenced by MainServer::HandleAnnounce(), Scheduler::HandleRecording(), and Scheduler::HandleWakeSlave().

bool EncoderLink::IsFallingAsleep ( void ) const [inline]

Returns true if the encoder is falling asleep.

Definition at line 53 of file encoderlink.h.

Referenced by MainServer::connectionClosed(), Scheduler::PutInactiveSlavesToSleep(), and SetSocket().

bool EncoderLink::CanSleep ( void ) const [inline]

Returns true if the encoder can sleep.

Definition at line 56 of file encoderlink.h.

Referenced by Scheduler::PutInactiveSlavesToSleep().

SleepStatus EncoderLink::GetSleepStatus ( void ) const [inline]

Returns the current Sleep Status of the encoder.

Definition at line 59 of file encoderlink.h.

Referenced by HttpStatus::FillStatusXML(), Dvr::GetEncoderList(), and MainServer::HandleRemoteEncoder().

int EncoderLink::GetCardID ( void ) const [inline]

Returns the cardid used to refer to the recorder in the DB.

Definition at line 62 of file encoderlink.h.

Referenced by Scheduler::AddNewRecords(), AutoExpire::CalcParams(), MainServer::connectionClosed(), HttpStatus::FillStatusXML(), MainServer::GetCurrentMaxBitrate(), Dvr::GetEncoderList(), MainServer::HandleLockTuner(), Scheduler::PutInactiveSlavesToSleep(), and Scheduler::SchedPreserveLiveTV().

TVRec* EncoderLink::GetTVRec ( void ) [inline]

Returns the TVRec used by a local EncoderLink instance.

Definition at line 64 of file encoderlink.h.

bool EncoderLink::GoToSleep ( void )

Tell a slave backend to go to sleep.

Tell a slave to go to sleep.

Definition at line 349 of file encoderlink.cpp.

Referenced by Scheduler::PutInactiveSlavesToSleep().

int EncoderLink::LockTuner ( void )

Lock the tuner for exclusive use.

Returns:: -2 if tuner is already locked, GetCardID() if you get the lock.

See also:: FreeTuner(), IsTunerLocked()

Definition at line 363 of file encoderlink.cpp.

Referenced by MainServer::HandleLockTuner().

void EncoderLink::FreeTuner ( void ) [inline]

Unlock the tuner.

See also:: LockTuner(), IsTunerLocked()

Definition at line 71 of file encoderlink.h.

Referenced by MainServer::HandleFreeTuner().

bool EncoderLink::IsTunerLocked ( void ) const [inline]

Returns true iff the tuner is locked.

See also:: LockTuner(), FreeTuner()

Definition at line 74 of file encoderlink.h.

Referenced by MainServer::HandleGetFreeRecorder(), MainServer::HandleGetFreeRecorderCount(), MainServer::HandleGetFreeRecorderList(), MainServer::HandleGetNextFreeRecorder(), MainServer::HandleLockTuner(), and Scheduler::HandleRecording().

bool EncoderLink::CheckFile ( ProgramInfo * pginfo )

Checks if program is stored locally.

Definition at line 287 of file encoderlink.cpp.

Referenced by AutoExpire::ExpireRecordings().

void EncoderLink::GetDiskSpace ( QStringList & o_strlist )

Appends total and used disk space in Kilobytes.

Parameters:

o_strlist list to append to

Definition at line 301 of file encoderlink.cpp.

long long EncoderLink::GetMaxBitrate ( void )

Returns maximum bits per second this recorder might output.

See also:: TVRec::GetFreeSpace(long long), RemoteEncoder::GetFreeSpace(long long) May be a local or remote query.

Definition at line 313 of file encoderlink.cpp.

Referenced by AutoExpire::CalcParams(), Scheduler::FillRecordingDir(), MainServer::GetCurrentMaxBitrate(), MainServer::HandleRecorderQuery(), and MainServer::HandleRemoteEncoder().

int EncoderLink::SetSignalMonitoringRate	(	int	rate,
		int	notifyFrontend
	)

Sets the signal monitoring rate.

May be a local or remote query.

See also:: TVRec::SetSignalMonitoringRate(int,int), RemoteEncoder::SetSignalMonitoringRate(int,int)

Parameters:

rate	Milliseconds between each signal check, 0 to disable, -1 to preserve old value.
notifyFrontend	If 1 SIGNAL messages are sent to the frontend, if 0 SIGNAL messages will not be sent, and if -1 the old value is preserved.

Returns:: Old rate if it succeeds, -1 if it fails.

Definition at line 337 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

bool EncoderLink::IsBusy	(	TunedInputInfo *	busy_input = `NULL`,
		int	time_buffer = `5`
	)

Returns true if the recorder is busy, or will be within the next time_buffer seconds.

See also:: IsBusyRecording(void), TVRec::IsBusy(TunedInputInfo*)

Definition at line 129 of file encoderlink.cpp.

Referenced by AutoExpire::CalcParams(), MainServer::connectionClosed(), MainServer::GetCurrentMaxBitrate(), MainServer::HandleLockTuner(), MainServer::HandleRemoteEncoder(), Scheduler::IsBusyRecording(), and Scheduler::SchedPreserveLiveTV().

bool EncoderLink::IsBusyRecording ( void )

Returns true if the TVRec state is in a recording state.

Contrast with IsBusy() which returns true if a recording is pending and is generally the safer call to make.

See also:: IsBusy()

Definition at line 148 of file encoderlink.cpp.

Referenced by MainServer::DoHandleStopRecording(), MainServer::HandleIsRecording(), Scheduler::IsBusyRecording(), and MatchesRecording().

TVState EncoderLink::GetState ( void )

Returns the TVState of the recorder.

See also:: TVRec::GetState(), Recorder Subsystem

Definition at line 167 of file encoderlink.cpp.

Referenced by MainServer::connectionClosed(), MainServer::DoHandleStopRecording(), HttpStatus::FillStatusXML(), Dvr::GetEncoderList(), MainServer::HandleRemoteEncoder(), IsBusyRecording(), MatchesRecording(), and Scheduler::SchedPreserveLiveTV().

uint EncoderLink::GetFlags ( void ) const

Returns the flag state of the recorder.

See also:: TVRec::GetFlags(void) const, Recorder Subsystem

Definition at line 189 of file encoderlink.cpp.

Referenced by MainServer::HandleRemoteEncoder().

bool EncoderLink::IsRecording ( const ProgramInfo * rec )

Returns true if rec is scheduled for recording.

Parameters:

rec	Recording to check.

See also:: MatchesRecording(const ProgramInfo*)

Definition at line 211 of file encoderlink.cpp.

bool EncoderLink::MatchesRecording ( const ProgramInfo * rec )

Returns true if rec is actually being recorded by TVRec.

This waits for TVRec to enter a state other than kState_ChangingState Then it checks TVRec::GetRecording() against rec.

Parameters:

rec	Recording to check against TVRec::GetRecording().

See also:: IsRecording(const ProgramInfo*)

Definition at line 225 of file encoderlink.cpp.

Referenced by MainServer::DoHandleStopRecording(), MainServer::HandleCheckRecordingActive(), MainServer::HandleGetRecorderNum(), and MainServer::HandleRemoteEncoder().

void EncoderLink::RecordPending	(	const ProgramInfo *	rec,
		int	secsleft,
		bool	hasLater
	)

Tells TVRec there is a pending recording "rec" in "secsleft" seconds.

Parameters:

rec	Recording to make.
secsleft	Seconds to wait before starting recording.
hasLater	If true, a later non-conflicting showing is available.

See also:: StartRecording(const ProgramInfo*), CancelNextRecording(bool)

Definition at line 261 of file encoderlink.cpp.

Referenced by Scheduler::HandleRecording(), and MainServer::HandleRemoteEncoder().

RecStatusType EncoderLink::StartRecording ( const ProgramInfo * rec )

Tells TVRec to Start recording the program "rec" as soon as possible.

Returns:: +1 if the recording started successfully, -1 if TVRec is busy doing something else, 0 otherwise.

See also:: RecordPending(const ProgramInfo*, int, bool), StopRecording()

Definition at line 379 of file encoderlink.cpp.

Referenced by Scheduler::ChangeRecordingEnd(), Scheduler::HandleRecording(), and MainServer::HandleRemoteEncoder().

RecStatusType EncoderLink::GetRecordingStatus ( void )

Definition at line 407 of file encoderlink.cpp.

Referenced by MainServer::HandleRemoteEncoder().

void EncoderLink::StopRecording ( bool killFile = false )

Tells TVRec to stop recording immediately.

This only works on local recorders.

See also:: StartRecording(const ProgramInfo *rec), FinishRecording()

Definition at line 454 of file encoderlink.cpp.

Referenced by MainServer::DoHandleStopRecording(), and MainServer::HandleRemoteEncoder().

void EncoderLink::FinishRecording ( void )

Tells TVRec to stop recording, but only after "overrecord" seconds.

This only works on local recorders.

See also:: StopRecording()

Definition at line 472 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

void EncoderLink::FrontendReady ( void )

Tells TVRec that the frontend is ready for data.

This only works on local recorders.

See also:: TVRec::, RemoteEncoder::

Definition at line 579 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

void EncoderLink::CancelNextRecording ( bool cancel )

Tells TVRec to cancel the next recording.

This is used when the user is watching "Live TV" and does not want to allow the recorder to be taken for a pending recording.

See also:: RecordPending(const ProgramInfo*, int, bool)

Definition at line 595 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery(), MainServer::HandleRemoteEncoder(), and MainServer::reconnectTimeout().

bool EncoderLink::WouldConflict ( const ProgramInfo * rec )

Checks a recording against any recording current or pending recordings on the recorder represented by this EncoderLink.

Parameters:

rec	Recording to check against current/pending recording.

Definition at line 275 of file encoderlink.cpp.

bool EncoderLink::IsReallyRecording ( void )

Checks if the RecorderBase held by TVRec is actually recording.

This only works on local recorders.

Returns:: true if actually recording, false otherwise.

Definition at line 490 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

ProgramInfo * EncoderLink::GetRecording ( void )

Returns TVRec's current recording.

Caller is responsible for deleting the ProgramInfo when done with it.

Returns:: Returns TVRec's current recording if it succeeds, NULL otherwise.

Definition at line 437 of file encoderlink.cpp.

Referenced by HttpStatus::FillStatusXML(), Dvr::GetEncoderList(), MainServer::HandleIsRecording(), MainServer::HandleRecorderQuery(), MainServer::HandleRemoteEncoder(), and MainServer::reconnectTimeout().

float EncoderLink::GetFramerate ( void )

Returns the recording frame rate from TVRec.

This only works on local recorders.

See also:: RemoteEncoder::GetFrameRate(), TVRec::GetFramerate(void), RecorderBase::GetFrameRate()

Returns:: Frames per second if query succeeds -1 otherwise.

Definition at line 506 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

long long EncoderLink::GetFramesWritten ( void )

Returns number of frames written to disk by TVRec's RecorderBase instance.

This only works on local recorders.

See also:: TVRec::GetFramesWritten(), RemoteEncoder::GetFramesWritten()

Returns:: Number of frames if query succeeds, -1 otherwise.

Definition at line 522 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

long long EncoderLink::GetFilePosition ( void )

Returns total number of bytes written by TVRec's RingBuffer.

This only works on local recorders.

See also:: TVRec::GetFilePosition(), RemoteEncoder::GetFilePosition()

Returns:: Bytes written if query succeeds, -1 otherwise.

Definition at line 537 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

int64_t EncoderLink::GetKeyframePosition ( uint64_t desired )

Returns byte position in RingBuffer of a keyframe.

This only works on local recorders.

See also:: TVRec::GetKeyframePosition(uint64_t), RemoteEncoder::GetKeyframePosition(uint64_t)

Returns:: Byte position of keyframe if query succeeds, -1 otherwise.

Definition at line 552 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

bool EncoderLink::GetKeyframePositions	(	int64_t	start,
		int64_t	end,
		frm_pos_map_t &	map
	)

Definition at line 561 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

void EncoderLink::SpawnLiveTV	(	LiveTVChain *	chain,
		bool	pip,
		QString	startchan
	)

Tells TVRec to Spawn a "Live TV" recorder.

This only works on local recorders.

Parameters:

chain	The LiveTV chain to use
startchan	The channel the LiveTV should start with
pip	Tells TVRec's RingBuffer that this is for a Picture in Picture display.

See also:: TVRec::SpawnLiveTV(LiveTVChain*,bool,QString), RemoteEncoder::SpawnLiveTV(QString,bool,QString)

Definition at line 614 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

QString EncoderLink::GetChainID ( void )

Get the LiveTV chain id that's in use.

Definition at line 625 of file encoderlink.cpp.

Referenced by MainServer::connectionClosed(), and MainServer::HandleRecorderQuery().

void EncoderLink::StopLiveTV ( void )

Tells TVRec to stop a "Live TV" recorder.

This only works on local recorders.

See also:: TVRec::StopLiveTV(), RemoteEncoder::StopLiveTV()

Definition at line 639 of file encoderlink.cpp.

Referenced by MainServer::connectionClosed(), and MainServer::HandleRecorderQuery().

void EncoderLink::PauseRecorder ( void )

Tells TVRec to pause a recorder, used for channel and input changes.

This only works on local recorders.

See also:: TVRec::PauseRecorder(), RemoteEncoder::PauseRecorder(), RecorderBase::Pause()

Definition at line 653 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

void EncoderLink::SetLiveRecording ( int recording )

Tells TVRec to keep a LiveTV recording if 'recording' is 1.

and to not keep a LiveTV recording if 'recording; is 0. This only works on local recorders.

Definition at line 666 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

void EncoderLink::SetNextLiveTVDir ( QString dir )

Tells TVRec where to put the next LiveTV recording.

Definition at line 678 of file encoderlink.cpp.

Referenced by Scheduler::GetNextLiveTVDir(), and MainServer::HandleSetNextLiveTVDir().

vector< InputInfo > EncoderLink::GetFreeInputs ( const vector< uint > & excluded_cards ) const

Returns TVRec's recorders connected inputs.

See also:: TVRec::GetFreeInputs(const vector<uint>&) const

Definition at line 691 of file encoderlink.cpp.

Referenced by MainServer::HandleGetFreeRecorder(), MainServer::HandleGetFreeRecorderCount(), MainServer::HandleGetFreeRecorderList(), MainServer::HandleGetNextFreeRecorder(), MainServer::HandleRecorderQuery(), and MainServer::HandleRemoteEncoder().

QString EncoderLink::GetInput ( void ) const

Returns TVRec's recorders current input.

This only works on local recorders.

See also:: TVRec::GetInput(void) const

Definition at line 710 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

QString EncoderLink::SetInput ( QString input )

Tells TVRec's recorder to change to the specified input.

This only works on local recorders.

You must call PauseRecorder(void) before calling this.

Parameters:

input Input to switch to, or "SwitchToNextInput".

Returns:: input we have switched to

See also:: TVRec::SetInput(QString)

Definition at line 729 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

void EncoderLink::ToggleChannelFavorite ( QString changroup )

Toggles whether the current channel should be on our favorites list.

This only works on local recorders.

Returns:: -1 if query does not succeed, otherwise.

Definition at line 743 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

void EncoderLink::ChangeChannel ( ChannelChangeDirection channeldirection )

Changes to the next or previous channel.

This only works on local recorders.

You must call PauseRecorder() before calling this.

Parameters:

channeldirection channel change direction

See also:: BrowseDirections.

Definition at line 758 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

void EncoderLink::SetChannel ( const QString & name )

Changes to a named channel on the current tuner.

This only works on local recorders.

You must call PauseRecorder() before calling this.

Parameters:

name	Name of channel to change to.

Definition at line 773 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

int EncoderLink::GetPictureAttribute ( PictureAttribute attr )

Changes brightness/contrast/colour/hue of a recording.

This only works on local recorders.

Note: In practice this only works with frame grabbing recorders.

Returns:: current value if it succeeds, -1 otherwise.

Definition at line 789 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

int EncoderLink::ChangePictureAttribute	(	PictureAdjustType	type,
		PictureAttribute	attr,
		bool	direction
	)

Changes brightness/contrast/colour/hue of a recording.

This only works on local recorders.

Note: In practice this only works with frame grabbing recorders.

Returns:: current value if it succeeds, -1 otherwise.

Definition at line 809 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

bool EncoderLink::CheckChannel ( const QString & name )

Checks if named channel exists on current tuner.

This only works on local recorders.

Parameters:

name	Channel to verify against current tuner.

Returns:: true if it succeeds, false otherwise.

See also:: TVRec::CheckChannel(QString), RemoteEncoder::CheckChannel(QString), ShouldSwitchToAnotherCard(const QString&)

Definition at line 832 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

bool EncoderLink::ShouldSwitchToAnotherCard ( const QString & channelid )

Checks if named channel exists on current tuner, or another tuner.

This only works on local recorders.

Parameters:

channelid channel to verify against tuners.

Returns:: true if the channel on another tuner and not current tuner, false otherwise.

See also:: CheckChannel(const QString&)

Definition at line 850 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

bool EncoderLink::CheckChannelPrefix	(	const QString &	prefix,
		uint &	is_complete_valid_channel_on_rec,
		bool &	is_extra_char_useful,
		QString &	needed_spacer
	)

Checks a prefix against the channels in the DB.

This only works on local recorders.

See also:: TVRec::CheckChannelPrefix(const QString&,uint&,bool&,QString&) for details.

Definition at line 867 of file encoderlink.cpp.

Referenced by MainServer::HandleRecorderQuery().

void EncoderLink::GetNextProgram	(	BrowseDirection	direction,
		QString &	title,
		QString &	subtitle,
		QString &	desc,
		QString &	category,
		QString &	starttime,
		QString &	endtime,
		QString &	callsign,
		QString &	iconpath,
		QString &	channelname,
		uint &	_chanid,
		QString &	seriesid,
		QString &	programid
	)