Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
|
#include <PVRGUIActionsTimers.h>
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< CFileItem > | GetTimerRule (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 |
CPVRGUIActionsTimers::CPVRGUIActionsTimers | ( | ) |
|
overridedefault |
Create a new reminder timer, non-interactive.
item | containing epg data to create a reminder timer for. item must be an epg tag. |
Open the timer settings dialog to create a new tv or radio timer.
bRadio | indicates whether a radio or tv timer shall be created. |
Create a new timer, either interactive or non-interactive.
item | containing epg data to create a timer for. item must be an epg tag or a channel. |
bShowTimerSettings | is used to control whether a settings dialog will be opened prior creating the timer. |
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.
bool CPVRGUIActionsTimers::AddTimerRule | ( | const CFileItem & | item, |
bool | bShowTimerSettings, | ||
bool | bFallbackToOneShotTimer ) const |
Create a new timer rule, either interactive or non-interactive.
item | containing epg data to create a timer rule for. item must be an epg tag or a channel. |
bShowTimerSettings | is used to control whether a settings dialog will be opened prior creating the timer rule. |
bFallbackToOneShotTimer | if no timer rule can be created, try to create a one-shot timer instead. |
void CPVRGUIActionsTimers::AnnounceReminders | ( | ) | const |
Announce due reminders, if any.
Delete a timer, always showing a confirmation dialog.
item | containing a timer to delete. item must be a timer, an epg tag or a channel. |
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.
timer | containing a timer or timer rule to delete. |
bIsRecording | denotes whether the timer is currently recording (controls correct confirmation dialog). |
bDeleteRule | denotes to delete a timer rule. For convenience, one can pass a timer created by a rule. |
Delete a timer rule, always showing a confirmation dialog.
item | containing a timer rule to delete. item must be a timer, an epg tag or a channel. |
Open the timer settings dialog to edit an existing timer.
item | containing an epg tag or a timer. |
Open the timer settings dialog to edit an existing timer rule.
item | containing an epg tag or a timer. |
Get the timer rule for a given timer.
item | containing an item to query the timer rule for. item must be a timer or an epg tag. |
bool CPVRGUIActionsTimers::SetRecordingOnChannel | ( | const std::shared_ptr< CPVRChannel > & | channel, |
bool | bOnOff ) |
Start or stop recording on a given channel.
channel | the channel to start/stop recording. |
bOnOff | True to start recording, false to stop. |
Stop a currently active recording, always showing a confirmation dialog.
item | containing a recording to stop. item must be a timer, an epg tag or a channel. |
bool CPVRGUIActionsTimers::ToggleRecordingOnPlayingChannel | ( | ) |
Toggle recording on the currently playing channel, if any.
Creates or deletes a timer for the given epg tag.
item | containing an epg tag. |
Toggles a given timer's enabled/disabled state.
item | containing a timer. |