ap_cntrl.h File Reference

Application stb layer control. More...

#include "techtype.h"
#include "ap_common.h"
#include "stbhwav.h"
#include "vtctype.h"
#include "stbdpc.h"
#include "ap_si.h"

Go to the source code of this file.

Classes
struct	S_MANUAL_ANA_TUNING_PARAMS
struct	S_MANUAL_TERR_TUNING_PARAMS
struct	S_MANUAL_CABLE_TUNING_PARAMS
struct	S_MANUAL_SAT_TUNING_PARAMS
struct	S_MANUAL_TUNING_PARAMS
struct	S_ACTL_OWNER_INFO

Typedefs
typedef void(*	DSM_FILE_CALLBACK) (void *user_data, U8BIT *file_data, U32BIT data_size)
	Prototype for function that's called when a file requested from a DSM-CC carousel is received. More...
typedef U16BIT(*	F_ServiceGetSubtitlePid) (void *serv_ptr, ADB_SUBT_INFO *subt_info)
	Function pointer definition: Determines subtitle PID and whether it is DVB or teletext, for the given service. More...

Enumerations
enum	E_ACTL_SI_SRCH_REQD {   ACTL_SI_NO_SEARCH, ACTL_SI_CHANNEL_SEARCH, ACTL_SI_CHANNEL_SEARCH_NO_NIT, ACTL_SI_STARTUP_SEARCH,   ACTL_SI_EVENT_PF_SEARCH, ACTL_SI_EVENT_SCHED_SEARCH, ACTL_SI_EVENT_PF_SCHED_SEARCH, ACTL_SI_DVB_SSU_SEARCH,   ACTL_SI_TOT_SEARCH, ACTL_SI_USER_DEFINED }
enum	E_ACTL_SEARCH_TYPE { ACTL_FREQ_SEARCH, ACTL_NETWORK_SEARCH }
enum	E_ACTL_EVENT_SEARCH { ACTL_EVENT_SEARCH_PF, ACTL_EVENT_SEARCH_SCHED, ACTL_EVENT_SEARCH_PF_SCHED }
enum	E_ACTL_AV_MODE {   ACTL_STANDBY_MODE, ACTL_STANDBY_SCART_MODE, ACTL_TV_MODE, ACTL_SCART_MODE,   ACTL_INT_DVD_MODE }
enum	E_ACTL_DECODE_CHANGE { ACTL_NO_CHANGE, ACTL_AUDIO_CHANGE, ACTL_ADESC_CHANGE, ACTL_BOTH_CHANGED }

Functions
BOOLEAN	ACTL_StartServiceSearch (E_STB_DP_SIGNAL_TYPE tuner_type, E_ACTL_SEARCH_TYPE type)
	Entry point for starting a service search for a full retune or to update the existing service lineup. More...
BOOLEAN	ACTL_IsTargetRegionRequired (void)
	When the search has completed, this function should be called to see whether the target region UI should be presented. This is only needed for DVB-T/T2 searches. More...
void	ACTL_StopServiceSearch (void)
	Function to stop the service search before it completes.
BOOLEAN	ACTL_StartStartupSearch (void)
	Function to start the startup search when booting from cold. This search checks the validity of the services contained in the database. It's only valid for DVB-T/T2 and DVB-C. More...
BOOLEAN	ACTL_StartTotSearch (E_STB_DP_SIGNAL_TYPE tuner_type)
	Function to start a TOT search which is required to set the system clock when starting from power off if a real-time clock isn't available. More...
void	ACTL_StopTotSearch (void)
	Function to stop the TOT search before it completes.
BOOLEAN	ACTL_StartEitSearch (E_STB_DP_SIGNAL_TYPE tuner_type, E_ACTL_EVENT_SEARCH search_type)
	Entry point for starting an EIT search. More...
void	ACTL_StopEitSearch (void)
	Function to stop the EIT search before it completes.
BOOLEAN	ACTL_IsSearchComplete (void)
	Returns TRUE if current search has finished. This works for any of the available types of searches. More...
U8BIT	ACTL_GetSearchProgress (void)
	Returns search progress as a percentage. This works for any of the available types of searches, but the scope for providing progress on anything other than the service searches is fairly limited. More...
U8BIT	ACTL_GetServiceSearchPath (void)
	Returns path used buy currently running search. This works for any of the available types of searches, but the scope for providing path on anything other than the service searches is fairly limited. More...
BOOLEAN	ACTL_StartManualSearchById (E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT chan_id, BOOLEAN start_search)
	Start a service search on, or just tune to, a transport, using chan_id as an index into the country's tuning table. More...
BOOLEAN	ACTL_StartManualSearch (E_STB_DP_SIGNAL_TYPE tuner_type, S_MANUAL_TUNING_PARAMS *tuning_params, E_ACTL_SEARCH_TYPE type)
	Start a service search on, or just tune to, the transport defined by the given tuning parameters. More...
void	ACTL_FinishManualSearch (void)
	Function to be called when a manual service search has completed, or is being stopped.
U8BIT	ACTL_AcquirePathForService (void *s_ptr, BOOLEAN with_decoders, BOOLEAN for_recording, S_ACTL_OWNER_INFO *owner)
	Acquires a decode path suitable for tuning to the given service. More...
void	ACTL_ReleaseLivePathForService (void *s_ptr, E_STB_DP_RES_OWNER owner)
	Finds the path being used to view the given service and releases it. More...
BOOLEAN	ACTL_ReleasePath (U8BIT path)
	Releases the decode path and all resources no longer needed. The path may not be released if the path is owned by a module. More...
BOOLEAN	ACTL_AcquirePathOwnership (U8BIT path, S_ACTL_OWNER_INFO *owner_info)
	Attempts to take ownership of the given path (used by CI+) More...
BOOLEAN	ACTL_ReleasePathOwnership (U8BIT path, E_STB_DP_RES_OWNER owner)
	Releases ownership of the path, and frees any associated data, if the given owner is the path's owner (used by CI+) More...
BOOLEAN	ACTL_CanServiceBeViewed (void *s_ptr)
	Checks whether there's a tuner available to view the given service. This takes into account whether tuners are being used for recording or have been acquired by CI+. More...
void *	ACTL_GetCurrentSatellite (U8BIT path)
	Returns the current satellite being used by the given decode path. More...
U8BIT	ACTL_TuneToTransport (U8BIT path, S_ACTL_OWNER_INFO *owner_info, void *t_ptr, E_ACTL_SI_SRCH_REQD reqd_si, BOOLEAN relock_on)
	Tunes to the given transport and sets the type of SI monitoring that will be started when the tuning completes. More...
U8BIT	ACTL_TuneToService (U8BIT path, S_ACTL_OWNER_INFO *owner_info, void *s_ptr, BOOLEAN override_lock, BOOLEAN for_live)
	Starts the process of tuning to the specified service. If the service is to be tuned on the live path, then path should be passed as INVALID_RES_ID to ensure that any CI+ resource handling is performed. More...
BOOLEAN	ACTL_TuneUsingDSD (U8BIT path, SI_DELIVERY_SYS_DESC_TYPE dsd_type, SI_DELIVERY_SYS_DESC *dsd, U16BIT service_id, E_ACTL_SI_SRCH_REQD reqd_si)
	Starts the process of tuning to a given transport or service that's defined by the given delivery system descriptor. If the DSD defines a transport that doesn't currently exist, then one will be created, and if a service_id is given and a service with this ID doesn't exist on the transport, then one will be created, but will be marked as hidden and non-selectable so it won't appear to a user. More...
BOOLEAN	ACTL_IsTuned (U8BIT path)
	Returns whether the given path is currently tuned. More...
void	ACTL_TuneOff (U8BIT path)
	Stops tuning on the given path. More...
void	ACTL_DecodeOff (U8BIT path)
	Stops decoding on the given path. More...
void	ACTL_ReTuneAudio (void)
	Stops and restarts audio decoding on the live path. This may be required due to a change in language preferences, or some other audio setting.
void	ACTL_ReTuneSubtitles (void)
	Stops and restarts subtitle decoding on the live path. This may be required due to a change in language preferences, or some other setting.
BOOLEAN	ACTL_HasDecodingStarted (U8BIT path)
	Returns whether decoding has been started on the given path. More...
BOOLEAN	ACTL_IsDecodingLocked (U8BIT path)
	Returns whether decoding is locked, due to parental locking, on the given path. More...
void	ACTL_ReleaseChannelLock (void)
	Releases the lock on a channel after decoding has been blocked due to the service being parental locked, after which decoding will be started.
BOOLEAN	ACTL_TuneToRfChanArrayEntry (U8BIT path, U16BIT id, E_ACTL_SI_SRCH_REQD reqd_si, BOOLEAN relock_on)
	Tunes to the specified rf channel array entry for DVB-T and DVB-C. More...
BOOLEAN	ACTL_TuneToRfChanArrayAnalogEntry (U8BIT path, U16BIT id)
	Tunes to the specified rf channel array entry in analogue mode. More...
BOOLEAN	ACTL_TuneToUserDefinedParams (U8BIT path, S_MANUAL_TUNING_PARAMS *tuning_params, E_ACTL_SI_SRCH_REQD reqd_si, BOOLEAN relock_on)
	Tunes to the given set of tuning parameters. More...
void	ACTL_SetStandbyGracePeriod (U16BIT num_seconds)
	Sets a grace period during which a system will enter active standby before going into passive or low power standby. This allows a system to be brought back out of standby quickly for a period of time. More...
void	ACTL_EnterStandby (void)
	Puts DVB into standby mode. It will continue to monitor SI for recordings, SSU updates, etc., unless it goes into low power standby.
void	ACTL_LeaveStandby (void *s_ptr, BOOLEAN tune_to_service)
	Brings the DVB out of standby mode. More...
void	ACTL_SetStandbyState (BOOLEAN state)
	Reports the standby state to the A/V output controller. More...
void	ACTL_SetStandbyVCRActive (void)
	Reports standby state to the a/v output control state machine.
void	ACTL_SetVideoWindow (S16BIT win_x, S16BIT win_y, U16BIT win_width, U16BIT win_height)
	Sets the video window to the size specified. Coordinates are relative to the screen resolution. More...
void	ACTL_SetTVAspectRatio (E_STB_AV_ASPECT_RATIO aspect_ratio)
	Used to set the TV aspect ratio. More...
E_STB_AV_ASPECT_RATIO	ACTL_GetTVAspectRatio (void)
	Returns the current TV aspect ratio. More...
void	ACTL_SetTVAspectMode (E_STB_AV_ASPECT_MODE aspect_mode)
	Used to set the TV aspect mode which defines how the video will be displayed based on the aspect ratio of the TV and video, along with some other factors. More...
E_STB_AV_ASPECT_MODE	ACTL_GetTVAspectMode (void)
	Returns the current TV aspect mode. More...
void	ACTL_SetTVAspectConversion (E_STB_AV_ASPECT_RATIO aspect_ratio, E_STB_AV_ASPECT_MODE aspect_mode)
	Used to set the aspect conversion applied to the video based on the TV aspect ratio and aspect mode to be applied. The given settings will also be saved. More...
E_STB_AV_VIDEO_FORMAT	ACTL_GetActualVideoMode (U16BIT *width, U16BIT *height)
	Reads the saved video format and returns the best mode available if it's set to AUTO or is invalid for the currently connected TV. More...
void	ACTL_HDMIConnected (void)
	Checks that the selected HDMI resolution mode is supported and, if not, chooses the best one available. This function is called by the event task when the HDMI connected event is received.
void	ACTL_HDMIDisconnected (void)
	Sets flag to indicate HDMI is now disconnected. This function is called by the event task when the HDMI disconnected event is received.
BOOLEAN	ACTL_IsHDMIConnected (void)
	Returns whether the HDMI is connected or not. More...
U16BIT	ACTL_GetHDMIResolutions (E_STB_AV_VIDEO_FORMAT **video_formats, U16BIT *current_index)
	Returns an array of valid HDMI resolutions and the index of the currently selected format. The final entry in each array will be the auto video format. More...
void	ACTL_UpdateVideoMode (E_STB_AV_ASPECT_RATIO aspect, BOOLEAN force)
	Update video mode sets Voyager resolution as well as platform Also, stops subtitles during the operation. If HDMI resolution mode is not supported, it chooses the best one available. More...
void	ACTL_ApplyHDCP (void *s_ptr)
	Checks content protection requirements for the current event on the given service to determine whether HDCP has to be used. The HDMI output will be enabled/disabled accordingly. More...
E_ACTL_AV_MODE	ACTL_GetAvModeStatus (void)
	Returns av_mode. More...
U16BIT	ACTL_GetNumRfChanArrayEntries (E_STB_DP_SIGNAL_TYPE tuner_type)
	Returns the number of entries in the rf channel table. More...
U8BIT *	ACTL_GetRfChanName (E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id)
	Returns a pointer to the channel name. More...
U8BIT *	ACTL_GetRfNameFromFreq (E_STB_DP_SIGNAL_TYPE tuner_type, U32BIT freq_hz)
	Returns the rf name appropriate to the frequency specified. More...
U32BIT	ACTL_GetRfChanFreqHz (E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id)
	Returns a pointer to the channel name. More...
U16BIT	ACTL_GetRfSymbolRate (E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id)
	Returns the channel symbol rate. More...
U8BIT	ACTL_GetRfModulation (E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id)
	Returns the modulation mode. More...
E_STB_DP_TTYPE	ACTL_GetTerRfChanType (U16BIT id)
	Returns the terrestrial type (T or T2) for the given channel id. More...
void	ACTL_EnableCiModule (void)
	Enables CI module.
void	ACTL_DisableCiModule (void)
	Disables CI module.
BOOLEAN	ACTL_IsCiUiRequired (void)
	Returns state of ci_ui_required flag. More...
BOOLEAN	ACTL_GetDecodePausedState (U8BIT path)
	Gets user paused flag value. More...
BOOLEAN	ACTL_StartSubtitles (void)
	Starts subtitle processing and display if the current service has valid subtitle data. If DVB subtitles aren't available, teletext will be used if available. More...
void	ACTL_PauseSubtitles (void)
	Disables the display of subtitles but processing continues.
void	ACTL_ResumeSubtitles (void)
	Resumes the display of subtitles after they've been paused.
void	ACTL_StopSubtitles (void)
	Stops subtitles from being displayed and processed.
BOOLEAN	ACTL_SuppressSubtitles (BOOLEAN suppress)
	Stops subtitles being displayed if another OSD requires them to be hidden, such as CI+. More...
BOOLEAN	ACTL_AreSubtitlesDisplayed (void)
	Returns whether subtitles are being displayed.
BOOLEAN	ACTL_AreSubtitlesStarted (void)
	Returns whether subtitles have been started, even if they aren't being displayed.
BOOLEAN	ACTL_IsAudioDescriptionOn (void)
	Returns whether audio description has been turned on. More...
BOOLEAN	ACTL_StartAudioDescription (U8BIT path)
	Starts decoding an audio description stream, if available, on the given path. If AD isn't currently available it will be marked as enabled and started when it becomes available. More...
void	ACTL_StopAudioDescription (U8BIT path)
	Stops AD decoding. More...
void	ACTL_SetADVolume (U8BIT volume)
	Sets the AD volume. More...
void	ACTL_SetParentalControl (BOOLEAN enabled)
	Enables or disables parental control. This enables or disables locking on a per channel basis. If an age has previously been set, this will override the setting, effectively turning off age related blockign of channels. More...
BOOLEAN	ACTL_ParentalControlEnabled (void)
	Returns whether parental control is enabled. This will also return TRUE if parental control has been set to a valid age. More...
void	ACTL_SetParentalControlAge (U8BIT age)
	Sets the age (valid values 4-18) at which parental control will be will be applied. If the age is invalid, no change will be made to the current setting. More...
U8BIT	ACTL_GetParentalControlAge (void)
	Returns the current age set for parental control. 0 will be returned if parental control is disabled or no age is set. More...
void	ACTL_ApplyParentalControl (U8BIT path, void *s_ptr)
	Checks the parental control for the current event on the given service to determine whether decoding should be locked. More...
void	ACTL_SetupPlayback (void)
	Starts the SI to acquire the PMT and fill the ip service in.
void	ACTL_StartPlayback (void *s_ptr)
	Start streaming the specified service. More...
U8BIT	ACTL_GetActivePath (void)
	Returns the active path (live, playback, etc...), i.e. the one using the decoders. More...
void	ACTL_StartDecoding (U8BIT path, void *s_ptr)
	Sets up and starts decoding for the given service. This is used for PVR playback, but could also be used to start decoding for other non-broadcast services. More...
void	ACTL_SetMhegAVControl (BOOLEAN control)
	Sets the MHEG5 audio volume adjust to be applied. More...
void	ACTL_SetMhegSubtitlePidFunc (F_ServiceGetSubtitlePid func)
	Sets function retrieve Subtitle PID and info. Allows external MHEG5 module to override the default function ADB_ServiceGetSubtitlePid. More...
void	ACTL_SetVolumeAdjustment (S8BIT scaling)
	Sets the MHEG5 audio volume adjust to be applied. More...
U8BIT	ACTL_GetVolume (void)
	Returns the current audio volume. More...
U8BIT	ACTL_SetVolume (U8BIT volume)
	Sets the main audio volume and returns the new volume. More...
U8BIT	ACTL_ChangeVolume (S8BIT volume_change)
	Changes the main audio volume and returns the new volume. More...
void	ACTL_SetMute (BOOLEAN mute)
	Sets the audio mute state. More...
BOOLEAN	ACTL_ToggleMute (void)
	Toggles the current mute state and returns the new mute setting. More...
BOOLEAN	ACTL_IsMuted (void)
	Returns the muted state of the audio. More...
BOOLEAN	ACTL_SetActiveProfile (void *profile)
	Sets the current profile. (CI+ only) If the profile is being set to CI+ profile and the necessary CAM isn't present, then setting the profile will fail. More...
E_ACTL_DECODE_CHANGE	ACTL_SetupAudioDecoding (U8BIT path, void *s_ptr)
	Setup default audio decoding params on current tuned service Can be used by external module (e.g. MHEG5) More...
void	ACTL_InitialiseAppControl (void)
	Control system initialisation.
void	ACTL_ActionEvent (U32BIT event, void *event_data)
	Actions external events. More...
BOOLEAN	ACTL_CheckLiveServiceChange (void)
	Checks whether the service tuned to on the live path has changed and informs the UI if it has. More...
BOOLEAN	ACTL_HandlePrivateTimerEvent (U32BIT timer_handle)
	Handles all the private timer events. More...
void	ACTL_SetAnalogChanIdString (U8BIT *str_ptr)
	sends string to be displayed via pixelworks if it has changed (Must not send message to PixelWorks if there is no need - it is too slow) More...
void	ACTL_AllowAnalogVideo (BOOLEAN allow_analog_video)
	Enables or disables analog video display. More...

Detailed Description

Application stb layer control.

Date

18/03/2003

Definition in file ap_cntrl.h.

Typedef Documentation

DSM_FILE_CALLBACK

typedef void(* DSM_FILE_CALLBACK) (void *user_data, U8BIT *file_data, U32BIT data_size)

Prototype for function that's called when a file requested from a DSM-CC carousel is received.

Parameters

user_data	user defined data passed when the file was requested
file_data	data
data_size	number of bytes of data

Definition at line 152 of file ap_cntrl.h.

F_ServiceGetSubtitlePid

typedef U16BIT(* F_ServiceGetSubtitlePid) (void *serv_ptr, ADB_SUBT_INFO *subt_info)

Function pointer definition: Determines subtitle PID and whether it is DVB or teletext, for the given service.

Parameters

serv_ptr	service
subt_info	pointer to ADB_SUBT_INFO for extra info on subtitles

Returns

PID to collect subtitles data, zero if none available

Definition at line 161 of file ap_cntrl.h.

Function Documentation

ACTL_AcquirePathForService()

U8BIT ACTL_AcquirePathForService	(	void *	s_ptr,
		BOOLEAN	with_decoders,
		BOOLEAN	for_recording,
		S_ACTL_OWNER_INFO *	owner_info
	)

Acquires a decode path suitable for tuning to the given service.

Parameters

s_ptr	the service the decode path will be used for
with_decoders	TRUE if decoders are to be acquired with the path, FALSE otherwise
for_recording	TRUE if the path will be used for recording
owner_info	owner of the acquired path, should be NULL for live TV (used by CI+)

Returns

ID of path or INVALID_RES_ID on failure

Definition at line 4897 of file ap_cntrl.c.

ACTL_AcquirePathOwnership()

BOOLEAN ACTL_AcquirePathOwnership	(	U8BIT	path,
		S_ACTL_OWNER_INFO *	owner_info
	)

Attempts to take ownership of the given path (used by CI+)

Parameters

path	decode path to be owned
owner_info	owner info for the path

Returns

TRUE if the ownership is set, FALSE otherwise

Definition at line 4978 of file ap_cntrl.c.

ACTL_ActionEvent()

void ACTL_ActionEvent	(	U32BIT	event,
		void *	event_data
	)

Actions external events.

Parameters

event

the event to be handled

Definition at line 502 of file ap_cntrl.c.

ACTL_AllowAnalogVideo()

void ACTL_AllowAnalogVideo

(

BOOLEAN

allow_analog_video

)

Enables or disables analog video display.

Parameters

allow_analog_video

if TRUE analog video is enabled, otherwise disabled

Definition at line 2684 of file ap_cntrl.c.

ACTL_ApplyHDCP()

void ACTL_ApplyHDCP

(

void *

s_ptr

)

Checks content protection requirements for the current event on the given service to determine whether HDCP has to be used. The HDMI output will be enabled/disabled accordingly.

Parameters

s_ptr

service

Definition at line 3311 of file ap_cntrl.c.

ACTL_ApplyParentalControl()

void ACTL_ApplyParentalControl	(	U8BIT	path,
		void *	s_ptr
	)

Checks the parental control for the current event on the given service to determine whether decoding should be locked.

Parameters

path	decode path
s_ptr	service

Definition at line 3187 of file ap_cntrl.c.

ACTL_CanServiceBeViewed()

BOOLEAN ACTL_CanServiceBeViewed

(

void *

s_ptr

)

Checks whether there's a tuner available to view the given service. This takes into account whether tuners are being used for recording or have been acquired by CI+.

Parameters

s_ptr

service being checked

Returns

TRUE if service can be viewed, FALSE otherwise

Definition at line 5044 of file ap_cntrl.c.

ACTL_ChangeVolume()

U8BIT ACTL_ChangeVolume

(

S8BIT

volume_change

)

Changes the main audio volume and returns the new volume.

Parameters

volume_change

signed value giving change in volume to be applied

Returns

The new volume on a scale of 0-100.

Definition at line 4791 of file ap_cntrl.c.

ACTL_CheckLiveServiceChange()

BOOLEAN ACTL_CheckLiveServiceChange

(

void

)

Checks whether the service tuned to on the live path has changed and informs the UI if it has.

Returns

TRUE if the service has changed, FALSE otherwise

Definition at line 5443 of file ap_cntrl.c.

ACTL_DecodeOff()

void ACTL_DecodeOff

(

U8BIT

path

)

Stops decoding on the given path.

Parameters

path	decode path

Definition at line 2105 of file ap_cntrl.c.

ACTL_GetActivePath()

U8BIT ACTL_GetActivePath

(

void

)

Returns the active path (live, playback, etc...), i.e. the one using the decoders.

Returns

active path

Definition at line 3663 of file ap_cntrl.c.

ACTL_GetActualVideoMode()

E_STB_AV_VIDEO_FORMAT ACTL_GetActualVideoMode	(	U16BIT *	width,
		U16BIT *	height
	)

Reads the saved video format and returns the best mode available if it's set to AUTO or is invalid for the currently connected TV.

Parameters

width	returns the new video width if saved mode isn't valid, can be NULL
height	returns the new video height if saved mode isn't valid, can be NULL

Returns

current video mode, or best video mode available

Definition at line 2810 of file ap_cntrl.c.

ACTL_GetAvModeStatus()

E_ACTL_AV_MODE ACTL_GetAvModeStatus

(

void

)

Returns av_mode.

Returns

Scart AV status

Definition at line 2424 of file ap_cntrl.c.

ACTL_GetCurrentSatellite()

void* ACTL_GetCurrentSatellite

(

U8BIT

path

)

Returns the current satellite being used by the given decode path.

Parameters

path	decode path

Returns

Pointer to satellite

Definition at line 1071 of file ap_cntrl.c.

ACTL_GetDecodePausedState()

BOOLEAN ACTL_GetDecodePausedState

(

U8BIT

path

)

Gets user paused flag value.

path decode path

Returns

TRUE if the subtitles are in paused mode, FALSE otherwise

Definition at line 2600 of file ap_cntrl.c.

ACTL_GetHDMIResolutions()

U16BIT ACTL_GetHDMIResolutions	(	E_STB_AV_VIDEO_FORMAT **	video_formats,
		U16BIT *	current_index
	)

Returns an array of valid HDMI resolutions and the index of the currently selected format. The final entry in each array will be the auto video format.

Parameters

video_formats	pointer to an array of video formats.
current_index	used to return index of currently selected video format

Returns

Size of returned arrays, will always be at least 1

Definition at line 3011 of file ap_cntrl.c.

ACTL_GetNumRfChanArrayEntries()

U16BIT ACTL_GetNumRfChanArrayEntries

(

E_STB_DP_SIGNAL_TYPE

tuner_type

)

Returns the number of entries in the rf channel table.

Parameters

tuner_type

tuner type

Returns

number of entries in the channel table for the present country

Definition at line 1096 of file ap_cntrl.c.

ACTL_GetParentalControlAge()

U8BIT ACTL_GetParentalControlAge

(

void

)

Returns the current age set for parental control. 0 will be returned if parental control is disabled or no age is set.

Returns

age in the range 4-18, or 0

Definition at line 3164 of file ap_cntrl.c.

ACTL_GetRfChanFreqHz()

U32BIT ACTL_GetRfChanFreqHz	(	E_STB_DP_SIGNAL_TYPE	tuner_type,
		U16BIT	id
	)

Returns a pointer to the channel name.

Parameters

tuner_type	tuner type
id	index in the channel table for the current country

Returns

pointer to the const name string

Definition at line 1257 of file ap_cntrl.c.

ACTL_GetRfChanName()

U8BIT* ACTL_GetRfChanName	(	E_STB_DP_SIGNAL_TYPE	tuner_type,
		U16BIT	id
	)

Returns a pointer to the channel name.

Parameters

tuner_type	tuner type
id	index in the channel table for the current country

Returns

pointer to the const name string

Definition at line 1134 of file ap_cntrl.c.

ACTL_GetRfModulation()

U8BIT ACTL_GetRfModulation	(	E_STB_DP_SIGNAL_TYPE	tuner_type,
		U16BIT	id
	)

Returns the modulation mode.

Parameters

tuner_type	tuner type
id	index in the channel table for the current country

Returns

Modulation mode (E_STB_DP_TMODE or E_STB_DP_CMODE depending on the tuner type

Definition at line 1221 of file ap_cntrl.c.

ACTL_GetRfNameFromFreq()

U8BIT* ACTL_GetRfNameFromFreq	(	E_STB_DP_SIGNAL_TYPE	tuner_type,
		U32BIT	freq_hz
	)

Returns the rf name appropriate to the frequency specified.

Parameters

tuner_type	tuner type
freq_hz	frequency in hz

Returns

pointer to the const name string, or NULL if not found

Definition at line 1308 of file ap_cntrl.c.

ACTL_GetRfSymbolRate()

U16BIT ACTL_GetRfSymbolRate	(	E_STB_DP_SIGNAL_TYPE	tuner_type,
		U16BIT	id
	)

Returns the channel symbol rate.

Parameters

tuner_type	tuner type
id	index in the channel table for the current country

Returns

symbol rate of selected id

Definition at line 1185 of file ap_cntrl.c.

ACTL_GetSearchProgress()

U8BIT ACTL_GetSearchProgress

(

void

)

Returns search progress as a percentage. This works for any of the available types of searches, but the scope for providing progress on anything other than the service searches is fairly limited.

Returns

Percent complete, 0 if not started

Definition at line 4242 of file ap_cntrl.c.

ACTL_GetServiceSearchPath()

U8BIT ACTL_GetServiceSearchPath

(

void

)

Returns path used buy currently running search. This works for any of the available types of searches, but the scope for providing path on anything other than the service searches is fairly limited.

Returns

Search path or INVALID_RES_ID if no search is currently running

Definition at line 4344 of file ap_cntrl.c.

ACTL_GetTerRfChanType()

E_STB_DP_TTYPE ACTL_GetTerRfChanType

(

U16BIT

id

)

Returns the terrestrial type (T or T2) for the given channel id.

Parameters

id	index in the terrestrial channel table for the current country
terrestrial	type for the channel

Definition at line 1376 of file ap_cntrl.c.

ACTL_GetTVAspectMode()

E_STB_AV_ASPECT_MODE ACTL_GetTVAspectMode

(

void

)

Returns the current TV aspect mode.

Returns

aspect mode

Definition at line 2386 of file ap_cntrl.c.

ACTL_GetTVAspectRatio()

E_STB_AV_ASPECT_RATIO ACTL_GetTVAspectRatio

(

void

)

Returns the current TV aspect ratio.

Returns

aspect ratio

Definition at line 2357 of file ap_cntrl.c.

ACTL_GetVolume()

U8BIT ACTL_GetVolume

(

void

)

Returns the current audio volume.

Returns

The current volume on a scale of 0-100.

Definition at line 4752 of file ap_cntrl.c.

ACTL_HandlePrivateTimerEvent()

BOOLEAN ACTL_HandlePrivateTimerEvent

(

U32BIT

timer_handle

)

Handles all the private timer events.

Parameters

timer_handle

timer handle

Returns

TRUE if the timer event has been handled, FALSE otherwise

Definition at line 960 of file ap_cntrl.c.

ACTL_HasDecodingStarted()

BOOLEAN ACTL_HasDecodingStarted

(

U8BIT

path

)

Returns whether decoding has been started on the given path.

Parameters

path	decode path

Returns

TRUE if decoding has started, FALSE otherwise

Definition at line 2194 of file ap_cntrl.c.

ACTL_IsAudioDescriptionOn()

BOOLEAN ACTL_IsAudioDescriptionOn

(

void

)

Returns whether audio description has been turned on.

Returns

TRUE if AD is on

Definition at line 2707 of file ap_cntrl.c.

ACTL_IsCiUiRequired()

BOOLEAN ACTL_IsCiUiRequired

(

void

)

Returns state of ci_ui_required flag.

Returns

TRUE if CI OPEN event has been received

Definition at line 2588 of file ap_cntrl.c.

ACTL_IsDecodingLocked()

BOOLEAN ACTL_IsDecodingLocked

(

U8BIT

path

)

Returns whether decoding is locked, due to parental locking, on the given path.

Parameters

path	decode path

Returns

TRUE if decoding is locked, FALSE otherwise

Definition at line 2215 of file ap_cntrl.c.

ACTL_IsHDMIConnected()

BOOLEAN ACTL_IsHDMIConnected

(

void

)

Returns whether the HDMI is connected or not.

Returns

TRUE if the HDMI is connected, FALSE otherwise

Definition at line 2994 of file ap_cntrl.c.

ACTL_IsMuted()

BOOLEAN ACTL_IsMuted

(

void

)

Returns the muted state of the audio.

Returns

TRUE if muted, FALSE otherwise

Definition at line 4882 of file ap_cntrl.c.

ACTL_IsSearchComplete()

BOOLEAN ACTL_IsSearchComplete

(

void

)

Returns TRUE if current search has finished. This works for any of the available types of searches.

Returns

TRUE if search has finished, FALSE otherwise

Definition at line 4228 of file ap_cntrl.c.

ACTL_IsTargetRegionRequired()

BOOLEAN ACTL_IsTargetRegionRequired

(

void

)

When the search has completed, this function should be called to see whether the target region UI should be presented. This is only needed for DVB-T/T2 searches.

Returns

TRUE if target region UI is required, FALSE otherwise

Definition at line 3852 of file ap_cntrl.c.

ACTL_IsTuned()

BOOLEAN ACTL_IsTuned

(

U8BIT

path

)

Returns whether the given path is currently tuned.

Parameters

path	decode path

Returns

TRUE if tuned, FALSE otherwise

Definition at line 1974 of file ap_cntrl.c.

ACTL_LeaveStandby()

void ACTL_LeaveStandby	(	void *	s_ptr,
		BOOLEAN	tune_to_service
	)

Brings the DVB out of standby mode.

Parameters

s_ptr	service to be tuned to for live viewing. If NULL then the last service viewed will be restored
tune_to_service	if s_ptr is NULL then this boolean is used to define whether to tune to the last service viewed

Definition at line 5252 of file ap_cntrl.c.

ACTL_ParentalControlEnabled()

BOOLEAN ACTL_ParentalControlEnabled

(

void

)

Returns whether parental control is enabled. This will also return TRUE if parental control has been set to a valid age.

Returns

TRUE if parental control is enabled, FALSE otherwise

Definition at line 3115 of file ap_cntrl.c.

ACTL_ReleaseLivePathForService()

void ACTL_ReleaseLivePathForService	(	void *	s_ptr,
		E_STB_DP_RES_OWNER	owner
	)

Finds the path being used to view the given service and releases it.

Parameters

s_ptr	service pointer
owner	owner requesting the path to be released

Definition at line 4916 of file ap_cntrl.c.

ACTL_ReleasePath()

BOOLEAN ACTL_ReleasePath

(

U8BIT

path

)

Releases the decode path and all resources no longer needed. The path may not be released if the path is owned by a module.

Parameters

path	decode path

Returns

TRUE if the path is released, FALSE otherwise

Definition at line 4941 of file ap_cntrl.c.

ACTL_ReleasePathOwnership()

BOOLEAN ACTL_ReleasePathOwnership	(	U8BIT	path,
		E_STB_DP_RES_OWNER	owner
	)

Releases ownership of the path, and frees any associated data, if the given owner is the path's owner (used by CI+)

Parameters

path	decode path
owner	owner releasing ownership

Returns

TRUE if the ownership is released or the path isn't owned, FALSE otherwise

Definition at line 5011 of file ap_cntrl.c.

ACTL_SetActiveProfile()

BOOLEAN ACTL_SetActiveProfile

(

void *

profile

)

Sets the current profile. (CI+ only) If the profile is being set to CI+ profile and the necessary CAM isn't present, then setting the profile will fail.

Parameters

profile

profile to be set

Returns

TRUE if the profile is set successfully, FALSE otherwise

Definition at line 5482 of file ap_cntrl.c.

ACTL_SetADVolume()

void ACTL_SetADVolume

(

U8BIT

volume

)

Sets the AD volume.

Parameters

volume

AD volume as a percentage

Definition at line 2792 of file ap_cntrl.c.

ACTL_SetAnalogChanIdString()

void ACTL_SetAnalogChanIdString

(

U8BIT *

str_ptr

)

sends string to be displayed via pixelworks if it has changed (Must not send message to PixelWorks if there is no need - it is too slow)

Parameters

U8BIT*

str_ptr

Definition at line 2619 of file ap_cntrl.c.

ACTL_SetMhegAVControl()

void ACTL_SetMhegAVControl

(

BOOLEAN

control

)

Sets the MHEG5 audio volume adjust to be applied.

Parameters

control

TRUE if MHEG has control of Audio/Video

Definition at line 4704 of file ap_cntrl.c.

ACTL_SetMhegSubtitlePidFunc()

void ACTL_SetMhegSubtitlePidFunc

(

F_ServiceGetSubtitlePid

func

)

Sets function retrieve Subtitle PID and info. Allows external MHEG5 module to override the default function ADB_ServiceGetSubtitlePid.

Parameters

func	Function to get subtitle info, NULL if use default

Definition at line 4716 of file ap_cntrl.c.

ACTL_SetMute()

void ACTL_SetMute

(

BOOLEAN

mute

)

Sets the audio mute state.

Parameters

mute	TRUE to set mute, FALSE otherwise

Definition at line 4838 of file ap_cntrl.c.

ACTL_SetParentalControl()

void ACTL_SetParentalControl

(

BOOLEAN

enabled

)

Enables or disables parental control. This enables or disables locking on a per channel basis. If an age has previously been set, this will override the setting, effectively turning off age related blockign of channels.

Parameters

enabled

TRUE if parental control is to be enabled

Definition at line 3084 of file ap_cntrl.c.

ACTL_SetParentalControlAge()

void ACTL_SetParentalControlAge

(

U8BIT

age

)

Sets the age (valid values 4-18) at which parental control will be will be applied. If the age is invalid, no change will be made to the current setting.

Parameters

age	DVB SI age to be set

Definition at line 3141 of file ap_cntrl.c.

ACTL_SetStandbyGracePeriod()

void ACTL_SetStandbyGracePeriod

(

U16BIT

num_seconds

)

Sets a grace period during which a system will enter active standby before going into passive or low power standby. This allows a system to be brought back out of standby quickly for a period of time.

Parameters

num_seconds

grace period in seconds

Definition at line 5070 of file ap_cntrl.c.

ACTL_SetStandbyState()

void ACTL_SetStandbyState

(

BOOLEAN

state

)

Reports the standby state to the A/V output controller.

Parameters

state

TRUE for standby is on, FALSE for standby is off

Definition at line 2235 of file ap_cntrl.c.

ACTL_SetTVAspectConversion()

void ACTL_SetTVAspectConversion	(	E_STB_AV_ASPECT_RATIO	aspect_ratio,
		E_STB_AV_ASPECT_MODE	aspect_mode
	)

Used to set the aspect conversion applied to the video based on the TV aspect ratio and aspect mode to be applied. The given settings will also be saved.

Parameters

aspect_ratio	TV aspect ratio, e.g. 4:3
aspect_mode	TV aspect mode, e.g. letterbox

Definition at line 2400 of file ap_cntrl.c.

ACTL_SetTVAspectMode()

void ACTL_SetTVAspectMode

(

E_STB_AV_ASPECT_MODE

aspect_mode

)

Used to set the TV aspect mode which defines how the video will be displayed based on the aspect ratio of the TV and video, along with some other factors.

Parameters

aspect_mode

TV aspect mode, e.g. letterbox

Definition at line 2370 of file ap_cntrl.c.

ACTL_SetTVAspectRatio()

void ACTL_SetTVAspectRatio

(

E_STB_AV_ASPECT_RATIO

aspect_ratio

)

Used to set the TV aspect ratio.

Parameters

aspect_ratio

TV aspect ratio, e.g. 4:3

Definition at line 2336 of file ap_cntrl.c.

ACTL_SetupAudioDecoding()

E_ACTL_DECODE_CHANGE ACTL_SetupAudioDecoding	(	U8BIT	path,
		void *	s_ptr
	)

Setup default audio decoding params on current tuned service Can be used by external module (e.g. MHEG5)

Parameters

path	decode path to be owned
s_ptr	service pointer

Returns

E_ACTL_DECODE_CHANGE - indicate whether been change of decode params

Definition at line 5540 of file ap_cntrl.c.

ACTL_SetVideoWindow()

void ACTL_SetVideoWindow	(	S16BIT	win_x,
		S16BIT	win_y,
		U16BIT	win_width,
		U16BIT	win_height
	)

Sets the video window to the size specified. Coordinates are relative to the screen resolution.

Parameters

win_x	window X position
win_y	window Y position
win_width	window width (0 for full screen)
win_height	window height (0 for full screen)

Definition at line 2310 of file ap_cntrl.c.

ACTL_SetVolume()

U8BIT ACTL_SetVolume

(

U8BIT

volume

)

Sets the main audio volume and returns the new volume.

Parameters

volume

unsigned value giving volume to be applied

Returns

The new volume on a scale of 0-100.

Definition at line 4764 of file ap_cntrl.c.

ACTL_SetVolumeAdjustment()

void ACTL_SetVolumeAdjustment

(

S8BIT

scaling

)

Sets the MHEG5 audio volume adjust to be applied.

Parameters

scaling

the volume scaling from -100% to 100%

Sets the MHEG5 audio volume adjust to be applied.

Parameters

Adjusting

the volume from -100% to 100%, i.e. adjusting it to silent or double.

Definition at line 4732 of file ap_cntrl.c.

ACTL_StartAudioDescription()

BOOLEAN ACTL_StartAudioDescription

(

U8BIT

path

)

Starts decoding an audio description stream, if available, on the given path. If AD isn't currently available it will be marked as enabled and started when it becomes available.

Parameters

path	decode path

Returns

TRUE if AD is turned on, FALSE otherwise

Definition at line 2721 of file ap_cntrl.c.

ACTL_StartDecoding()

void ACTL_StartDecoding	(	U8BIT	path,
		void *	s_ptr
	)

Sets up and starts decoding for the given service. This is used for PVR playback, but could also be used to start decoding for other non-broadcast services.

Parameters

path	decode path
s_ptr	service

Definition at line 2058 of file ap_cntrl.c.

ACTL_StartEitSearch()

BOOLEAN ACTL_StartEitSearch	(	E_STB_DP_SIGNAL_TYPE	tuner_type,
		E_ACTL_EVENT_SEARCH	search_type
	)

Entry point for starting an EIT search.

Parameters

tuner_type	limit the search to transports of this tuner type; pass as SIGNAL_NONE for all transports
search_type	event search type to be performed, p/f only, sched only, or both

Returns

TRUE if search starts successfully, FALSE otherwise

Definition at line 4086 of file ap_cntrl.c.

ACTL_StartManualSearch()

BOOLEAN ACTL_StartManualSearch	(	E_STB_DP_SIGNAL_TYPE	tuner_type,
		S_MANUAL_TUNING_PARAMS *	tuning_params,
		E_ACTL_SEARCH_TYPE	type
	)

Start a service search on, or just tune to, the transport defined by the given tuning parameters.

Parameters

tuner_type	tuner type to be used for the search
tuning_params	user defined tuning parameters
type	type of service search to be performed

Returns

TRUE if the search is started successfully, FALSE otherwise

Definition at line 4425 of file ap_cntrl.c.

ACTL_StartManualSearchById()

BOOLEAN ACTL_StartManualSearchById	(	E_STB_DP_SIGNAL_TYPE	tuner_type,
		U16BIT	chan_id,
		BOOLEAN	start_search
	)

Start a service search on, or just tune to, a transport, using chan_id as an index into the country's tuning table.

Parameters

tuner_type	tuner type to be used for the search
chan_id	index into the country's channel array to tune to
start_search	TRUE if a service search is to be started, otherwise just tune

Returns

TRUE on success, FALSE otherwise

Definition at line 4357 of file ap_cntrl.c.

ACTL_StartPlayback()

void ACTL_StartPlayback

(

void *

s_ptr

)

Start streaming the specified service.

Parameters

s_ptr

the pointer to the service structure containing all the information

Definition at line 2022 of file ap_cntrl.c.

ACTL_StartServiceSearch()

BOOLEAN ACTL_StartServiceSearch	(	E_STB_DP_SIGNAL_TYPE	tuner_type,
		E_ACTL_SEARCH_TYPE	type
	)

Entry point for starting a service search for a full retune or to update the existing service lineup.

Parameters

tuner_type	tuner type that defines the search to be performed
type	type of service search to be performed

Returns

TRUE if search starts successfully, FALSE otherwise

Definition at line 3687 of file ap_cntrl.c.

ACTL_StartStartupSearch()

BOOLEAN ACTL_StartStartupSearch

(

void

)

Function to start the startup search when booting from cold. This search checks the validity of the services contained in the database. It's only valid for DVB-T/T2 and DVB-C.

Returns

TRUE if the search is started, FALSE otherwise

Definition at line 3893 of file ap_cntrl.c.

ACTL_StartSubtitles()

BOOLEAN ACTL_StartSubtitles

(

void

)

Starts subtitle processing and display if the current service has valid subtitle data. If DVB subtitles aren't available, teletext will be used if available.

Returns

TRUE if started, FALSE otherwise

Definition at line 3474 of file ap_cntrl.c.

ACTL_StartTotSearch()

BOOLEAN ACTL_StartTotSearch

(

E_STB_DP_SIGNAL_TYPE

tuner_type

)

Function to start a TOT search which is required to set the system clock when starting from power off if a real-time clock isn't available.

Parameters

tuner_type

restrict TOT search to transports of the given type; SIGNAL_NONE means all available transports will be used.

Returns

TRUE if the search is started, FALSE otherwise

Definition at line 4005 of file ap_cntrl.c.

ACTL_StopAudioDescription()

void ACTL_StopAudioDescription

(

U8BIT

path

)

Stops AD decoding.

Parameters

path	decode path

Definition at line 2771 of file ap_cntrl.c.

ACTL_SuppressSubtitles()

BOOLEAN ACTL_SuppressSubtitles

(

BOOLEAN

suppress

)

Stops subtitles being displayed if another OSD requires them to be hidden, such as CI+.

Returns

TRUE if suppressed, FALSE otherwise

Definition at line 3456 of file ap_cntrl.c.

ACTL_ToggleMute()

BOOLEAN ACTL_ToggleMute

(

void

)

Toggles the current mute state and returns the new mute setting.

Returns

The new mute setting, TRUE = muted

Definition at line 4859 of file ap_cntrl.c.

ACTL_TuneOff()

void ACTL_TuneOff

(

U8BIT

path

)

Stops tuning on the given path.

Parameters

path	decode path

Definition at line 2079 of file ap_cntrl.c.

ACTL_TuneToRfChanArrayAnalogEntry()

BOOLEAN ACTL_TuneToRfChanArrayAnalogEntry	(	U8BIT	path,
		U16BIT	id
	)

Tunes to the specified rf channel array entry in analogue mode.

Parameters

path	decode path id index in the analogue channel table for the current country

Returns

TRUE if id valid, FALSE otherwise

Definition at line 1476 of file ap_cntrl.c.

ACTL_TuneToRfChanArrayEntry()

BOOLEAN ACTL_TuneToRfChanArrayEntry	(	U8BIT	path,
		U16BIT	id,
		E_ACTL_SI_SRCH_REQD	reqd_si,
		BOOLEAN	relock_on
	)

Tunes to the specified rf channel array entry for DVB-T and DVB-C.

Parameters

path	decode path
id	index in the current channel table (for the current signal type and country)
reqd_si	the type of SI handling required
relock_on	if FALSE auto relock will be turned off before tuning, otherwise it will be on

Returns

TRUE if id valid, FALSE otherwise

Definition at line 1406 of file ap_cntrl.c.

ACTL_TuneToService()

U8BIT ACTL_TuneToService	(	U8BIT	path,
		S_ACTL_OWNER_INFO *	owner_info,
		void *	s_ptr,
		BOOLEAN	override_lock,
		BOOLEAN	for_live
	)

Starts the process of tuning to the specified service. If the service is to be tuned on the live path, then path should be passed as INVALID_RES_ID to ensure that any CI+ resource handling is performed.

Parameters

path	decode path, INVALID_RES_ID for the live path
owner_info	owner module requesting the tune, can be NULL (used by CI+)
s_ptr	required service
override_lock	TRUE if parental lock settings are to be ignored.
for_live	FALSE for recording, TRUE otherwise

Returns

decode path that is being used to tune to the service. Returning INVALID_RES_ID means the path couldn't be acquired immediately and doesn't mean that it has failed

Definition at line 1651 of file ap_cntrl.c.

ACTL_TuneToTransport()

U8BIT ACTL_TuneToTransport	(	U8BIT	path,
		S_ACTL_OWNER_INFO *	owner_info,
		void *	t_ptr,
		E_ACTL_SI_SRCH_REQD	reqd_si,
		BOOLEAN	relock_on
	)

Tunes to the given transport and sets the type of SI monitoring that will be started when the tuning completes.

Parameters

path	decode path, use INVALID_RES_ID to allow the DVB to acquire an appropriate path
owner_info	owner info for the path, can be NULL (used by CI+)
t_ptr	transport to tune to
reqd_si	type of SI monitoring to be started when tuned
relock_on	TRUE if the tuner is to attempt to relock if the signal is lost

Returns

decode path that is being used to tune to the transport. Returning INVALID_RES_ID means the path couldn't be acquired immediately and doesn't mean that it has failed

Definition at line 1584 of file ap_cntrl.c.

ACTL_TuneToUserDefinedParams()

BOOLEAN ACTL_TuneToUserDefinedParams	(	U8BIT	path,
		S_MANUAL_TUNING_PARAMS *	tuning_params,
		E_ACTL_SI_SRCH_REQD	reqd_si,
		BOOLEAN	relock_on
	)

Tunes to the given set of tuning parameters.

Parameters

path	decode path
tuning_params	tuning parameters to be used
reqd_si	SI search mode to be used if tuning is successful
relock_on	defines whether the tuner is to attempt to relock if lock is lost

Returns

TRUE if tuning is started, FALSE otherwise

Definition at line 1522 of file ap_cntrl.c.

ACTL_TuneUsingDSD()

BOOLEAN ACTL_TuneUsingDSD	(	U8BIT	path,
		SI_DELIVERY_SYS_DESC_TYPE	dsd_type,
		SI_DELIVERY_SYS_DESC *	dsd,
		U16BIT	service_id,
		E_ACTL_SI_SRCH_REQD	reqd_si
	)

Starts the process of tuning to a given transport or service that's defined by the given delivery system descriptor. If the DSD defines a transport that doesn't currently exist, then one will be created, and if a service_id is given and a service with this ID doesn't exist on the transport, then one will be created, but will be marked as hidden and non-selectable so it won't appear to a user.

Parameters

path	decode path to be tuned, must be valid
dsd_type	delivery system descriptor type (T, C or S)
dsd	delivery system descriptor
service_id	pass as 0 if just tuning to a transport
reqd_si	SI processing mode that should be selected when tuned. If tuning to a service the normal UPDATE mode will be used and this setting will be ignored.

Returns

TRUE if the tune operation is started, FALSE otherwise

Definition at line 1866 of file ap_cntrl.c.

ACTL_UpdateVideoMode()

void ACTL_UpdateVideoMode	(	E_STB_AV_ASPECT_RATIO	aspect,
		BOOLEAN	force
	)

Update video mode sets Voyager resolution as well as platform Also, stops subtitles during the operation. If HDMI resolution mode is not supported, it chooses the best one available.

Parameters

aspect	TV aspect ratio, e.g. 4:3 or 16:9
force	forces resolution update when TRUE

Update video mode sets Voyager resolution as well as platform Also, stops subtitles during the operation. If HDMI resolution mode is not supported, it chooses the best one available.

Parameters

aspect	TV aspect ratio, e.g. 4:3 or 16:9
force	forces resolution update when TRUE

Definition at line 2908 of file ap_cntrl.c.