macros and function prototypes for public use More...

#include "techtype.h"

Typedefs
typedef enum e_pvr_play_status	E_PVR_PLAY_STATUS

typedef enum e_pvr_stop_type	E_PVR_STOP_TYPE

Enumerations
enum	e_pvr_play_status { PVR_PLAY_STATUS_NULL = 0, PVR_PLAY_STATUS_STOP = 1, PVR_PLAY_STATUS_PAUSE = 2, PVR_PLAY_STATUS_SF = 3, PVR_PLAY_STATUS_SR = 4, PVR_PLAY_STATUS_NORMAL = 5, PVR_PLAY_STATUS_FF = 6, PVR_PLAY_STATUS_FR = 7, PVR_PLAY_STATUS_QR = 8 }

enum	e_pvr_stop_type { PVR_STOP_REC_ONLY = 0, PVR_STOP_PLAY = 1, PVR_STOP_PAUSE = 2 }

Functions
BOOLEAN	APVR_IsInitialised (void)
	Use to query whether the PVR function is available and ready to be used. More...

void	APVR_SetNotifyTime (U16BIT notify_time)
	Sets the time, in seconds, when an event will be sent as a notification that a recording is about to start. This setting will apply to all recording timers that don't have a notify time already set. If this value is set to 0 then events will only be sent for recording timers that have their own notify time set. More...

U16BIT	APVR_GetNotifyTime (void)
	Returns the current recording notification time in seconds. More...

void	APVR_SetStartPadding (S32BIT padding)
	Sets the default time that will be added to the start of all recording timers created after this value is set. Positive values will start a recording before the scheduled start time and negative values will start it later than the scheduled time. More...

void	APVR_SetEndPadding (S32BIT padding)
	Sets the default time that will be added to the end of all recording timers created after this value is set. Positive values will end a recording after the scheduled end time and negative values will end it before the scheduled end time. More...

S32BIT	APVR_GetStartPadding (void)
	Returns the current setting for the start padding time added to all recording timers. More...

S32BIT	APVR_GetEndPadding (void)
	Returns the current setting for the end padding time added to all recording timers. More...

U16BIT	APVR_GetPlayList (U32BIT handle_list, U8BIT name_list, U32BIT rec_status_list, U32BIT locked_list, U32BIT selected_list, U32BIT *split_list)
	Returns a list of all the existing recordings that can be played. All the arrays returned will be allocated by this function and should be freed by calling APVR_ReleasePlayList. More...

void	APVR_ReleasePlayList (U32BIT handle_list, U8BIT name_list, U32BIT rec_status_list, U32BIT locked_list, U32BIT selected_list, U32BIT *split_list)
	Frees the arrays allocated by APVR_GetPlayList. More...

BOOLEAN	APVR_PlayRecording (U32BIT recording_handle, BOOLEAN resume_playback, void *monitor_service)
	Starts playback of the given recording. More...

U32BIT	APVR_GetPlaybackHandle (void)
	Returns the handle of the recording currently being played back. More...

BOOLEAN	APVR_IsPlaying (void)
	Returns whether playback is in progress. More...

BOOLEAN	APVR_GetPlaybackElapsedTime (U32BIT handle, U8BIT hours, U8BIT mins, U8BIT secs, U8BIT progress)
	Returns the playback progress in time and as a percentage. More...

void	APVR_StopPlay (BOOLEAN return_to_live)
	Stops playback and optionally returns to live TV. More...

void	APVR_NormalPlay (void)
	If playback has been paused or is subject to some trick mode, calling this function will result in playback resuming at normal playback speed (i.e. 100%)

void	APVR_PausePlay (void)
	Pause playback.

void	APVR_FFPlay (void)
	If paused, playback will go into the first available slow motion speed in a forwards direction. If speed is already > 0% then the next fast forward speed will be selected. If playback is in the reverse direction then the next slowest reverse play speed will be selected.

void	APVR_FRPlay (void)
	If paused, playback will go into the first available slow motion speed in a reverse direction. If speed is already < 0% then the next reverse speed will be selected. If playback is in the forwards direction then the next slowest forwards play speed will be selected.

E_PVR_PLAY_STATUS	APVR_GetPlayMode (void)
	Returns the current play mode according to the current play speed. More...

S16BIT	APVR_GetPlaySpeed (void)
	Returns the current play speed as a signed percentage value representing the speed, where 100% is normal playback speed. More...

BOOLEAN	APVR_SetPlaySpeed (S16BIT speed)
	Set current play speed as a signed percentage value representing the speed, where 100% is normal playback speed. More...

U8BIT	APVR_PrepareNewRecording (U16BIT onet_id, U16BIT trans_id, U16BIT service_id, BOOLEAN *new_tuned_service)
	Acquires a decode path for recording the given service and tunes to it. More...

BOOLEAN	APVR_StartNewRecording (U16BIT disk_id, U8BIT path, U8BIT recording_name, U16BIT event_id, U8BIT prog_crid, U8BIT other_crid, U32BIT rec_handle)
	Starts a recording after any tuning has completed and sets the info to be stored with it. More...

BOOLEAN	APVR_StopRecording (U32BIT recording_handle)
	Stops the given recording. More...

U8BIT	APVR_GetActiveRecordingList (U32BIT **handle_list)
	Returns an array of recordings currently in progress. Use APVR_ReleaseActiveRecordingList to free the returned array. More...

void	APVR_ReleaseActiveRecordingList (U32BIT *handle_list)
	Frees the arrays allocated by APVR_GetActiveRecordingList. More...

BOOLEAN	APVR_GetPathRecordingName (U8BIT path, U8BIT **name_ptr)
	Get the name of the recording currently taking place on the given decode path. More...

BOOLEAN	APVR_DeleteRecording (U32BIT handle)
	Delete the given recording, including all files associated with it and remove it from the database of available recordings that can be played back. More...

void	APVR_SetTimeshiftBufferSize (U16BIT time_in_mins)
	Sets the size of the timeshift buffer so that it's able to store a recording of the given length before it has to loop round. Whether this value can be accurately achieved may vary according to the support provided by the platform. More...

U16BIT	APVR_GetTimeshiftBufferSize (void)
	Returns the maximum size of the timeshift buffer in minutes. More...

BOOLEAN	APVR_IsTimeshiftStarted (void)
	Checks whether timeshift has been started, which includes both recording and playback. More...

BOOLEAN	APVR_IsTimeshiftRecordingPath (U8BIT path)
	Checks whether the given path is the one that's being used for timeshift recording. More...

BOOLEAN	APVR_IsTimeshiftRecording (U32BIT handle)
	Checks whether the given recording handle is the timeshift recording handle. More...

U8BIT	APVR_StartPauseRecord (void)
	Starts recording the live service ready for timeshift playback. The recording may not have started when this function returns, so an app should wait for the STB_EVENT_PVR_REC_START event before starting the paused playback using APVR_StartPausePlay. More...

U8BIT	APVR_StartPausePlay (void)
	Starts playback of a live timeshift recording started with APVR_StartPauseRecord. This function should not be called until STB_EVENT_PVR_REC_START has been received with the correct recording path as an argument (as returned by APVR_StartPauseRecord). More...

void	APVR_StopPauseRecord (BOOLEAN return_to_live)
	Stops timeshifted playback and recording and optionally restarts decoding of the live signal. More...

BOOLEAN	APVR_IsRecordingInProgress (void)
	Returns TRUE if there are any recordings currently in progress. More...

BOOLEAN	APVR_IsRecordingHandle (U8BIT path, U32BIT recording_handle)
	Returns TRUE if given recording handle is still in progress on the given decode path. More...

BOOLEAN	APVR_GetRecordingHandle (U8BIT path, U32BIT *recording_handle_ptr)
	Returns the handle of the recording taking place on the given decode path. More...

U8BIT	APVR_GetTotalSpacePercentUsed (U16BIT disk_id)
	get total percentage of recording space used More...

void	APVR_GetDiskTime (U16BIT disk_id, U8BIT used_hour_ptr, U8BIT used_min_ptr, U8BIT free_hour_ptr, U8BIT free_min_ptr, U8BIT size_hour_ptr, U8BIT size_min_ptr)
	Gets an estimate of disk space in time (hour / min): used, free and size. More...

void	APVR_GetDiskMbyte (U16BIT disk_id, U32BIT used_mbyte_ptr, U32BIT free_mbyte_ptr, U32BIT *size_mbyte_ptr)
	Ges disk space in Mbytes: used, free and size. More...

BOOLEAN	APVR_CheckSpaceForEvent (U16BIT disk_id, void *event_ptr)
	Checks if there is enough space for the recording of the given event to take place. More...

BOOLEAN	APVR_CheckSpaceDuration (U16BIT disk_id, U32BIT duration)
	Check if there is enough space for the recording of the given duration to take place. More...

BOOLEAN	APVR_CheckSpaceForDuration (U16BIT disk_id, U8BIT hours, U8BIT mins)
	Check if there is enough space for the recording of the given duration to take place. More...

U32BIT	APVR_GetPauseProgress (void)
	Calculates and returns the number of seconds behind live TV. More...

U32BIT	APVR_GetPlaybackTime (void)
	Calculates and returns the number of seconds in playback buffer. More...

BOOLEAN	APVR_SetPlaybackTime (U32BIT position_in_secs)
	Sets returns the number of seconds in playback buffer. More...

U8BIT	APVR_GetPlaybackPath (void)
	Returns the path currently acquired fro playback. More...

BOOLEAN	APVR_IsEventInRecordList (U8BIT *prog_crid)
	Determines whether the given programme CRID is already in the list of recorded events. More...

void	APVR_RecordSeries (void *crid_ptr)
	Seaches the schedule for events that are part of the given series and that haven't already been recorded or aren't set to be recorded and creates a timer to record them. More...

void	APVR_RecordRecommendations (void *crid_ptr)
	Searches the schedule for events that are part of the given recommendation and that haven't already been recorded or aren't set to be recorded and creates a timer to record them. More...

BOOLEAN	APVR_FindNextSplitEvent (U32BIT curr_handle, U32BIT *next_handle)
	If the current playback recording is a split event then the next chronological part of the event is found and its handle returned. More...

void	APVR_EitUpdated (void)
	Ensures that any EIT updates are processed to handle scenarios such as checking for new series recordings, etc.

void	APVR_PidsUpdated (U8BIT path)
	This function should be called when there's an update to the PIDs for a service that's being recorded. The PIDs being recorded are checked and any that are no longer valid will no longer be recorded and any new PIDs will be added. More...

void *	APVR_GetPlaybackService (void)
	A service instance is associated to the playback, this function returns its pointer. The handle can be used, for example, to call ADB_ServiceHasSubtitles as it's done for live channels. More...

BOOLEAN	APVR_HandlePrivateTimer (U32BIT timer_handle)
	Deals with any private timers started by the PVR module. More...

void	APVR_Initialise (void)
	Initialise all PVR resources: filters, recordings etc.

void	APVR_Terminate (void)
	Destroy all PVR resources: filters, recordings etc.

BOOLEAN	APVR_IsDecodingFile (void)
	Returns the PVR play status. More...

void	APVR_SlowMoPlay (void)
	Play in slow mothing mode.

void	APVR_QRPlay (void)
	quick replay current playing recording

void	APVR_JTLPlay (void)
	quick replay current playing recording

void	APVR_TrickModeMuteOn (void)
	Mute for trick mode.

void	APVR_TrickModeMuteOff (void)
	Unmute for trick mode.

BOOLEAN	APVR_DeleteAllSelectedRecordings (U32BIT *handles, U16BIT num_handles)
	Delete all the recordings marked as selected but not locked in the given list, including all files associated with it and remove it from the database of available recordings that can be played back. More...

void	APVR_UnselectAllRecordings (U32BIT *handles, U16BIT num_handles)
	Un-select all recordings.

BOOLEAN	APVR_AreSelectedRecordings (U32BIT *handles, U16BIT num_handles)
	Checks if any recording in a list is selected. More...

void	APVR_EncryptRecordings (BOOLEAN state)
	Used to set whether all recordings should be encrypted or not. The default is that recordings aren't encrypted, in which case the do_not_scramble flag in the SI free-to-air content management descriptor is used to determine whether a recording should be encrypted or not. This setting is not persistent, so needs to be set each time the DVB stack is initialised. More...

Detailed Description

macros and function prototypes for public use

Date: 11/05/2004

Author: Ocean Blue

Definition in file ap_pvr.h.

Function Documentation

◆ APVR_AreSelectedRecordings()

BOOLEAN APVR_AreSelectedRecordings	(	U32BIT *	handles,
		U16BIT	num_handles
	)

Checks if any recording in a list is selected.

Parameters

handles	array of recording handles
num_handles	number of recording handles in the array

Returns: TRUE if at least one recording is selected, FALSE otherwise

Definition at line 2400 of file ap_pvr.c.

◆ APVR_CheckSpaceDuration()

BOOLEAN APVR_CheckSpaceDuration	(	U16BIT	disk_id,
		U32BIT	duration
	)

Check if there is enough space for the recording of the given duration to take place.

disk_id ID of disk to be queried

Parameters

duration Recording duration expressed as U32DHMS

Returns: TRUE if there is space availiable, FALSE otherwise

Definition at line 2958 of file ap_pvr.c.

◆ APVR_CheckSpaceForDuration()

BOOLEAN APVR_CheckSpaceForDuration	(	U16BIT	disk_id,
		U8BIT	hours,
		U8BIT	mins
	)

Check if there is enough space for the recording of the given duration to take place.

disk_id ID of disk to be queried

Parameters

hours	number of hours of the duration
mins	number of minutes of the duration

Returns: TRUE if there is space availiable, FALSE otherwise

Definition at line 2917 of file ap_pvr.c.

◆ APVR_CheckSpaceForEvent()

BOOLEAN APVR_CheckSpaceForEvent	(	U16BIT	disk_id,
		void *	event_ptr
	)

Checks if there is enough space for the recording of the given event to take place.

disk_id ID of disk to be queried

Parameters

event_ptr The event to check if there is any free space

Returns: TRUE if there is space availiable, FALSE otherwise

Definition at line 2898 of file ap_pvr.c.

◆ APVR_DeleteAllSelectedRecordings()

BOOLEAN APVR_DeleteAllSelectedRecordings	(	U32BIT *	handles,
		U16BIT	num_handles
	)

Delete all the recordings marked as selected but not locked in the given list, including all files associated with it and remove it from the database of available recordings that can be played back.

Parameters

handles	array of recording handles
num_handles	number of recordings in the array

Returns: TRUE if at least one recording is deleted, FALSE otherwise

Definition at line 2348 of file ap_pvr.c.

◆ APVR_DeleteRecording()

BOOLEAN APVR_DeleteRecording ( U32BIT handle )

Delete the given recording, including all files associated with it and remove it from the database of available recordings that can be played back.

Parameters

handle recording to be deleted

Returns: TRUE if the recording is deleted, FALSE otherwise

Definition at line 2320 of file ap_pvr.c.

◆ APVR_EncryptRecordings()

void APVR_EncryptRecordings ( BOOLEAN state )

Used to set whether all recordings should be encrypted or not. The default is that recordings aren't encrypted, in which case the do_not_scramble flag in the SI free-to-air content management descriptor is used to determine whether a recording should be encrypted or not. This setting is not persistent, so needs to be set each time the DVB stack is initialised.

Parameters

state TRUE if recordings are to be encrypted, FALSE if not

Definition at line 3818 of file ap_pvr.c.

◆ APVR_FindNextSplitEvent()

BOOLEAN APVR_FindNextSplitEvent	(	U32BIT	curr_handle,
		U32BIT *	next_handle
	)

If the current playback recording is a split event then the next chronological part of the event is found and its handle returned.

Parameters

curr_handle	handle of split recording when searching for the next part
next_handle	handle of the next recording to be played, returned

Returns: TRUE if a recording is found, FALSE otherwise

Definition at line 3583 of file ap_pvr.c.

◆ APVR_GetActiveRecordingList()

U8BIT APVR_GetActiveRecordingList ( U32BIT ** handle_list )

Returns an array of recordings currently in progress. Use APVR_ReleaseActiveRecordingList to free the returned array.

Parameters

handle_list address of an array allocated by the function containing the recording handles

Returns: number of recordings in progress

Definition at line 2213 of file ap_pvr.c.

◆ APVR_GetDiskMbyte()

void APVR_GetDiskMbyte	(	U16BIT	disk_id,
		U32BIT *	used_mbyte_ptr,
		U32BIT *	free_mbyte_ptr,
		U32BIT *	size_mbyte_ptr
	)

Ges disk space in Mbytes: used, free and size.

disk_id ID of disk to be queried used_mbyte_ptr amount of data stored on the disk free_mbyte_ptr free space on the disk size_mbyte_ptr total size of the disk

Definition at line 3054 of file ap_pvr.c.

◆ APVR_GetDiskTime()

void APVR_GetDiskTime	(	U16BIT	disk_id,
		U8BIT *	used_hour_ptr,
		U8BIT *	used_min_ptr,
		U8BIT *	free_hour_ptr,
		U8BIT *	free_min_ptr,
		U8BIT *	size_hour_ptr,
		U8BIT *	size_min_ptr
	)

Gets an estimate of disk space in time (hour / min): used, free and size.

Parameters

disk_id	ID of disk to be queried
used_hour_ptr	pointer to the variable containing the number of hours that the stored data is worth
used_min_ptr	pointer to the variable containing the number of minutes that the stored data is worth
free_hour_ptr	pointer to the variable containing the number of hours that the available space is worth
free_min_ptr	pointer to the variable containing the number of minutes that the available space is worth
size_hour_ptr	pointer to the variable containing the number of hours that the total disk size is worth
size_min_ptr	pointer to the variable containing the number of minutes that the total disk size is worth

Definition at line 3014 of file ap_pvr.c.

◆ APVR_GetEndPadding()

S32BIT APVR_GetEndPadding ( void )

Returns the current setting for the end padding time added to all recording timers.

Returns: end padding value in seconds

Definition at line 827 of file ap_pvr.c.

◆ APVR_GetNotifyTime()

U16BIT APVR_GetNotifyTime ( void )

Returns the current recording notification time in seconds.

Returns: notification time in seconds, 0 means it's disabled

Definition at line 775 of file ap_pvr.c.

◆ APVR_GetPathRecordingName()

BOOLEAN APVR_GetPathRecordingName	(	U8BIT	path,
		U8BIT **	name_ptr
	)

Get the name of the recording currently taking place on the given decode path.

Parameters

path	decode path being used for a recording
name_ptr	address of variable into which the name reference will be returned. This is actually a U8BIT*, but the string shouldn't be freed.

Returns: TRUE if a recording is taking place on the given path and the name is returned, FALSE otherwise

Definition at line 2295 of file ap_pvr.c.

◆ APVR_GetPauseProgress()

U32BIT APVR_GetPauseProgress ( void )

Calculates and returns the number of seconds behind live TV.

Returns: Number of seconds behind live

Definition at line 3083 of file ap_pvr.c.

◆ APVR_GetPlaybackElapsedTime()

BOOLEAN APVR_GetPlaybackElapsedTime	(	U32BIT	handle,
		U8BIT *	hours,
		U8BIT *	mins,
		U8BIT *	secs,
		U8BIT *	progress
	)

Returns the playback progress in time and as a percentage.

Parameters

handle	recording handle being played
hours	pointer for return of playback hours
mins	pointer for return of playback minutes
secs	pointer for return of playback seconds
progress	pointer for return of position in playback as a percentage

Returns: TRUE if values are returned

Definition at line 1227 of file ap_pvr.c.

◆ APVR_GetPlaybackHandle()

U32BIT APVR_GetPlaybackHandle ( void )

Returns the handle of the recording currently being played back.

Returns: playback handle, which may be invalid if playback isn't taking place

Definition at line 1145 of file ap_pvr.c.

◆ APVR_GetPlaybackPath()

U8BIT APVR_GetPlaybackPath ( void )

Returns the path currently acquired fro playback.

Returns: Decode path for playback

Definition at line 3189 of file ap_pvr.c.

◆ APVR_GetPlaybackService()

void* APVR_GetPlaybackService ( void )

A service instance is associated to the playback, this function returns its pointer. The handle can be used, for example, to call ADB_ServiceHasSubtitles as it's done for live channels.

Returns: Playback service pointer

Definition at line 3607 of file ap_pvr.c.

◆ APVR_GetPlaybackTime()

U32BIT APVR_GetPlaybackTime ( void )

Calculates and returns the number of seconds in playback buffer.

Returns: Number of seconds of playback

Definition at line 3128 of file ap_pvr.c.

◆ APVR_GetPlayList()

U16BIT APVR_GetPlayList	(	U32BIT **	handle_list,
		U8BIT ***	name_list,
		U32BIT **	rec_status_list,
		U32BIT **	locked_list,
		U32BIT **	selected_list,
		U32BIT **	split_list
	)

Returns a list of all the existing recordings that can be played. All the arrays returned will be allocated by this function and should be freed by calling APVR_ReleasePlayList.

Parameters

handle_list	address to return an array of recording handles
name_list	address to return an array of names for each recording, the U32BIT value will actually be a U8BIT* of a UTF-8 string
rec_status_list	address to return an array indicating whether each recording is currently being recorded, 0=no, 1=yes
locked_list	address to return an array indicating whether each recording is parentally locked, 0=no, 1=yes
selected_list	address to return an array indicating whether each recording is marked as selected, 0=no, 1=yes
split_list	address to return an array indicating whether each recording is part of a split recording, 0=no, 1=yes

Returns: number of recordings

Definition at line 853 of file ap_pvr.c.

◆ APVR_GetPlayMode()

E_PVR_PLAY_STATUS APVR_GetPlayMode ( void )

Returns the current play mode according to the current play speed.

Returns: play mode

Definition at line 1606 of file ap_pvr.c.

◆ APVR_GetPlaySpeed()

S16BIT APVR_GetPlaySpeed ( void )

Returns the current play speed as a signed percentage value representing the speed, where 100% is normal playback speed.

Returns: play speed

Definition at line 1676 of file ap_pvr.c.

◆ APVR_GetRecordingHandle()

BOOLEAN APVR_GetRecordingHandle	(	U8BIT	path,
		U32BIT *	recording_handle_ptr
	)

Returns the handle of the recording taking place on the given decode path.

Parameters

path	decode path used for recording
recording_handle_ptr	address to return the recording handle, only valid on return if a recording is taking place

Returns: TRUE if a recording is taking place and handle is returned, FALSE otherwise

Definition at line 2870 of file ap_pvr.c.

◆ APVR_GetStartPadding()

S32BIT APVR_GetStartPadding ( void )

Returns the current setting for the start padding time added to all recording timers.

Returns: start padding value in seconds

Definition at line 816 of file ap_pvr.c.

◆ APVR_GetTimeshiftBufferSize()

U16BIT APVR_GetTimeshiftBufferSize ( void )

Returns the maximum size of the timeshift buffer in minutes.

Returns: timeshift buffer size in minutes

Definition at line 2443 of file ap_pvr.c.

◆ APVR_GetTotalSpacePercentUsed()

U8BIT APVR_GetTotalSpacePercentUsed ( U16BIT disk_id )

get total percentage of recording space used

Parameters

total_space_used total percentage of recording space used

Definition at line 2972 of file ap_pvr.c.

◆ APVR_HandlePrivateTimer()

BOOLEAN APVR_HandlePrivateTimer ( U32BIT timer_handle )

Deals with any private timers started by the PVR module.

Parameters

timer_handle handle of the timer that's been triggered

Returns: TRUE if the timer is a PVR timer and has been dealt with, FALSE otherwise

Definition at line 3619 of file ap_pvr.c.

◆ APVR_IsDecodingFile()

BOOLEAN APVR_IsDecodingFile ( void )

Returns the PVR play status.

Returns: TRUE if a recoding is being played, FALSE otherwise

Definition at line 1156 of file ap_pvr.c.

◆ APVR_IsEventInRecordList()

BOOLEAN APVR_IsEventInRecordList ( U8BIT * prog_crid )

Determines whether the given programme CRID is already in the list of recorded events.

Parameters

prog_crid full CRID (i.e. including default authority) of event to be searched for

Returns: TRUE if a recording with the given CRID is found, FALSE otherwise

Definition at line 3247 of file ap_pvr.c.

◆ APVR_IsInitialised()

BOOLEAN APVR_IsInitialised ( void )

Use to query whether the PVR function is available and ready to be used.

Returns: TRUE if available and ready, FALSE otherwise

Definition at line 741 of file ap_pvr.c.

◆ APVR_IsPlaying()

BOOLEAN APVR_IsPlaying ( void )

Returns whether playback is in progress.

Returns: TRUE if playback has been started, FALSE otherwise

Definition at line 1197 of file ap_pvr.c.

◆ APVR_IsRecordingHandle()

BOOLEAN APVR_IsRecordingHandle	(	U8BIT	path,
		U32BIT	recording_handle
	)

Returns TRUE if given recording handle is still in progress on the given decode path.

Parameters

path	decode path used for recording
recording_handle	recording

Returns: TRUE if the recording is still in progress, FALSE otherwise

Definition at line 2838 of file ap_pvr.c.

◆ APVR_IsRecordingInProgress()

BOOLEAN APVR_IsRecordingInProgress ( void )

Returns TRUE if there are any recordings currently in progress.

Returns: TRUE if recording in progress, FALSE otherwise

Definition at line 2798 of file ap_pvr.c.

◆ APVR_IsTimeshiftRecording()

BOOLEAN APVR_IsTimeshiftRecording ( U32BIT handle )

Checks whether the given recording handle is the timeshift recording handle.

Parameters

handle recording handle to be checked

Returns: TRUE if the given recording handle is the timeshift recording handle, FALSE otherwise

Definition at line 2504 of file ap_pvr.c.

◆ APVR_IsTimeshiftRecordingPath()

BOOLEAN APVR_IsTimeshiftRecordingPath ( U8BIT path )

Checks whether the given path is the one that's being used for timeshift recording.

Parameters

path	decode path to be checked

Returns: TRUE if the given path is the one being used for timeshift recording, FALSE otherwise

Definition at line 2479 of file ap_pvr.c.

◆ APVR_IsTimeshiftStarted()

BOOLEAN APVR_IsTimeshiftStarted ( void )

Checks whether timeshift has been started, which includes both recording and playback.

Returns: TRUE if timeshift is started, FALSE otherwise

Definition at line 2454 of file ap_pvr.c.

◆ APVR_PidsUpdated()

void APVR_PidsUpdated ( U8BIT path )

This function should be called when there's an update to the PIDs for a service that's being recorded. The PIDs being recorded are checked and any that are no longer valid will no longer be recorded and any new PIDs will be added.

Parameters

path	recording path

Definition at line 3791 of file ap_pvr.c.

◆ APVR_PlayRecording()

BOOLEAN APVR_PlayRecording	(	U32BIT	recording_handle,
		BOOLEAN	resume_playback,
		void *	monitor_service
	)

Starts playback of the given recording.

Parameters

recording_handle	handle of recorded programme to playback
resume_playback	TRUE if playback of the recording should resume from where it was last stopped, FALSE to start from the beginning
monitor_service	service to be tuned to in order to monitor SI data whilst playback is in progress. If this is NULL and the live path is still valid and tuned to a service then this will be used to monitor SI data. If neither are valid then no SI monitoring will be performed, which may result in recordings failing to be started if they're set to be event triggered.

Returns: TRUE if playback starts, FALSE otherwise

Definition at line 1031 of file ap_pvr.c.

◆ APVR_PrepareNewRecording()

U8BIT APVR_PrepareNewRecording	(	U16BIT	onet_id,
		U16BIT	trans_id,
		U16BIT	service_id,
		BOOLEAN *	new_tuned_service
	)

Acquires a decode path for recording the given service and tunes to it.

Parameters

onet_id	original network id for the service
trans_id	transport id for the service
service_id	service id for the service
new_tuned_service	returns TRUE if tuning is started. FALSE means the path is already tuned to the service

Returns: ID of path or INVALID_RES_ID on failure

Definition at line 1793 of file ap_pvr.c.

◆ APVR_RecordRecommendations()

void APVR_RecordRecommendations ( void * crid_ptr )

Searches the schedule for events that are part of the given recommendation and that haven't already been recorded or aren't set to be recorded and creates a timer to record them.

Parameters

crid_ptr pointer to the CRID record

Definition at line 3433 of file ap_pvr.c.

◆ APVR_RecordSeries()

void APVR_RecordSeries ( void * crid_ptr )

Seaches the schedule for events that are part of the given series and that haven't already been recorded or aren't set to be recorded and creates a timer to record them.

Parameters

crid_ptr pointer to the CRID record

Definition at line 3267 of file ap_pvr.c.

◆ APVR_ReleaseActiveRecordingList()

void APVR_ReleaseActiveRecordingList ( U32BIT * handle_list )

Frees the arrays allocated by APVR_GetActiveRecordingList.

Parameters

handle_list array of recording handles

Definition at line 2275 of file ap_pvr.c.

◆ APVR_ReleasePlayList()

void APVR_ReleasePlayList	(	U32BIT *	handle_list,
		U8BIT **	name_list,
		U32BIT *	rec_status_list,
		U32BIT *	locked_list,
		U32BIT *	selected_list,
		U32BIT *	split_list
	)

Frees the arrays allocated by APVR_GetPlayList.

Parameters

handle_list	array of recording handles
name_list	array of recording names
rec_status_list	array of recording status'
locked_list	array of locked status'
selected_list	array of selected status'

Definition at line 978 of file ap_pvr.c.

◆ APVR_SetEndPadding()

void APVR_SetEndPadding ( S32BIT padding )

Sets the default time that will be added to the end of all recording timers created after this value is set. Positive values will end a recording after the scheduled end time and negative values will end it before the scheduled end time.

Parameters

padding end padding time in seconds

Definition at line 803 of file ap_pvr.c.

◆ APVR_SetNotifyTime()

void APVR_SetNotifyTime ( U16BIT notify_time )

Sets the time, in seconds, when an event will be sent as a notification that a recording is about to start. This setting will apply to all recording timers that don't have a notify time already set. If this value is set to 0 then events will only be sent for recording timers that have their own notify time set.

Parameters

notify_time number of seconds before the recording is due to start when the event will be sent. Setting 0 disables the notification.

Definition at line 762 of file ap_pvr.c.

◆ APVR_SetPlaybackTime()

BOOLEAN APVR_SetPlaybackTime ( U32BIT position_in_secs )

Sets returns the number of seconds in playback buffer.

Parameters

position_in_secs number of seconds from start of playback

Returns: TRUE if successfully changed play back position

Definition at line 3162 of file ap_pvr.c.

◆ APVR_SetPlaySpeed()

BOOLEAN APVR_SetPlaySpeed ( S16BIT speed )

Set current play speed as a signed percentage value representing the speed, where 100% is normal playback speed.

Parameters

speed Play speed as a percentage

Returns: TRUE if successful

Definition at line 1710 of file ap_pvr.c.

◆ APVR_SetStartPadding()

void APVR_SetStartPadding ( S32BIT padding )

Sets the default time that will be added to the start of all recording timers created after this value is set. Positive values will start a recording before the scheduled start time and negative values will start it later than the scheduled time.

Parameters

padding start padding time in seconds

Definition at line 788 of file ap_pvr.c.

◆ APVR_SetTimeshiftBufferSize()

void APVR_SetTimeshiftBufferSize ( U16BIT time_in_mins )

Sets the size of the timeshift buffer so that it's able to store a recording of the given length before it has to loop round. Whether this value can be accurately achieved may vary according to the support provided by the platform.

Parameters

time_in_mins timeshift buffer size in minutes

Definition at line 2431 of file ap_pvr.c.

◆ APVR_StartNewRecording()

BOOLEAN APVR_StartNewRecording	(	U16BIT	disk_id,
		U8BIT	path,
		U8BIT *	recording_name,
		U16BIT	event_id,
		U8BIT *	prog_crid,
		U8BIT *	other_crid,
		U32BIT *	rec_handle
	)

Starts a recording after any tuning has completed and sets the info to be stored with it.

Parameters

disk_id	disk to record onto, default disk will be used if given disk id is invalid
path	decode path to use for recording
recording_name	name to be given to recording
event_id	event id which will be used to obtain info to save with the recording
prog_crid	programme crid (only relevant for systems that broadcast CRIDs)
other_crid	series or recommendation crid
rec_handle	pointer to returned recording handle

Returns: TRUE if the recording is started successfully, FALSE otherwise

Definition at line 1837 of file ap_pvr.c.

◆ APVR_StartPausePlay()

U8BIT APVR_StartPausePlay ( void )

Starts playback of a live timeshift recording started with APVR_StartPauseRecord. This function should not be called until STB_EVENT_PVR_REC_START has been received with the correct recording path as an argument (as returned by APVR_StartPauseRecord).

Returns: decode path used for the playback, INVALID_RES_ID on error

Definition at line 2644 of file ap_pvr.c.

◆ APVR_StartPauseRecord()

U8BIT APVR_StartPauseRecord ( void )

Starts recording the live service ready for timeshift playback. The recording may not have started when this function returns, so an app should wait for the STB_EVENT_PVR_REC_START event before starting the paused playback using APVR_StartPausePlay.

Returns: decode path used for the pause recording, INVALID_RES_ID on error

Definition at line 2531 of file ap_pvr.c.

◆ APVR_StopPauseRecord()

void APVR_StopPauseRecord ( BOOLEAN return_to_live )

Stops timeshifted playback and recording and optionally restarts decoding of the live signal.

Parameters

return_to_live TRUE to start decoding the live service

Definition at line 2730 of file ap_pvr.c.

◆ APVR_StopPlay()

void APVR_StopPlay ( BOOLEAN return_to_live )

Stops playback and optionally returns to live TV.

Parameters

return_to_live TRUE to return to live TV after stopping playback

Definition at line 1304 of file ap_pvr.c.

◆ APVR_StopRecording()

BOOLEAN APVR_StopRecording ( U32BIT recording_handle )

Stops the given recording.

Parameters

recording_handle recording to be stopped

Returns: TRUE if recording stopped ok, FALSE otherwise

Definition at line 2156 of file ap_pvr.c.

Typedefs

Enumerations

Functions

Detailed Description

Function Documentation

◆ APVR_AreSelectedRecordings()

◆ APVR_CheckSpaceDuration()

◆ APVR_CheckSpaceForDuration()

◆ APVR_CheckSpaceForEvent()

◆ APVR_DeleteAllSelectedRecordings()

◆ APVR_DeleteRecording()

◆ APVR_EncryptRecordings()

◆ APVR_FindNextSplitEvent()

◆ APVR_GetActiveRecordingList()

◆ APVR_GetDiskMbyte()

◆ APVR_GetDiskTime()

◆ APVR_GetEndPadding()

◆ APVR_GetNotifyTime()

◆ APVR_GetPathRecordingName()

◆ APVR_GetPauseProgress()

◆ APVR_GetPlaybackElapsedTime()

◆ APVR_GetPlaybackHandle()

◆ APVR_GetPlaybackPath()

◆ APVR_GetPlaybackService()

◆ APVR_GetPlaybackTime()

◆ APVR_GetPlayList()

◆ APVR_GetPlayMode()

◆ APVR_GetPlaySpeed()

◆ APVR_GetRecordingHandle()

◆ APVR_GetStartPadding()

◆ APVR_GetTimeshiftBufferSize()

◆ APVR_GetTotalSpacePercentUsed()

◆ APVR_HandlePrivateTimer()

◆ APVR_IsDecodingFile()

◆ APVR_IsEventInRecordList()

◆ APVR_IsInitialised()

◆ APVR_IsPlaying()

◆ APVR_IsRecordingHandle()

◆ APVR_IsRecordingInProgress()

◆ APVR_IsTimeshiftRecording()

◆ APVR_IsTimeshiftRecordingPath()

◆ APVR_IsTimeshiftStarted()

◆ APVR_PidsUpdated()

◆ APVR_PlayRecording()

◆ APVR_PrepareNewRecording()

◆ APVR_RecordRecommendations()

◆ APVR_RecordSeries()

◆ APVR_ReleaseActiveRecordingList()

◆ APVR_ReleasePlayList()

◆ APVR_SetEndPadding()

◆ APVR_SetNotifyTime()

◆ APVR_SetPlaybackTime()

◆ APVR_SetPlaySpeed()

◆ APVR_SetStartPadding()

◆ APVR_SetTimeshiftBufferSize()

◆ APVR_StartNewRecording()

◆ APVR_StartPausePlay()

◆ APVR_StartPauseRecord()

◆ APVR_StopPauseRecord()

◆ APVR_StopPlay()

◆ APVR_StopRecording()