![]() |
Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
|
#include <PVRGUIActionsChannels.h>
Public Member Functions | |
CPVRGUIActionsChannels () | |
~CPVRGUIActionsChannels () override | |
CEventStream< PVRChannelNumberInputChangedEvent > & | Events () |
Get the events available for CEventStream. | |
void | RegisterChannelNumberInputHandler (CPVRChannelNumberInputHandler *handler) |
Register a handler for channel number input. | |
void | DeregisterChannelNumberInputHandler (CPVRChannelNumberInputHandler *handler) |
Deregister a handler for channel number input. | |
void | Notify (const PVRChannelNumberInputChangedEvent &event) |
CEventStream callback for channel number input changes. | |
bool | HideChannel (const CFileItem &item) const |
Hide a channel, always showing a confirmation dialog. | |
bool | StartChannelScan () |
Open a selection dialog and start a channel scan on the selected client. | |
bool | StartChannelScan (int clientId) |
Start a channel scan on the specified client or open a dialog to select a client. | |
bool | IsRunningChannelScan () const |
std::shared_ptr< CPVRChannelGroupMember > | GetChannelGroupMember (const std::shared_ptr< const CPVRChannel > &channel) const |
Get a channel group member for the given channel, either from the currently active group or if not found there, from the 'all channels' group. | |
std::shared_ptr< CPVRChannelGroupMember > | GetChannelGroupMember (const CFileItem &item) const |
Get a channel group member for the given item, either from the currently active group or if not found there, from the 'all channels' group. | |
CPVRChannelNumberInputHandler & | GetChannelNumberInputHandler () |
Get the currently active channel number input handler. | |
CPVRGUIChannelNavigator & | GetChannelNavigator () |
Get the channel navigator. | |
void | OnPlaybackStarted (const CFileItem &item) |
Inform GUI actions that playback of an item just started. | |
void | OnPlaybackStopped (const CFileItem &item) |
Inform GUI actions that playback of an item was stopped due to user interaction. | |
std::string | GetSelectedChannelPath (bool bRadio) const |
Get the currently selected channel item path; used across several windows/dialogs to share item selection. | |
void | SetSelectedChannelPath (bool bRadio, const std::string &path) |
Set the currently selected channel item path; used across several windows/dialogs to share item selection. | |
![]() | |
virtual | ~IPVRComponent ()=default |
CPVRGUIActionsChannels::CPVRGUIActionsChannels | ( | ) |
|
override |
void CPVRGUIActionsChannels::DeregisterChannelNumberInputHandler | ( | CPVRChannelNumberInputHandler * | handler | ) |
Deregister a handler for channel number input.
handler | The handler to deregister. |
|
inline |
Get the events available for CEventStream.
std::shared_ptr< CPVRChannelGroupMember > CPVRGUIActionsChannels::GetChannelGroupMember | ( | const CFileItem & | item | ) | const |
Get a channel group member for the given item, either from the currently active group or if not found there, from the 'all channels' group.
item | the item containing a channel, channel group, recording, timer or epg tag. |
std::shared_ptr< CPVRChannelGroupMember > CPVRGUIActionsChannels::GetChannelGroupMember | ( | const std::shared_ptr< const CPVRChannel > & | channel | ) | const |
Get a channel group member for the given channel, either from the currently active group or if not found there, from the 'all channels' group.
channel | the channel. |
CPVRGUIChannelNavigator & CPVRGUIActionsChannels::GetChannelNavigator | ( | ) |
Get the channel navigator.
CPVRChannelNumberInputHandler & CPVRGUIActionsChannels::GetChannelNumberInputHandler | ( | ) |
Get the currently active channel number input handler.
std::string CPVRGUIActionsChannels::GetSelectedChannelPath | ( | bool | bRadio | ) | const |
Get the currently selected channel item path; used across several windows/dialogs to share item selection.
bRadio | True to query the selected path for PVR radio, false for Live TV. |
Hide a channel, always showing a confirmation dialog.
item | containing a channel or an epg tag. |
|
inline |
void CPVRGUIActionsChannels::Notify | ( | const PVRChannelNumberInputChangedEvent & | event | ) |
CEventStream callback for channel number input changes.
event | The event. |
Inform GUI actions that playback of an item just started.
item | The item that started to play. |
Inform GUI actions that playback of an item was stopped due to user interaction.
item | The item that stopped to play. |
void CPVRGUIActionsChannels::RegisterChannelNumberInputHandler | ( | CPVRChannelNumberInputHandler * | handler | ) |
Register a handler for channel number input.
handler | The handler to register. |
Set the currently selected channel item path; used across several windows/dialogs to share item selection.
bRadio | True to set the selected path for PVR radio, false for Live TV. |
path | The new path to set. |
bool CPVRGUIActionsChannels::StartChannelScan | ( | ) |
Open a selection dialog and start a channel scan on the selected client.
Start a channel scan on the specified client or open a dialog to select a client.
clientId | the id of client to scan or PVR_INVALID_CLIENT_ID if a dialog will be opened |