C# Class TvPlugin.ChannelNavigator

Handles the logic for channel zapping. This is used by the different GUI modules in the TV section.

Datei anzeigen Open project: MediaPortal/MediaPortal-1 Class Usage Examples

Public Methods

Method	Description
ChannelNavigator ( ) : System
CheckChannelChange ( ) : bool	Checks if it is time to zap to a different channel. This is called during Process().
GetChannel ( int channelId ) : TvDatabase.Channel
GetChannel ( int channelId, bool allChannels ) : TvDatabase.Channel
GetChannel ( string channelName ) : TvDatabase.Channel
LoadSettings ( Settings xmlreader ) : void
ReLoad ( ) : void
SaveSettings ( Settings xmlwriter ) : void
SetCurrentGroup ( int groupIndex ) : void	Changes the current channel group.
SetCurrentGroup ( string groupname ) : void	Changes the current channel group.
SetupDatabaseConnection ( ) : bool
UpdateCurrentChannel ( ) : void	Ensures that the navigator has the correct current channel (retrieved from the Recorder).
ZapNow ( ) : void
ZapToChannel ( TvDatabase.Channel channel, bool useZapDelay ) : void	Changes the current channel after a specified delay.
ZapToChannel ( int channelNr, bool useZapDelay ) : void	Changes the current channel after a specified delay.
ZapToChannelNumber ( int channelNr, bool useZapDelay ) : void	Changes the current channel (based on channel number) after a specified delay.
ZapToLastViewedChannel ( ) : void	Zaps to the last viewed Channel (without ZapDelay). // mPod
ZapToNextChannel ( bool useZapDelay ) : void	Changes to the next channel in the current group.
ZapToNextGroup ( bool useZapDelay ) : void	Changes to the next channel group.
ZapToPreviousChannel ( bool useZapDelay ) : void	Changes to the previous channel in the current group.
ZapToPreviousGroup ( bool useZapDelay ) : void	Changes to the previous channel group.

Private Methods

Method	Description
DoesGroupNameContainGroupName ( TvDatabase.GroupMap groupMap, string groupname ) : bool
GetChannelIndex ( TvDatabase.Channel ch ) : int	Retrieves the index of the current channel.
GetGroupIndex ( string groupname ) : int	Retrieves the index of the group with the specified name.
RaiseOnZapChannelEvent ( ) : void

Method Details

ChannelNavigator() public method

public ChannelNavigator ( ) : System
return	System

CheckChannelChange() public method

Checks if it is time to zap to a different channel. This is called during Process().

public CheckChannelChange ( ) : bool
return	bool

GetChannel() public method

public GetChannel ( int channelId ) : TvDatabase.Channel
channelId	int
return	TvDatabase.Channel

GetChannel() public method

public GetChannel ( int channelId, bool allChannels ) : TvDatabase.Channel
channelId	int
allChannels	bool
return	TvDatabase.Channel

GetChannel() public method

public GetChannel ( string channelName ) : TvDatabase.Channel
channelName	string
return	TvDatabase.Channel

LoadSettings() public method

public LoadSettings ( Settings xmlreader ) : void
xmlreader	Settings
return	void

ReLoad() public method

public ReLoad ( ) : void
return	void

SaveSettings() public method

public SaveSettings ( Settings xmlwriter ) : void
xmlwriter	Settings
return	void

SetCurrentGroup() public method

Changes the current channel group.

public SetCurrentGroup ( int groupIndex ) : void
groupIndex	int	The id of the group to change to.
return	void

SetCurrentGroup() public method

Changes the current channel group.

public SetCurrentGroup ( string groupname ) : void
groupname	string	The name of the group to change to.
return	void

SetupDatabaseConnection() public method

public SetupDatabaseConnection ( ) : bool
return	bool

UpdateCurrentChannel() public method

Ensures that the navigator has the correct current channel (retrieved from the Recorder).

public UpdateCurrentChannel ( ) : void
return	void

ZapNow() public method

public ZapNow ( ) : void
return	void

ZapToChannel() public method

Changes the current channel after a specified delay.

public ZapToChannel ( TvDatabase.Channel channel, bool useZapDelay ) : void
channel	TvDatabase.Channel
useZapDelay	bool	If true, the configured zap delay is used. Otherwise it zaps immediately.
return	void

ZapToChannel() public method

Changes the current channel after a specified delay.

public ZapToChannel ( int channelNr, bool useZapDelay ) : void
channelNr	int	The nr of the channel to change to.
useZapDelay	bool	If true, the configured zap delay is used. Otherwise it zaps immediately.
return	void

ZapToChannelNumber() public method

Changes the current channel (based on channel number) after a specified delay.

public ZapToChannelNumber ( int channelNr, bool useZapDelay ) : void
channelNr	int	The nr of the channel to change to.
useZapDelay	bool	If true, the configured zap delay is used. Otherwise it zaps immediately.
return	void

ZapToLastViewedChannel() public method

Zaps to the last viewed Channel (without ZapDelay). // mPod

public ZapToLastViewedChannel ( ) : void
return	void

ZapToNextChannel() public method

Changes to the next channel in the current group.

public ZapToNextChannel ( bool useZapDelay ) : void
useZapDelay	bool	If true, the configured zap delay is used. Otherwise it zaps immediately.
return	void

ZapToNextGroup() public method

Changes to the next channel group.

public ZapToNextGroup ( bool useZapDelay ) : void
useZapDelay	bool
return	void

ZapToPreviousChannel() public method

Changes to the previous channel in the current group.

public ZapToPreviousChannel ( bool useZapDelay ) : void
useZapDelay	bool	If true, the configured zap delay is used. Otherwise it zaps immediately.
return	void

ZapToPreviousGroup() public method

Changes to the previous channel group.

public ZapToPreviousGroup ( bool useZapDelay ) : void
useZapDelay	bool
return	void