All Timer Function Documentation
TAP_Timer_GetTotalNum
Topfield Documentation
int TAP_Timer_GetTotalNum();
It gets the total number of used timers.
return value : the number of used timer
Additional Documentation
TAP_Timer_GetInfo
Topfield Documentation
bool TAP_Timer_GetInfo(int entryNum, TYPE_TimerInfo *info);
It gets the information of used timer.
- entryNum : the timer number to be got its information
- info : the pointer of the TYPE_TimerInfo which gets the information.
return value : TRUE = Success, FALSE = False
The structure of TYPE_TimerInfo is as follows.
typedef struct
{
byte isRec;// 1 = Recording, 0 = VCR Timer
byte tuner; // 0 = Tuner1 , 1 = Tuner2
byte svcType;
byte reserved;
word svcNum;
byte reservationType;
byte nameFix; // 1 = fileName is fixed
word duration;
dword startTime;
char fileName[];
} TYPE_TimerInfo
Additional Documentation
TAP_Timer_Add
Topfield Documentation
int TAP_Timer_Add(TYPE_TimerInfo *info);
It adds a timer.
- info : information of the timer to be added.
return value
value | description |
---|
0 | Success |
1 | ERROR : Invalid Entry or No resource available. |
2 | ERROR : Invalid Tuner |
0xFFFFxxxx | xxxx = There is conflict with the xxxx Timer. |
Additional Information
The clashing timers that have caused a failure to add this timer are encoded in the two low order bytes of the return value - i.e. if the function returns 0xFFFFabcd, the clashing times numbers are 0xab and 0xcd. See this
link on www.toppy.org.uk.
TAP_Timer_Modify
Topfield Documentation
int TAP_Timer_Modify(int entryNum, TYPE_TimerInfo *info);
It changes the information of the timer which is already set.
parameter | use |
---|
entryNum | the number of timer whose information |
info | new information of the timer to be changed. |
return value
value | description |
---|
0 | Success |
1 | ERROR : Invalid Entry or No resource available. |
2 | ERROR : Invalid Tuner |
0xFFFFxxxx | xxxx = There is conflict with the xxxx Timer. |
Additional Documentation
TAP_Timer_Delete
Topfield Documentation
bool TAP_Timer_Delete(int entryNum);
It deletes the timer.
parameter | use |
---|
entryNum | the number of timer to delete |
return value : TRUE = Success, FALSE = False
Additional Documentation