#include <PVRTimerInfoTag.h>

Inheritance diagram for PVR::CPVRTimerInfoTag:

Classes
struct	CustomPropDetails
	custom property detail: type, value More...

Public Types
using	CustomPropsMap = std::map<unsigned int, CustomPropDetails>
	custom properties map: <prop id, details>

Public Member Functions
	CPVRTimerInfoTag (bool bRadio=false)

	CPVRTimerInfoTag (const PVR_TIMER &timer, const std::shared_ptr< CPVRChannel > &channel, unsigned int iClientId, const ADDON::CAddonVersion &addonApiVersion)

bool	operator== (const CPVRTimerInfoTag &right) const

bool	operator!= (const CPVRTimerInfoTag &right) const

void	Serialize (CVariant &value) const override

void	SetEpgInfoTag (const std::shared_ptr< CPVREpgInfoTag > &tag)
	Associate the given epg tag with this timer.

std::shared_ptr< CPVREpgInfoTag >	GetEpgInfoTag (bool bCreate=true) const
	get the epg info tag associated with this timer, if any

bool	UpdateEntry (const std::shared_ptr< const CPVRTimerInfoTag > &tag)
	updates this timer excluding the state of any children.

bool	UpdateChildState (const std::shared_ptr< const CPVRTimerInfoTag > &childTimer, bool bAdd)
	merge in the state of this child timer.

void	ResetChildState ()
	reset the state of children related to this timer.

bool	IsActive () const
	Whether this timer is active.

bool	IsBroken () const
	Whether this timer is broken.

bool	HasConflict () const
	Whether this timer has a conflict.

bool	IsRecording () const
	Whether this timer is currently recording.

bool	IsDisabled () const
	Whether this timer is disabled, for example by the user.

const std::shared_ptr< CPVRTimerType >	GetTimerType () const
	Gets the type of this timer.

void	SetTimerType (const std::shared_ptr< CPVRTimerType > &type)
	Sets the type of this timer.

bool	IsTimerRule () const
	Checks whether this is a timer rule (vs. one time timer).

bool	IsReminder () const
	Checks whether this is a reminder timer (vs. recording timer).

bool	IsManual () const
	Checks whether this is a manual (vs. epg-based) timer.

bool	IsEpgBased () const
	Checks whether this is an epg-based (vs. manual) timer.

int	ClientID () const
	The ID of the client for this timer.

bool	IsOwnedByClient () const
	Check, whether this timer is owned by a pvr client or by Kodi.

bool	IsRadio () const
	Whether this timer is for Radio or TV.

const std::string &	Path () const
	The path that identifies this timer.

int	ClientIndex () const
	The index for this timer, as given by the client.

int	ParentClientIndex () const
	The index for the parent of this timer, as given by the client. Timers scheduled by a timer rule will have a parant index != PVR_TIMER_NO_PARENT.

bool	HasParent () const
	Whether this timer has a parent.

unsigned int	TimerID () const
	The local ID for this timer, as given by Kodi.

void	SetTimerID (unsigned int id)
	Set the local ID for this timer.

int	ClientChannelUID () const
	The UID of the channel for this timer.

PVR_TIMER_STATE	State () const
	The state for this timer.

void	SetState (PVR_TIMER_STATE state)
	Set the state for this timer.

const std::string &	Title () const
	The title for this timer.

bool	HasChannel () const
	Check whether this timer has an associated channel.

std::shared_ptr< CPVRChannel >	Channel () const
	Get the channel associated with this timer, if any.

void	UpdateChannel ()
	Update the channel associated with this timer, based on current client ID and channel UID.

std::string	ChannelName () const
	The name of the channel associated with this timer, if any.

std::string	ChannelIcon () const
	The path for the channel icon associated with this timer, if any.

CDateTime	StartAsUTC () const
	The start date and time for this timer, as UTC.

CDateTime	StartAsLocalTime () const
	The start date and time for this timer, as local time.

void	SetStartFromUTC (const CDateTime &start)
	Set the start date and time from a CDateTime instance carrying the data as UTC.

void	SetStartFromLocalTime (const CDateTime &start)
	Set the start date and time from a CDateTime instance carrying the data as local time.

CDateTime	EndAsUTC () const
	The end date and time for this timer, as UTC.

CDateTime	EndAsLocalTime () const
	The end date and time for this timer, as local time.

void	SetEndFromUTC (const CDateTime &end)
	Set the end date and time from a CDateTime instance carrying the data as UTC.

void	SetEndFromLocalTime (const CDateTime &end)
	Set the end date and time from a CDateTime instance carrying the data as local time.

CDateTime	FirstDayAsUTC () const
	The first day for this timer, as UTC.

CDateTime	FirstDayAsLocalTime () const
	The first day for this timer, as local time.

void	SetFirstDayFromUTC (const CDateTime &firstDay)
	Set the first dday from a CDateTime instance carrying the data as UTC.

void	SetFirstDayFromLocalTime (const CDateTime &firstDay)
	Set the first dday from a CDateTime instance carrying the data as local time.

int	GetDuration () const
	Get the duration of this timer in seconds, excluding padding times.

unsigned int	MarginStart () const
	Get time in minutes to start the recording before the start time of the programme.

unsigned int	MarginEnd () const
	Get time in minutes to end the recording after the end time of the programme.

unsigned int	WeekDays () const
	For timer rules, the days of week this timer rule is scheduled for.

bool	IsStartAnyTime () const
	For timer rules, whether start time is "any time", not a particular time.

bool	IsEndAnyTime () const
	For timer rules, whether end time is "any time", not a particular time.

bool	IsFullTextEpgSearch () const
	For timer rules, whether only the EPG programme title shall be searched or also other data like the programme's plot, if available.

const std::string &	EpgSearchString () const
	For timer rules, the epg data match string for searches. Format is backend-dependent, for example regexp.

const std::string &	SeriesLink () const
	The series link for this timer.

const std::string &	Directory () const
	The directory for the recordings for this timer.

int	Priority () const
	The priority for this timer.

int	Lifetime () const
	The life time for this timer.

int	MaxRecordings () const
	The maximum number of recordings for this timer.

int	PreventDupEpisodesPolicy () const
	The policy to be used to prevent duplicate episodes for this timer.

int	RecordingGroup () const
	The recording group for this timer.

const CustomPropsMap &	GetCustomProperties () const
	Get custom properties for this tag.

unsigned int	UniqueBroadcastID () const
	Get the UID of the epg event associated with this timer tag, if any.

bool	AddToClient () const
	Add this timer to the backend, transferring all local data of this timer to the backend.

TimerOperationResult	DeleteFromClient (bool bForce=false) const
	Delete this timer on the backend.

bool	UpdateOnClient ()
	Update this timer on the backend, transferring all local data of this timer to the backend.

bool	Persist ()
	Persist this timer in the local database.

bool	DeleteFromDatabase ()
	Delete this timer from the local database.

std::string	GetNotificationText () const
	GUI support: Get the text for the timer GUI notification.

std::string	GetDeletedNotificationText () const
	GUI support: Get the text for the timer GUI notification when a timer has been deleted.

const std::string &	Summary () const
	GUI support: Get the summary text for this timer, reflecting the timer schedule in a human readable form.

void	UpdateSummary ()
	GUI support: Update the summary text for this timer.

std::string	GetStatus (bool bRadio) const
	GUI support: Get the status text for this timer, reflecting its current state in a human readable form.

std::string	GetTypeAsString () const
	GUI support: Get the timer string in a human readable form.

Public Member Functions inherited from ISerializable

Static Public Member Functions
static std::shared_ptr< CPVRTimerInfoTag >	CreateInstantTimerTag (const std::shared_ptr< CPVRChannel > &channel, int iDuration=DEFAULT_PVRRECORD_INSTANTRECORDTIME)
	create a tag for an instant timer for a given channel

static std::shared_ptr< CPVRTimerInfoTag >	CreateTimerTag (const std::shared_ptr< CPVRChannel > &channel, const CDateTime &start, int iDuration)
	create a tag for a timer for a given channel at given time for given duration

static std::shared_ptr< CPVRTimerInfoTag >	CreateFromEpg (const std::shared_ptr< CPVREpgInfoTag > &tag, bool bCreateRule, bool bCreateReminder, bool bReadOnly=false)
	create a recording or reminder timer or timer rule for the given epg info tag.

static std::shared_ptr< CPVRTimerInfoTag >	CreateFromEpg (const std::shared_ptr< CPVREpgInfoTag > &tag, bool bCreateRule=false)
	create a timer or timer rule for the given epg info tag.

static std::shared_ptr< CPVRTimerInfoTag >	CreateReminderFromDate (const CDateTime &start, int iDuration, const std::shared_ptr< CPVRTimerInfoTag > &parent=std::shared_ptr< CPVRTimerInfoTag >())
	create a reminder timer for the given start date.

static std::shared_ptr< CPVRTimerInfoTag >	CreateReminderFromEpg (const std::shared_ptr< CPVREpgInfoTag > &tag, const std::shared_ptr< CPVRTimerInfoTag > &parent=std::shared_ptr< CPVRTimerInfoTag >())
	create a reminder timer for the given epg info tag.

static CDateTime	ConvertUTCToLocalTime (const CDateTime &utc)
	Helper function to convert a given CDateTime containing data as UTC to local time.

static CDateTime	ConvertLocalTimeToUTC (const CDateTime &local)
	Helper function to convert a given CDateTime containing data as local time to UTC.

static std::string	GetWeekdaysString (unsigned int iWeekdays, bool bEpgBased, bool bLongMultiDaysFormat)
	GUI support: Return string representation for any possible combination of weekdays.

Static Public Attributes
static constexpr int	DEFAULT_PVRRECORD_INSTANTRECORDTIME = -1

Friends
class	CGUIDialogPVRTimerSettings

class	CPVRDatabase

Additional Inherited Members
Protected Member Functions inherited from ISerializable
	~ISerializable ()=default

Member Typedef Documentation

◆ CustomPropsMap

using PVR::CPVRTimerInfoTag::CustomPropsMap = std::map<unsigned int, CustomPropDetails>

custom properties map: <prop id, details>

Constructor & Destructor Documentation

◆ CPVRTimerInfoTag() [1/2]

CPVRTimerInfoTag::CPVRTimerInfoTag ( bool bRadio = false )

explicit

◆ CPVRTimerInfoTag() [2/2]

CPVRTimerInfoTag::CPVRTimerInfoTag	(	const PVR_TIMER &	timer,
		const std::shared_ptr< CPVRChannel > &	channel,
		unsigned int	iClientId,
		const ADDON::CAddonVersion &	addonApiVersion )

Todo: version check can be removed with next incompatible API bump

Member Function Documentation

◆ AddToClient()

bool CPVRTimerInfoTag::AddToClient ( ) const

Add this timer to the backend, transferring all local data of this timer to the backend.

Returns: True on success, false otherwise.

◆ Channel()

std::shared_ptr< CPVRChannel > CPVRTimerInfoTag::Channel ( ) const

Get the channel associated with this timer, if any.

Returns: the channel or null if non is associated with this timer.

◆ ChannelIcon()

std::string CPVRTimerInfoTag::ChannelIcon ( ) const

The path for the channel icon associated with this timer, if any.

Returns: The channel icon path.

◆ ChannelName()

std::string CPVRTimerInfoTag::ChannelName ( ) const

The name of the channel associated with this timer, if any.

Returns: The channel name.

◆ ClientChannelUID()

int PVR::CPVRTimerInfoTag::ClientChannelUID ( ) const

inline

The UID of the channel for this timer.

Returns: The channel UID or PVR_CHANNEL_INVALID_UID if not available.

◆ ClientID()

int PVR::CPVRTimerInfoTag::ClientID ( ) const

inline

The ID of the client for this timer.

Returns: The client ID or PVR_CLIENT_INVALID_UID if this is a local timer.

◆ ClientIndex()

int PVR::CPVRTimerInfoTag::ClientIndex ( ) const

inline

The index for this timer, as given by the client.

Returns: The client index or PVR_TIMER_NO_CLIENT_INDEX if the timer was just created locally by Kodi and was not yet added by the client.

◆ ConvertLocalTimeToUTC()

CDateTime CPVRTimerInfoTag::ConvertLocalTimeToUTC ( const CDateTime & local )

static

Helper function to convert a given CDateTime containing data as local time to UTC.

Parameters

local A CDateTime instance carrying data as local time.

Returns: A CDateTime instance carrying data as UTC.

◆ ConvertUTCToLocalTime()

CDateTime CPVRTimerInfoTag::ConvertUTCToLocalTime ( const CDateTime & utc )

static

Helper function to convert a given CDateTime containing data as UTC to local time.

Parameters

utc	A CDateTime instance carrying data as UTC.

Returns: A CDateTime instance carrying data as local time.

◆ CreateFromEpg() [1/2]

std::shared_ptr< CPVRTimerInfoTag > CPVRTimerInfoTag::CreateFromEpg	(	const std::shared_ptr< CPVREpgInfoTag > &	tag,
		bool	bCreateRule,
		bool	bCreateReminder,
		bool	bReadOnly = false )

static

create a recording or reminder timer or timer rule for the given epg info tag.

Parameters

tag	the epg info tag
bCreateRule	if true, create a timer rule, create a one shot timer otherwise
bCreateReminder	if true, create a reminder timer or rule, create a recording timer or rule otherwise
bReadOnly	whether the timer/rule is read only

Returns: the timer or null if timer could not be created

◆ CreateFromEpg() [2/2]

std::shared_ptr< CPVRTimerInfoTag > CPVRTimerInfoTag::CreateFromEpg	(	const std::shared_ptr< CPVREpgInfoTag > &	tag,
		bool	bCreateRule = false )

static

create a timer or timer rule for the given epg info tag.

Parameters

tag	the epg info tag
bCreateRule	if true, create a timer rule, create a one shot timer otherwise

Returns: the timer or null if timer could not be created

◆ CreateInstantTimerTag()

std::shared_ptr< CPVRTimerInfoTag > CPVRTimerInfoTag::CreateInstantTimerTag	(	const std::shared_ptr< CPVRChannel > &	channel,
		int	iDuration = DEFAULT_PVRRECORD_INSTANTRECORDTIME )

static

create a tag for an instant timer for a given channel

Parameters

channel	is the channel the instant timer is to be created for
iDuration	is the duration for the instant timer, DEFAULT_PVRRECORD_INSTANTRECORDTIME denotes system default (setting value)

Returns: the timer or null if timer could not be created

◆ CreateReminderFromDate()

std::shared_ptr< CPVRTimerInfoTag > CPVRTimerInfoTag::CreateReminderFromDate	(	const CDateTime &	start,
		int	iDuration,
		const std::shared_ptr< CPVRTimerInfoTag > &	parent = std::shared_ptr<CPVRTimerInfoTag>() )

static

create a reminder timer for the given start date.

Parameters

start	the start date
iDuration	the duration the reminder is valid
parent	If non-zero, the new timer will be made a child of the given timer rule

Returns: the timer or null if timer could not be created

◆ CreateReminderFromEpg()

std::shared_ptr< CPVRTimerInfoTag > CPVRTimerInfoTag::CreateReminderFromEpg	(	const std::shared_ptr< CPVREpgInfoTag > &	tag,
		const std::shared_ptr< CPVRTimerInfoTag > &	parent = std::shared_ptr<CPVRTimerInfoTag>() )

static

create a reminder timer for the given epg info tag.

Parameters

tag	the epg info tag
parent	If non-zero, the new timer will be made a child of the given timer rule

Returns: the timer or null if timer could not be created

◆ CreateTimerTag()

std::shared_ptr< CPVRTimerInfoTag > CPVRTimerInfoTag::CreateTimerTag	(	const std::shared_ptr< CPVRChannel > &	channel,
		const CDateTime &	start,
		int	iDuration )

static

create a tag for a timer for a given channel at given time for given duration

Parameters

channel	is the channel the timer is to be created for
start	is the start time for the recording
iDuration	is the duration of the recording

Returns: the timer or null if timer could not be created

◆ DeleteFromClient()

TimerOperationResult CPVRTimerInfoTag::DeleteFromClient ( bool bForce = false ) const

Delete this timer on the backend.

Parameters

bForce Control what to do in case the timer is currently recording. True to force to delete the timer, false to return TimerDeleteResult::RECORDING.

Returns: The result.

◆ DeleteFromDatabase()

bool CPVRTimerInfoTag::DeleteFromDatabase ( )

Delete this timer from the local database.

Returns: True on success, false otherwise.

◆ Directory()

const std::string & PVR::CPVRTimerInfoTag::Directory ( ) const

inline

The directory for the recordings for this timer.

Returns: The directory.

◆ EndAsLocalTime()

CDateTime CPVRTimerInfoTag::EndAsLocalTime ( ) const

The end date and time for this timer, as local time.

Returns: The start date and time.

◆ EndAsUTC()

CDateTime CPVRTimerInfoTag::EndAsUTC ( ) const

The end date and time for this timer, as UTC.

Returns: The start date and time.

◆ EpgSearchString()

const std::string & PVR::CPVRTimerInfoTag::EpgSearchString ( ) const

inline

For timer rules, the epg data match string for searches. Format is backend-dependent, for example regexp.

Returns: The search string

◆ FirstDayAsLocalTime()

CDateTime CPVRTimerInfoTag::FirstDayAsLocalTime ( ) const

The first day for this timer, as local time.

Returns: The first day.

◆ FirstDayAsUTC()

CDateTime CPVRTimerInfoTag::FirstDayAsUTC ( ) const

The first day for this timer, as UTC.

Returns: The first day.

◆ GetCustomProperties()

const CustomPropsMap & PVR::CPVRTimerInfoTag::GetCustomProperties ( ) const

inline

Get custom properties for this tag.

Returns: The list of properties or an empty list if none present.

◆ GetDeletedNotificationText()

std::string CPVRTimerInfoTag::GetDeletedNotificationText ( ) const

GUI support: Get the text for the timer GUI notification when a timer has been deleted.

Returns: The notification text.

◆ GetDuration()

int CPVRTimerInfoTag::GetDuration ( ) const

Get the duration of this timer in seconds, excluding padding times.

Returns: The duration.

◆ GetEpgInfoTag()

std::shared_ptr< CPVREpgInfoTag > CPVRTimerInfoTag::GetEpgInfoTag ( bool bCreate = true ) const

get the epg info tag associated with this timer, if any

Parameters

bCreate if true, try to find the epg tag if not yet set (lazy evaluation)

Returns: the epg info tag associated with this timer or null if there is no tag

◆ GetNotificationText()

std::string CPVRTimerInfoTag::GetNotificationText ( ) const

GUI support: Get the text for the timer GUI notification.

Returns: The notification text.

◆ GetStatus()

std::string CPVRTimerInfoTag::GetStatus ( bool bRadio ) const

GUI support: Get the status text for this timer, reflecting its current state in a human readable form.

Returns: The status string.

◆ GetTimerType()

const std::shared_ptr< CPVRTimerType > PVR::CPVRTimerInfoTag::GetTimerType ( ) const

inline

Gets the type of this timer.

Returns: the timer type or NULL if this tag has no timer type.

◆ GetTypeAsString()

std::string CPVRTimerInfoTag::GetTypeAsString ( ) const

GUI support: Get the timer string in a human readable form.

Returns: The type string.

Get the type string of this timer

◆ GetWeekdaysString()

std::string CPVRTimerInfoTag::GetWeekdaysString	(	unsigned int	iWeekdays,
		bool	bEpgBased,
		bool	bLongMultiDaysFormat )

static

GUI support: Return string representation for any possible combination of weekdays.

Parameters

iWeekdays	weekdays as bit mask (0x01 = Mo, 0x02 = Tu, ...)
bEpgBased	context is an epg-based timer
bLongMultiDaysFormat	use long format. ("Mo-__-We-__-Fr-Sa-__" vs. "Mo-We-Fr-Sa")

Returns: The weekdays string representation.

◆ HasChannel()

bool CPVRTimerInfoTag::HasChannel ( ) const

Check whether this timer has an associated channel.

Returns: True if this timer has a channel set, false otherwise.

◆ HasConflict()

bool PVR::CPVRTimerInfoTag::HasConflict ( ) const

inline

Whether this timer has a conflict.

Returns: True if this timer won't result in a recording because it is in conflict with another timer or live stream, false otherwise.

◆ HasParent()

bool PVR::CPVRTimerInfoTag::HasParent ( ) const

inline

Whether this timer has a parent.

Returns: True if timer has a parent, false otherwise.

◆ IsActive()

bool PVR::CPVRTimerInfoTag::IsActive ( ) const

inline

Whether this timer is active.

Returns: True if this timer is active, false otherwise.

◆ IsBroken()

bool PVR::CPVRTimerInfoTag::IsBroken ( ) const

inline

Whether this timer is broken.

Returns: True if this timer won't result in a recording because it is broken for some reason, false otherwise

◆ IsDisabled()

bool PVR::CPVRTimerInfoTag::IsDisabled ( ) const

inline

Whether this timer is disabled, for example by the user.

Returns: True if disabled, false otherwise.

◆ IsEndAnyTime()

bool PVR::CPVRTimerInfoTag::IsEndAnyTime ( ) const

inline

For timer rules, whether end time is "any time", not a particular time.

Returns: True, if timer end is "any time", false otherwise.

◆ IsEpgBased()

bool PVR::CPVRTimerInfoTag::IsEpgBased ( ) const

inline

Checks whether this is an epg-based (vs. manual) timer.

Returns: True if this is an epg-Based timer, false otherwise.

◆ IsFullTextEpgSearch()

bool PVR::CPVRTimerInfoTag::IsFullTextEpgSearch ( ) const

inline

For timer rules, whether only the EPG programme title shall be searched or also other data like the programme's plot, if available.

Returns: True, if not only the programme's title shall be included in EPG search, false otherwise.

◆ IsManual()

bool PVR::CPVRTimerInfoTag::IsManual ( ) const

inline

Checks whether this is a manual (vs. epg-based) timer.

Returns: True if this is a manual timer, false otherwise.

◆ IsOwnedByClient()

bool CPVRTimerInfoTag::IsOwnedByClient ( ) const

Check, whether this timer is owned by a pvr client or by Kodi.

Returns: True, if owned by a pvr client, false otherwise.

◆ IsRadio()

bool PVR::CPVRTimerInfoTag::IsRadio ( ) const

inline

Whether this timer is for Radio or TV.

Returns: True if Radio, false otherwise.

◆ IsRecording()

bool PVR::CPVRTimerInfoTag::IsRecording ( ) const

inline

Whether this timer is currently recording.

Returns: True if recording, false otherwise.

◆ IsReminder()

bool PVR::CPVRTimerInfoTag::IsReminder ( ) const

inline

Checks whether this is a reminder timer (vs. recording timer).

Returns: True if this is a reminder timer, false otherwise.

◆ IsStartAnyTime()

bool PVR::CPVRTimerInfoTag::IsStartAnyTime ( ) const

inline

For timer rules, whether start time is "any time", not a particular time.

Returns: True, if timer start is "any time", false otherwise.

◆ IsTimerRule()

bool PVR::CPVRTimerInfoTag::IsTimerRule ( ) const

inline

Checks whether this is a timer rule (vs. one time timer).

Returns: True if this is a timer rule, false otherwise.

◆ Lifetime()

int PVR::CPVRTimerInfoTag::Lifetime ( ) const

inline

The life time for this timer.

Returns: The life time.

◆ MarginEnd()

unsigned int PVR::CPVRTimerInfoTag::MarginEnd ( ) const

inline

Get time in minutes to end the recording after the end time of the programme.

Returns: The end padding time.

◆ MarginStart()

unsigned int PVR::CPVRTimerInfoTag::MarginStart ( ) const

inline

Get time in minutes to start the recording before the start time of the programme.

Returns: The start padding time.

◆ MaxRecordings()

int PVR::CPVRTimerInfoTag::MaxRecordings ( ) const

inline

The maximum number of recordings for this timer.

Returns: The number of maximum recordings.

◆ operator!=()

bool CPVRTimerInfoTag::operator!= ( const CPVRTimerInfoTag & right ) const

◆ operator==()

bool CPVRTimerInfoTag::operator== ( const CPVRTimerInfoTag & right ) const

◆ ParentClientIndex()

int PVR::CPVRTimerInfoTag::ParentClientIndex ( ) const

inline

The index for the parent of this timer, as given by the client. Timers scheduled by a timer rule will have a parant index != PVR_TIMER_NO_PARENT.

Returns: The client index or PVR_TIMER_NO_PARENT if the timer has no parent.

◆ Path()

const std::string & CPVRTimerInfoTag::Path ( ) const

The path that identifies this timer.

Returns: The path.

◆ Persist()

bool CPVRTimerInfoTag::Persist ( )

Persist this timer in the local database.

Returns: True on success, false otherwise.

◆ PreventDupEpisodesPolicy()

int PVR::CPVRTimerInfoTag::PreventDupEpisodesPolicy ( ) const

inline

The policy to be used to prevent duplicate episodes for this timer.

Returns: The policy for preventing duplicate episodes.

◆ Priority()

int PVR::CPVRTimerInfoTag::Priority ( ) const

inline

The priority for this timer.

Returns: The priority.

◆ RecordingGroup()

int PVR::CPVRTimerInfoTag::RecordingGroup ( ) const

inline

The recording group for this timer.

Returns: The recording group.

◆ ResetChildState()

void CPVRTimerInfoTag::ResetChildState ( )

reset the state of children related to this timer.

◆ Serialize()

void CPVRTimerInfoTag::Serialize ( CVariant & value ) const

overridevirtual

Implements ISerializable.

◆ SeriesLink()

const std::string & CPVRTimerInfoTag::SeriesLink ( ) const

The series link for this timer.

Returns: The series link or empty string, if not available.

◆ SetEndFromLocalTime()

void CPVRTimerInfoTag::SetEndFromLocalTime ( const CDateTime & end )

Set the end date and time from a CDateTime instance carrying the data as local time.

Parameters

start The end date and time as local time.

◆ SetEndFromUTC()

void CPVRTimerInfoTag::SetEndFromUTC ( const CDateTime & end )

Set the end date and time from a CDateTime instance carrying the data as UTC.

Parameters

start The end date and time as UTC.

◆ SetEpgInfoTag()

void CPVRTimerInfoTag::SetEpgInfoTag ( const std::shared_ptr< CPVREpgInfoTag > & tag )

Associate the given epg tag with this timer.

Parameters

tag	The epg tag to assign.

◆ SetFirstDayFromLocalTime()

void CPVRTimerInfoTag::SetFirstDayFromLocalTime ( const CDateTime & firstDay )

Set the first dday from a CDateTime instance carrying the data as local time.

Parameters

start The first day as local time.

◆ SetFirstDayFromUTC()

void CPVRTimerInfoTag::SetFirstDayFromUTC ( const CDateTime & firstDay )

Set the first dday from a CDateTime instance carrying the data as UTC.

Parameters

start The first day as UTC.

◆ SetStartFromLocalTime()

void CPVRTimerInfoTag::SetStartFromLocalTime ( const CDateTime & start )

Set the start date and time from a CDateTime instance carrying the data as local time.

Parameters

start The start date and time as local time.

◆ SetStartFromUTC()

void CPVRTimerInfoTag::SetStartFromUTC ( const CDateTime & start )

Set the start date and time from a CDateTime instance carrying the data as UTC.

Parameters

start The start date and time as UTC.

◆ SetState()

void PVR::CPVRTimerInfoTag::SetState ( PVR_TIMER_STATE state )

inline

Set the state for this timer.

Parameters

state The state to set.

◆ SetTimerID()

void PVR::CPVRTimerInfoTag::SetTimerID ( unsigned int id )

inline

Set the local ID for this timer.

Parameters

id	The ID to set.

◆ SetTimerType()

void CPVRTimerInfoTag::SetTimerType ( const std::shared_ptr< CPVRTimerType > & type )

Sets the type of this timer.

Parameters

the	new timer type.

◆ StartAsLocalTime()

CDateTime CPVRTimerInfoTag::StartAsLocalTime ( ) const

The start date and time for this timer, as local time.

Returns: The start date and time.

◆ StartAsUTC()

CDateTime CPVRTimerInfoTag::StartAsUTC ( ) const

The start date and time for this timer, as UTC.

Returns: The start date and time.

◆ State()

PVR_TIMER_STATE PVR::CPVRTimerInfoTag::State ( ) const

inline

The state for this timer.

Returns: The state.

◆ Summary()

const std::string & CPVRTimerInfoTag::Summary ( ) const

GUI support: Get the summary text for this timer, reflecting the timer schedule in a human readable form.

Returns: The summary string.

◆ TimerID()

unsigned int PVR::CPVRTimerInfoTag::TimerID ( ) const

inline

The local ID for this timer, as given by Kodi.

Returns: The ID or 0 if not yet set.

◆ Title()

const std::string & CPVRTimerInfoTag::Title ( ) const

The title for this timer.

Returns: The title.

◆ UniqueBroadcastID()

unsigned int PVR::CPVRTimerInfoTag::UniqueBroadcastID ( ) const

inline

Get the UID of the epg event associated with this timer tag, if any.

Returns: The UID or EPG_TAG_INVALID_UID.

◆ UpdateChannel()

void CPVRTimerInfoTag::UpdateChannel ( )

Update the channel associated with this timer, based on current client ID and channel UID.

◆ UpdateChildState()

bool CPVRTimerInfoTag::UpdateChildState	(	const std::shared_ptr< const CPVRTimerInfoTag > &	childTimer,
		bool	bAdd )

merge in the state of this child timer.

Parameters

childTimer	The child timer
bAdd	If true, add child's data to parent's state, otherwise subtract.

Returns: true if the child timer's state was merged successfully

◆ UpdateEntry()

bool CPVRTimerInfoTag::UpdateEntry ( const std::shared_ptr< const CPVRTimerInfoTag > & tag )

updates this timer excluding the state of any children.

Parameters

tag	A timer containing the data that shall be merged into this timer's data.

Returns: true if the timer was updated successfully

◆ UpdateOnClient()

bool CPVRTimerInfoTag::UpdateOnClient ( )

Update this timer on the backend, transferring all local data of this timer to the backend.

Returns: True on success, false otherwise.

◆ UpdateSummary()

void CPVRTimerInfoTag::UpdateSummary ( )

GUI support: Update the summary text for this timer.

◆ WeekDays()

unsigned int PVR::CPVRTimerInfoTag::WeekDays ( ) const

inline

For timer rules, the days of week this timer rule is scheduled for.

Returns: The days of week.

Friends And Related Symbol Documentation

◆ CGUIDialogPVRTimerSettings

friend class CGUIDialogPVRTimerSettings

friend

◆ CPVRDatabase

friend class CPVRDatabase

friend

Member Data Documentation

◆ DEFAULT_PVRRECORD_INSTANTRECORDTIME

int PVR::CPVRTimerInfoTag::DEFAULT_PVRRECORD_INSTANTRECORDTIME = -1

staticconstexpr

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ CustomPropsMap

Constructor & Destructor Documentation

◆ CPVRTimerInfoTag() [1/2]

◆ CPVRTimerInfoTag() [2/2]

Member Function Documentation

◆ AddToClient()

◆ Channel()

◆ ChannelIcon()

◆ ChannelName()

◆ ClientChannelUID()

◆ ClientID()

◆ ClientIndex()

◆ ConvertLocalTimeToUTC()

◆ ConvertUTCToLocalTime()

◆ CreateFromEpg() [1/2]

◆ CreateFromEpg() [2/2]

◆ CreateInstantTimerTag()

◆ CreateReminderFromDate()

◆ CreateReminderFromEpg()

◆ CreateTimerTag()

◆ DeleteFromClient()

◆ DeleteFromDatabase()

◆ Directory()

◆ EndAsLocalTime()

◆ EndAsUTC()

◆ EpgSearchString()

◆ FirstDayAsLocalTime()

◆ FirstDayAsUTC()

◆ GetCustomProperties()

◆ GetDeletedNotificationText()

◆ GetDuration()

◆ GetEpgInfoTag()

◆ GetNotificationText()

◆ GetStatus()

◆ GetTimerType()

◆ GetTypeAsString()

◆ GetWeekdaysString()

◆ HasChannel()

◆ HasConflict()

◆ HasParent()

◆ IsActive()

◆ IsBroken()

◆ IsDisabled()

◆ IsEndAnyTime()

◆ IsEpgBased()

◆ IsFullTextEpgSearch()

◆ IsManual()

◆ IsOwnedByClient()

◆ IsRadio()

◆ IsRecording()

◆ IsReminder()

◆ IsStartAnyTime()

◆ IsTimerRule()

◆ Lifetime()

◆ MarginEnd()

◆ MarginStart()

◆ MaxRecordings()

◆ operator!=()

◆ operator==()

◆ ParentClientIndex()

◆ Path()

◆ Persist()

◆ PreventDupEpisodesPolicy()

◆ Priority()

◆ RecordingGroup()

◆ ResetChildState()

◆ Serialize()

◆ SeriesLink()

◆ SetEndFromLocalTime()

◆ SetEndFromUTC()

◆ SetEpgInfoTag()

◆ SetFirstDayFromLocalTime()