#include <libXBMC_pvr.h>

Public Member Functions
	CHelper_libXBMC_pvr (void)

	~CHelper_libXBMC_pvr (void)

bool	RegisterMe (void *handle)
	Resolve all callback methods. More...

void	TransferEpgEntry (const ADDON_HANDLE handle, const EPG_TAG *entry)
	Transfer an EPG tag from the add-on to XBMC. More...

void	TransferChannelEntry (const ADDON_HANDLE handle, const PVR_CHANNEL *entry)
	Transfer a channel entry from the add-on to XBMC. More...

void	TransferTimerEntry (const ADDON_HANDLE handle, const PVR_TIMER *entry)
	Transfer a timer entry from the add-on to XBMC. More...

void	TransferRecordingEntry (const ADDON_HANDLE handle, const PVR_RECORDING *entry)
	Transfer a recording entry from the add-on to XBMC. More...

void	TransferChannelGroup (const ADDON_HANDLE handle, const PVR_CHANNEL_GROUP *entry)
	Transfer a channel group from the add-on to XBMC. The group will be created if it doesn't exist. More...

void	TransferChannelGroupMember (const ADDON_HANDLE handle, const PVR_CHANNEL_GROUP_MEMBER *entry)
	Transfer a channel group member entry from the add-on to XBMC. The channel will be added to the group if the group can be found. More...

void	AddMenuHook (PVR_MENUHOOK *hook)
	Add or replace a menu hook for the context menu for this add-on. More...

void	Recording (const char strRecordingName, const char strFileName, bool bOn)
	Display a notification in XBMC that a recording started or stopped on the server. More...

void	TriggerTimerUpdate (void)
	Request XBMC to update it's list of timers. More...

void	TriggerRecordingUpdate (void)
	Request XBMC to update it's list of recordings. More...

void	TriggerChannelUpdate (void)
	Request XBMC to update it's list of channels. More...

void	TriggerEpgUpdate (unsigned int iChannelUid)
	Schedule an EPG update for the given channel channel. More...

void	TriggerChannelGroupsUpdate (void)
	Request XBMC to update it's list of channel groups. More...

void	ConnectionStateChange (const char strConnectionString, PVR_CONNECTION_STATE newState, const char strMessage)
	Notify a state change for a PVR backend connection. More...

void	EpgEventStateChange (EPG_TAG *tag, EPG_EVENT_STATE newState)
	Notify a state change for an EPG event. More...

xbmc_codec_t	GetCodecByName (const char *strCodecName)
	Get the codec id used by XBMC. More...

Constructor & Destructor Documentation

◆ CHelper_libXBMC_pvr()

CHelper_libXBMC_pvr::CHelper_libXBMC_pvr ( void )

inline

◆ ~CHelper_libXBMC_pvr()

CHelper_libXBMC_pvr::~CHelper_libXBMC_pvr ( void )

inline

Member Function Documentation

◆ AddMenuHook()

void CHelper_libXBMC_pvr::AddMenuHook ( PVR_MENUHOOK * hook )

inline

Add or replace a menu hook for the context menu for this add-on.

Parameters

hook	The hook to add

◆ ConnectionStateChange()

void CHelper_libXBMC_pvr::ConnectionStateChange	(	const char *	strConnectionString,
		PVR_CONNECTION_STATE	newState,
		const char *	strMessage
	)

inline

Notify a state change for a PVR backend connection.

Parameters

strConnectionString	The connection string reported by the backend that can be displayed in the UI.
newState	The new state.
strMessage	A localized addon-defined string representing the new state, that can be displayed in the UI or NULL if the Kodi-defined default string for the new state shall be displayed.

◆ EpgEventStateChange()

void CHelper_libXBMC_pvr::EpgEventStateChange	(	EPG_TAG *	tag,
		EPG_EVENT_STATE	newState
	)

inline

Notify a state change for an EPG event.

Parameters

tag	The EPG event.
newState	The new state. For EPG_EVENT_CREATED and EPG_EVENT_UPDATED, tag must be filled with all available event data, not just a delta. For EPG_EVENT_DELETED, it is sufficient to fill EPG_TAG.iUniqueBroadcastId

◆ GetCodecByName()

xbmc_codec_t CHelper_libXBMC_pvr::GetCodecByName ( const char * strCodecName )

inline

Get the codec id used by XBMC.

Parameters

strCodecName The name of the codec

Returns: The codec_id, or a codec_id with 0 values when not supported

◆ Recording()

void CHelper_libXBMC_pvr::Recording	(	const char *	strRecordingName,
		const char *	strFileName,
		bool	bOn
	)

inline

Display a notification in XBMC that a recording started or stopped on the server.

Parameters

strRecordingName	The name of the recording to display
strFileName	The filename of the recording
bOn	True when recording started, false when it stopped

◆ RegisterMe()

bool CHelper_libXBMC_pvr::RegisterMe ( void * handle )

inline

Resolve all callback methods.

Parameters

handle Pointer to the add-on

Returns: True when all methods were resolved, false otherwise.

◆ TransferChannelEntry()

void CHelper_libXBMC_pvr::TransferChannelEntry	(	const ADDON_HANDLE	handle,
		const PVR_CHANNEL *	entry
	)

inline

Transfer a channel entry from the add-on to XBMC.

Parameters

handle	The handle parameter that XBMC used when requesting the channel list
entry	The entry to transfer to XBMC

◆ TransferChannelGroup()

void CHelper_libXBMC_pvr::TransferChannelGroup	(	const ADDON_HANDLE	handle,
		const PVR_CHANNEL_GROUP *	entry
	)

inline

Transfer a channel group from the add-on to XBMC. The group will be created if it doesn't exist.

Parameters

handle	The handle parameter that XBMC used when requesting the channel groups list
entry	The entry to transfer to XBMC

◆ TransferChannelGroupMember()

void CHelper_libXBMC_pvr::TransferChannelGroupMember	(	const ADDON_HANDLE	handle,
		const PVR_CHANNEL_GROUP_MEMBER *	entry
	)

inline

Transfer a channel group member entry from the add-on to XBMC. The channel will be added to the group if the group can be found.

Parameters

handle	The handle parameter that XBMC used when requesting the channel group members list
entry	The entry to transfer to XBMC

◆ TransferEpgEntry()

void CHelper_libXBMC_pvr::TransferEpgEntry	(	const ADDON_HANDLE	handle,
		const EPG_TAG *	entry
	)

inline

Transfer an EPG tag from the add-on to XBMC.

Parameters

handle	The handle parameter that XBMC used when requesting the EPG data
entry	The entry to transfer to XBMC

◆ TransferRecordingEntry()

void CHelper_libXBMC_pvr::TransferRecordingEntry	(	const ADDON_HANDLE	handle,
		const PVR_RECORDING *	entry
	)

inline

Transfer a recording entry from the add-on to XBMC.

Parameters

handle	The handle parameter that XBMC used when requesting the recordings list
entry	The entry to transfer to XBMC

◆ TransferTimerEntry()

void CHelper_libXBMC_pvr::TransferTimerEntry	(	const ADDON_HANDLE	handle,
		const PVR_TIMER *	entry
	)

inline

Transfer a timer entry from the add-on to XBMC.

Parameters

handle	The handle parameter that XBMC used when requesting the timers list
entry	The entry to transfer to XBMC

◆ TriggerChannelGroupsUpdate()

void CHelper_libXBMC_pvr::TriggerChannelGroupsUpdate ( void )

inline

Request XBMC to update it's list of channel groups.

◆ TriggerChannelUpdate()

void CHelper_libXBMC_pvr::TriggerChannelUpdate ( void )

inline

Request XBMC to update it's list of channels.

◆ TriggerEpgUpdate()

void CHelper_libXBMC_pvr::TriggerEpgUpdate ( unsigned int iChannelUid )

inline

Schedule an EPG update for the given channel channel.

Parameters

iChannelUid The unique id of the channel for this add-on

◆ TriggerRecordingUpdate()

void CHelper_libXBMC_pvr::TriggerRecordingUpdate ( void )

inline

Request XBMC to update it's list of recordings.

◆ TriggerTimerUpdate()

void CHelper_libXBMC_pvr::TriggerTimerUpdate ( void )

inline

Request XBMC to update it's list of timers.

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

libXBMC_pvr.h

Public Member Functions

Constructor & Destructor Documentation

◆ CHelper_libXBMC_pvr()

◆ ~CHelper_libXBMC_pvr()

Member Function Documentation

◆ AddMenuHook()

◆ ConnectionStateChange()

◆ EpgEventStateChange()

◆ GetCodecByName()

◆ Recording()

◆ RegisterMe()

◆ TransferChannelEntry()

◆ TransferChannelGroup()

◆ TransferChannelGroupMember()

◆ TransferEpgEntry()

◆ TransferRecordingEntry()

◆ TransferTimerEntry()

◆ TriggerChannelGroupsUpdate()

◆ TriggerChannelUpdate()

◆ TriggerEpgUpdate()

◆ TriggerRecordingUpdate()

◆ TriggerTimerUpdate()