class PVRMenuhook

Context menu hook
Menu hooks that are available in the context menus while playing a stream via this add-on. And in the Live TV settings dialog. More...

Topics
	Value Help

Classes
class	kodi::addon::PVRMenuhook

Functions
void	kodi::addon::PVRMenuhook::SetHookId (unsigned int hookId)
	required This hook's identifier.
unsigned int	kodi::addon::PVRMenuhook::GetHookId () const
	To get with SetHookId() changed values.
void	kodi::addon::PVRMenuhook::SetLocalizedStringId (unsigned int localizedStringId)
	required The id of the label for this hook in kodi::GetLocalizedString().
unsigned int	kodi::addon::PVRMenuhook::GetLocalizedStringId () const
	To get with SetLocalizedStringId() changed values.
void	kodi::addon::PVRMenuhook::SetCategory (PVR_MENUHOOK_CAT category)
	required Category of menu hook.
PVR_MENUHOOK_CAT	kodi::addon::PVRMenuhook::GetCategory () const
	To get with SetCategory() changed values.

Detailed Description

Context menu hook
Menu hooks that are available in the context menus while playing a stream via this add-on. And in the Live TV settings dialog.

Optional class constructor with value set.

Possible menu's given to Kodi.

This can be becomes used on this, if kodi::addon::CInstancePVRClient::AddMenuHook() was set to related type:

• kodi::addon::CInstancePVRClient::CallSettingsMenuHook()
• kodi::addon::CInstancePVRClient::CallChannelMenuHook()
• kodi::addon::CInstancePVRClient::CallEPGMenuHook()
• kodi::addon::CInstancePVRClient::CallRecordingMenuHook()
• kodi::addon::CInstancePVRClient::CallTimerMenuHook()

---

The following table contains values that can be set with class PVRMenuhook :

Name	Type	Set call	Get call	Usage
This hook's identifier	unsigned int	SetHookId	GetHookId	required to set
Localized string Identifier	unsigned int	SetLocalizedStringId	GetLocalizedStringId	required to set
Category of menu hook	PVR_MENUHOOK_CAT	SetCategory	GetCategory	required to set

Parameters

[in]	hookId	This hook's identifier
[in]	localizedStringId	Localized string identifier
[in]	category	Category of menu hook, defined with PVR_MENUHOOK_CAT

---

Example:

AddMenuHook(kodi::addon::PVRMenuhook(1, 30001, PVR_MENUHOOK_CHANNEL));

Function Documentation

GetCategory()

PVR_MENUHOOK_CAT kodi::addon::PVRMenuhook::GetCategory ( ) const

inline

To get with SetCategory() changed values.

GetHookId()

unsigned int kodi::addon::PVRMenuhook::GetHookId ( ) const

inline

To get with SetHookId() changed values.

GetLocalizedStringId()

unsigned int kodi::addon::PVRMenuhook::GetLocalizedStringId ( ) const

inline

To get with SetLocalizedStringId() changed values.

SetCategory()

void kodi::addon::PVRMenuhook::SetCategory ( PVR_MENUHOOK_CAT category )

inline

required
Category of menu hook.

SetHookId()

void kodi::addon::PVRMenuhook::SetHookId ( unsigned int hookId )

inline

required
This hook's identifier.

SetLocalizedStringId()

void kodi::addon::PVRMenuhook::SetLocalizedStringId ( unsigned int localizedStringId )

inline

required
The id of the label for this hook in kodi::GetLocalizedString().