PVR::CPVRGUIActionsPlayback Class Reference

#include <PVRGUIActionsPlayback.h>

Inheritance diagram for PVR::CPVRGUIActionsPlayback:

Public Member Functions
	CPVRGUIActionsPlayback ()
	~CPVRGUIActionsPlayback () override=default
bool	ResumePlayRecording (const CFileItem &item, bool bFallbackToPlay) const
	Resume a previously not completely played recording.
bool	PlayRecording (const CFileItem &item, bool bCheckResume) const
	Play recording.
bool	PlayRecordingFolder (const CFileItem &item, bool bCheckResume) const
	Play a recording folder.
bool	PlayEpgTag (const CFileItem &item, ContentUtils::PlayMode mode=ContentUtils::PlayMode::CHECK_AUTO_PLAY_NEXT_ITEM) const
	Play EPG tag.
bool	SwitchToChannel (const CFileItem &item, bool bCheckResume) const
	Switch channel.
bool	PlayMedia (const CFileItem &item) const
	Playback the given file item.
bool	SwitchToChannel (PlaybackType type) const
	Start playback of the last played channel, and if there is none, play first channel in the current channelgroup.
bool	PlayChannelOnStartup () const
	Plays the last played channel or the first channel of TV or Radio on startup.
void	SeekForward ()
	Seek to the start of the next epg event in timeshift buffer, relative to the currently playing event. If there is no next event, seek to the end of the currently playing event (to the 'live' position).
void	SeekBackward (unsigned int iThreshold)
	Seek to the start of the previous epg event in timeshift buffer, relative to the currently playing event or if there is no previous event or if playback time is greater than given threshold, seek to the start of the playing event.
Public Member Functions inherited from PVR::IPVRComponent
virtual	~IPVRComponent ()=default

Constructor & Destructor Documentation

CPVRGUIActionsPlayback()

CPVRGUIActionsPlayback::CPVRGUIActionsPlayback

(

)

~CPVRGUIActionsPlayback()

PVR::CPVRGUIActionsPlayback::~CPVRGUIActionsPlayback ( )

overridedefault

Member Function Documentation

PlayChannelOnStartup()

bool CPVRGUIActionsPlayback::PlayChannelOnStartup

(

)

const

Plays the last played channel or the first channel of TV or Radio on startup.

Returns

True if playback was started, false otherwise.

PlayEpgTag()

bool CPVRGUIActionsPlayback::PlayEpgTag	(	const CFileItem &	item,
		ContentUtils::PlayMode	mode = ContentUtils::PlayMode::CHECK_AUTO_PLAY_NEXT_ITEM ) const

Play EPG tag.

Parameters

item	containing an epg tag.
mode	playback mode.

Returns

true on success, false otherwise.

PlayMedia()

bool CPVRGUIActionsPlayback::PlayMedia

(

const CFileItem &

item

)

const

Playback the given file item.

Parameters

item	containing a channel or a recording.

Returns

True if the item could be played, false otherwise.

PlayRecording()

bool CPVRGUIActionsPlayback::PlayRecording	(	const CFileItem &	item,
		bool	bCheckResume ) const

Play recording.

Parameters

item	containing a recording or an epg tag.
bCheckResume	controls resume check.

Returns

true on success, false otherwise.

PlayRecordingFolder()

bool CPVRGUIActionsPlayback::PlayRecordingFolder	(	const CFileItem &	item,
		bool	bCheckResume ) const

Play a recording folder.

Parameters

item	containing a recording folder.
bCheckResume	controls resume check.

Returns

true on success, false otherwise.

ResumePlayRecording()

bool CPVRGUIActionsPlayback::ResumePlayRecording	(	const CFileItem &	item,
		bool	bFallbackToPlay ) const

Resume a previously not completely played recording.

Parameters

item	containing a recording or an epg tag.
bFallbackToPlay	controls whether playback of the recording should be started at the beginning ig no resume data are available.

Returns

true on success, false otherwise.

SeekBackward()

void CPVRGUIActionsPlayback::SeekBackward

(

unsigned int

iThreshold

)

Seek to the start of the previous epg event in timeshift buffer, relative to the currently playing event or if there is no previous event or if playback time is greater than given threshold, seek to the start of the playing event.

Parameters

iThreshold

the value in seconds to trigger seek to start of current event instead of start of previous event.

SeekForward()

void CPVRGUIActionsPlayback::SeekForward

(

)

Seek to the start of the next epg event in timeshift buffer, relative to the currently playing event. If there is no next event, seek to the end of the currently playing event (to the 'live' position).

SwitchToChannel() [1/2]

bool CPVRGUIActionsPlayback::SwitchToChannel	(	const CFileItem &	item,
		bool	bCheckResume ) const

Switch channel.

Parameters

item	containing a channel or an epg tag.
bCheckResume	controls resume check in case a recording for the current epg event is present.

Returns

true on success, false otherwise.

SwitchToChannel() [2/2]

bool CPVRGUIActionsPlayback::SwitchToChannel

(

PlaybackType

type

)

const

Start playback of the last played channel, and if there is none, play first channel in the current channelgroup.

Parameters

type	The type of playback to be started (any, radio, tv). See PlaybackType enum

Returns

True if playback was started, false otherwise.

---

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

• PVRGUIActionsPlayback.h
• PVRGUIActionsPlayback.cpp