High level Frontend Control

This module controls tuning of the frontend and attempts to keep retunes to a minimum. More...

Functions

int TuningInit (void)
 Initialise the Tuning module for use.
int TuningDeInit (void)
 Deinitialise the Tuning module.
void TuningChannelChangedRegisterCallback (PluginChannelChanged_t callback)
 Register a Channel Changed callback.
void TuningChannelChangedUnRegisterCallback (PluginChannelChanged_t callback)
 Unregister a Channel Changed callback.
Service_tTuningCurrentServiceGet (void)
 Retrieve the current (primary) service.
void TuningCurrentServiceSet (Service_t *service)
 Set the current (primary) service to the one specified.
Multiplex_tTuningCurrentMultiplexGet (void)
 Retrieve the multiplex the frontend is currently tuned to.
void TuningCurrentMultiplexSet (Multiplex_t *multiplex)
 Set the current multiplex (independently of the service).

Detailed Description

This module controls tuning of the frontend and attempts to keep retunes to a minimum.

When an new service is selected with TuningCurrentServiceSet the new service checked to see if it is encapsulated in the currently tuned multiplex. If it is the frontend is not retuned, if the new service is not in the current multiplex then the frontend is tuned to the multiplex the service is a member of.

Events Exported

Tuning.ServiceChanged

Fired when the primary service filter service is changed.
payload = The new Service_t.

Tuning.MultiplexChanged

Fired when the tuned multiplex changes.
payload = The new Multiplex_t.

Function Documentation

void TuningChannelChangedRegisterCallback ( PluginChannelChanged_t  callback  ) 

Register a Channel Changed callback.

Parameters:
callback The callback function to register.

void TuningChannelChangedUnRegisterCallback ( PluginChannelChanged_t  callback  ) 

Unregister a Channel Changed callback.

Parameters:
callback The callback function to unregister.

Multiplex_t* TuningCurrentMultiplexGet ( void   ) 

Retrieve the multiplex the frontend is currently tuned to.

Returns:
The current multiplex or NULL if no service/multiplex has been selected. Multiplex should be released when no longer needed with a call to MultiplexRefDec.

void TuningCurrentMultiplexSet ( Multiplex_t multiplex  ) 

Set the current multiplex (independently of the service).

This function is useful for scanning as no service is required to tune to a specific multiplex.

Parameters:
multiplex The new multiplex to tune to.

Service_t* TuningCurrentServiceGet ( void   ) 

Retrieve the current (primary) service.

Returns:
The current service or NULL if no service is selected. Service should be released with a call to ServiceRefDec when no longer needed.

void TuningCurrentServiceSet ( Service_t service  ) 

Set the current (primary) service to the one specified.

Note: Make sure you have called UpdateDatabase() prior to calling this function otherwise any changes to the multiplex/services will be lost.

Parameters:
service The new service to tune to.

int TuningDeInit ( void   ) 

Deinitialise the Tuning module.

Returns:
0 on success.

int TuningInit ( void   ) 

Initialise the Tuning module for use.

Returns:
0 on success.


Generated on Thu Jun 26 12:58:32 2008 for DVBStreamer by  doxygen 1.5.5