Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
PVR::CPVRGUIActionsTimers Class Reference

#include <PVRGUIActionsTimers.h>

Inheritance diagram for PVR::CPVRGUIActionsTimers:
PVR::IPVRComponent

Public Member Functions

 CPVRGUIActionsTimers ()
 
 ~CPVRGUIActionsTimers () override=default
 
bool AddTimer (bool bRadio) const
 Open the timer settings dialog to create a new tv or radio timer.
 
bool AddTimer (const CFileItem &item, bool bShowTimerSettings) const
 Create a new timer, either interactive or non-interactive.
 
bool AddTimer (const std::shared_ptr< CPVRTimerInfoTag > &item) const
 Add a timer to the client. Doesn't add the timer to the container. The backend will do this.
 
bool AddTimerRule (const CFileItem &item, bool bShowTimerSettings, bool bFallbackToOneShotTimer) const
 Create a new timer rule, either interactive or non-interactive.
 
bool ToggleTimer (const CFileItem &item) const
 Creates or deletes a timer for the given epg tag.
 
bool ToggleTimerState (const CFileItem &item) const
 Toggles a given timer's enabled/disabled state.
 
bool EditTimer (const CFileItem &item) const
 Open the timer settings dialog to edit an existing timer.
 
bool EditTimerRule (const CFileItem &item) const
 Open the timer settings dialog to edit an existing timer rule.
 
std::shared_ptr< CFileItemGetTimerRule (const CFileItem &item) const
 Get the timer rule for a given timer.
 
bool DeleteTimer (const CFileItem &item) const
 Delete a timer, always showing a confirmation dialog.
 
bool DeleteTimer (const std::shared_ptr< CPVRTimerInfoTag > &timer, bool bIsRecording, bool bDeleteRule) const
 Delete a timer or timer rule, showing a confirmation dialog in case a timer currently recording shall be deleted.
 
bool DeleteTimerRule (const CFileItem &item) const
 Delete a timer rule, always showing a confirmation dialog.
 
bool ToggleRecordingOnPlayingChannel ()
 Toggle recording on the currently playing channel, if any.
 
bool SetRecordingOnChannel (const std::shared_ptr< CPVRChannel > &channel, bool bOnOff)
 Start or stop recording on a given channel.
 
bool StopRecording (const CFileItem &item) const
 Stop a currently active recording, always showing a confirmation dialog.
 
bool AddReminder (const CFileItem &item) const
 Create a new reminder timer, non-interactive.
 
void AnnounceReminders () const
 Announce due reminders, if any.
 
- Public Member Functions inherited from PVR::IPVRComponent
virtual ~IPVRComponent ()=default
 

Constructor & Destructor Documentation

◆ CPVRGUIActionsTimers()

CPVRGUIActionsTimers::CPVRGUIActionsTimers ( )

◆ ~CPVRGUIActionsTimers()

PVR::CPVRGUIActionsTimers::~CPVRGUIActionsTimers ( )
overridedefault

Member Function Documentation

◆ AddReminder()

bool CPVRGUIActionsTimers::AddReminder ( const CFileItem & item) const

Create a new reminder timer, non-interactive.

Parameters
itemcontaining epg data to create a reminder timer for. item must be an epg tag.
Returns
true, if the timer was created successfully, false otherwise.

◆ AddTimer() [1/3]

bool CPVRGUIActionsTimers::AddTimer ( bool bRadio) const

Open the timer settings dialog to create a new tv or radio timer.

Parameters
bRadioindicates whether a radio or tv timer shall be created.
Returns
true on success, false otherwise.

◆ AddTimer() [2/3]

bool CPVRGUIActionsTimers::AddTimer ( const CFileItem & item,
bool bShowTimerSettings ) const

Create a new timer, either interactive or non-interactive.

Parameters
itemcontaining epg data to create a timer for. item must be an epg tag or a channel.
bShowTimerSettingsis used to control whether a settings dialog will be opened prior creating the timer.
Returns
true, if the timer was created successfully, false otherwise.

◆ AddTimer() [3/3]

bool CPVRGUIActionsTimers::AddTimer ( const std::shared_ptr< CPVRTimerInfoTag > & item) const

Add a timer to the client. Doesn't add the timer to the container. The backend will do this.

Returns
True if it was sent correctly, false if not.

◆ AddTimerRule()

bool CPVRGUIActionsTimers::AddTimerRule ( const CFileItem & item,
bool bShowTimerSettings,
bool bFallbackToOneShotTimer ) const

Create a new timer rule, either interactive or non-interactive.

Parameters
itemcontaining epg data to create a timer rule for. item must be an epg tag or a channel.
bShowTimerSettingsis used to control whether a settings dialog will be opened prior creating the timer rule.
bFallbackToOneShotTimerif no timer rule can be created, try to create a one-shot timer instead.
Returns
true, if the timer rule was created successfully, false otherwise.

◆ AnnounceReminders()

void CPVRGUIActionsTimers::AnnounceReminders ( ) const

Announce due reminders, if any.

◆ DeleteTimer() [1/2]

bool CPVRGUIActionsTimers::DeleteTimer ( const CFileItem & item) const

Delete a timer, always showing a confirmation dialog.

Parameters
itemcontaining a timer to delete. item must be a timer, an epg tag or a channel.
Returns
true, if the timer was deleted successfully, false otherwise.

◆ DeleteTimer() [2/2]

bool CPVRGUIActionsTimers::DeleteTimer ( const std::shared_ptr< CPVRTimerInfoTag > & timer,
bool bIsRecording,
bool bDeleteRule ) const

Delete a timer or timer rule, showing a confirmation dialog in case a timer currently recording shall be deleted.

Parameters
timercontaining a timer or timer rule to delete.
bIsRecordingdenotes whether the timer is currently recording (controls correct confirmation dialog).
bDeleteRuledenotes to delete a timer rule. For convenience, one can pass a timer created by a rule.
Returns
true, if the timer or timer rule was deleted successfully, false otherwise.

◆ DeleteTimerRule()

bool CPVRGUIActionsTimers::DeleteTimerRule ( const CFileItem & item) const

Delete a timer rule, always showing a confirmation dialog.

Parameters
itemcontaining a timer rule to delete. item must be a timer, an epg tag or a channel.
Returns
true, if the timer rule was deleted successfully, false otherwise.

◆ EditTimer()

bool CPVRGUIActionsTimers::EditTimer ( const CFileItem & item) const

Open the timer settings dialog to edit an existing timer.

Parameters
itemcontaining an epg tag or a timer.
Returns
true on success, false otherwise.

◆ EditTimerRule()

bool CPVRGUIActionsTimers::EditTimerRule ( const CFileItem & item) const

Open the timer settings dialog to edit an existing timer rule.

Parameters
itemcontaining an epg tag or a timer.
Returns
true on success, false otherwise.

◆ GetTimerRule()

std::shared_ptr< CFileItem > CPVRGUIActionsTimers::GetTimerRule ( const CFileItem & item) const

Get the timer rule for a given timer.

Parameters
itemcontaining an item to query the timer rule for. item must be a timer or an epg tag.
Returns
The timer rule item, or nullptr if none was found.

◆ SetRecordingOnChannel()

bool CPVRGUIActionsTimers::SetRecordingOnChannel ( const std::shared_ptr< CPVRChannel > & channel,
bool bOnOff )

Start or stop recording on a given channel.

Parameters
channelthe channel to start/stop recording.
bOnOffTrue to start recording, false to stop.
Returns
True if the recording was started or stopped successfully, false otherwise.

◆ StopRecording()

bool CPVRGUIActionsTimers::StopRecording ( const CFileItem & item) const

Stop a currently active recording, always showing a confirmation dialog.

Parameters
itemcontaining a recording to stop. item must be a timer, an epg tag or a channel.
Returns
true, if the recording was stopped successfully, false otherwise.

◆ ToggleRecordingOnPlayingChannel()

bool CPVRGUIActionsTimers::ToggleRecordingOnPlayingChannel ( )

Toggle recording on the currently playing channel, if any.

Returns
True if the recording was started or stopped successfully, false otherwise.

◆ ToggleTimer()

bool CPVRGUIActionsTimers::ToggleTimer ( const CFileItem & item) const

Creates or deletes a timer for the given epg tag.

Parameters
itemcontaining an epg tag.
Returns
true on success, false otherwise.

◆ ToggleTimerState()

bool CPVRGUIActionsTimers::ToggleTimerState ( const CFileItem & item) const

Toggles a given timer's enabled/disabled state.

Parameters
itemcontaining a timer.
Returns
true on success, false otherwise.

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