vitasdk
Documentation of the vitasdk
Functions | Macros
User
System Status » Events Library

Detailed Description

Exports for User.

Using this library in your project

Include the header file in your project:

#include <psp2/triggerutil.h>


Link the library to the executable:

SceTriggerUtil_stub


Load the required module:

sceSysmoduleLoadModule(SCE_SYSMODULE_TRIGGER_UTIL);
sceSysmoduleLoadModule
int sceSysmoduleLoadModule(SceSysmoduleModuleId id)
Load a module.
SCE_SYSMODULE_TRIGGER_UTIL
@ SCE_SYSMODULE_TRIGGER_UTIL
TriggerUtil module.
Definition sysmodule.h:59


Functions

 VITASDK_BUILD_ASSERT_EQ (0x50, SceTriggerUtilEventParamDaily)
 
 VITASDK_BUILD_ASSERT_EQ (0x58, SceTriggerUtilEventParamOneTime)
 
 VITASDK_BUILD_ASSERT_EQ (0x46A, SceTriggerUtilUserAppInfo)
 
 VITASDK_BUILD_ASSERT_EQ (0x602, SceTriggerUtilSystemAppInfo)
 
int sceTriggerUtilRegisterDailyEvent (const char *titleid, const SceTriggerUtilEventParamDaily *param, int eventId, int a4, int a5)
 Register application start event that will be repeated on certain days.
 
int sceTriggerUtilRegisterOneTimeEvent (const char *titleid, const SceTriggerUtilEventParamOneTime *param, int eventId, int a4, int a5)
 Register one time application start event.
 
int sceTriggerUtilUnregisterDailyEvent (int eventId, int a2, int a3)
 Unregister daily event for caller application.
 
int sceTriggerUtilUnregisterOneTimeEvent (int eventId, int a2, int a3)
 Unregister one time event for caller application.
 
int sceTriggerUtilGetAutoStartStatus (int *status, int a2, int a3)
 Get value from "Settings->System->Auto-Start Settings" for caller application.
 
int sceTriggerUtilGetOneTimeEventInfo (int eventId, SceRtcTick *triggerTime, int a4, int a5)
 Get one time event info for caller application.
 
int sceTriggerUtilGetDailyEventInfo (int eventId, SceTriggerUtilEventParamDaily *param, int a5, int a6)
 Get daily event info for caller application.
 
int sceTriggerUtilGetUserAppInfo (const char *titleid, SceTriggerUtilUserAppInfo *appInfo, int a4, int a5)
 Get info for user application that has registered sceTriggerUtil events.
 
int sceTriggerUtilGetRegisteredUserTitleIdList (char *titleIdBuffer, int numOfIds)
 Get list of user applications that has registered sceTriggerUtil events.
 
int sceTriggerUtilGetSystemAppInfo (const char *titleid, SceTriggerUtilSystemAppInfo *appInfo, int a4, int a5)
 Get info for system application that has registered sceTriggerUtil events.
 
int sceTriggerUtilGetRegisteredSystemTitleIdList (char *buffer, int numOfIds)
 Get list of system applications that has registered sceTriggerUtil events.
 

Macros

#define SCE_TRIGGER_UTIL_VERSION   0x3200000
 

Data Structure Documentation

◆ SceTriggerUtilEventParamDaily

struct SceTriggerUtilEventParamDaily
Data Fields
SceUInt32 ver
SceInt16 extraParam1
SceInt16 extraParam2
SceInt32 triggerTime
SceUInt16 repeatDays
SceChar8 reserved[0x40]

◆ SceTriggerUtilEventParamOneTime

struct SceTriggerUtilEventParamOneTime
Data Fields
SceUInt32 ver
SceRtcTick triggerTime
SceUInt8 extraParam1
SceUInt8 extraParam2
SceChar8 reserved[0x44]

◆ SceTriggerUtilUserAppInfo

struct SceTriggerUtilUserAppInfo
Data Fields
SceWChar16 name[0x34]
SceChar8 iconPath[0x400]
short unk

◆ SceTriggerUtilSystemAppInfo

struct SceTriggerUtilSystemAppInfo
Data Fields
SceWChar16 name[0x100]
SceChar8 iconPath[0x400]
char reserved[2]

Macro Definition Documentation

◆ SCE_TRIGGER_UTIL_VERSION

#define SCE_TRIGGER_UTIL_VERSION   0x3200000
Note
Last two params in all of the functions are never used, probably callbacks since all sceTriggerUtil functions are non-blocking
Max number of events (eventId) per application is 6

Enumeration Type Documentation

◆ SceTriggerUtilDays

enum SceTriggerUtilDays

Days of the week for use in repeatDays member of SceTriggerUtilEventParamDaily.

Enumerator
SCE_TRIGGER_UTIL_SUNDAY 
SCE_TRIGGER_UTIL_MONDAY 
SCE_TRIGGER_UTIL_TUESDAY 
SCE_TRIGGER_UTIL_WEDNESDAY 
SCE_TRIGGER_UTIL_THURSDAY 
SCE_TRIGGER_UTIL_FRIDAY 
SCE_TRIGGER_UTIL_SATURDAY 

◆ SceTriggerUtilErrorCode

enum SceTriggerUtilErrorCode

Error Codes.

Enumerator
SCE_TRIGGER_UTIL_ERROR_BUSY 
SCE_TRIGGER_UTIL_ERROR_NOT_FOUND_USER 
SCE_TRIGGER_UTIL_ERROR_NOT_FOUND_SYSTEM 
SCE_TRIGGER_UTIL_ERROR_NOT_REGISTERED 
SCE_TRIGGER_UTIL_ERROR_EVENT_TYPE_MISMATCH 
SCE_TRIGGER_UTIL_ERROR_INVALID_ARG 

Function Documentation

◆ VITASDK_BUILD_ASSERT_EQ() [1/4]

VITASDK_BUILD_ASSERT_EQ ( 0x50  ,
SceTriggerUtilEventParamDaily   
)

◆ VITASDK_BUILD_ASSERT_EQ() [2/4]

VITASDK_BUILD_ASSERT_EQ ( 0x58  ,
SceTriggerUtilEventParamOneTime   
)

◆ VITASDK_BUILD_ASSERT_EQ() [3/4]

VITASDK_BUILD_ASSERT_EQ ( 0x46A  ,
SceTriggerUtilUserAppInfo   
)

◆ VITASDK_BUILD_ASSERT_EQ() [4/4]

VITASDK_BUILD_ASSERT_EQ ( 0x602  ,
SceTriggerUtilSystemAppInfo   
)

◆ sceTriggerUtilRegisterDailyEvent()

int sceTriggerUtilRegisterDailyEvent ( const char *  titleid,
const SceTriggerUtilEventParamDaily *  param,
int  eventId,
int  a4,
int  a5 
)

Register application start event that will be repeated on certain days.

Parameters
[in]titleid- title ID of application to register event for.
[in]param- event parameters.
[in]eventId- ID number of event.
[in]a4- Unknown, set to 0.
[in]a5- Unknown, set to 0.
Returns
0 on success, <0 otherwise.

◆ sceTriggerUtilRegisterOneTimeEvent()

int sceTriggerUtilRegisterOneTimeEvent ( const char *  titleid,
const SceTriggerUtilEventParamOneTime *  param,
int  eventId,
int  a4,
int  a5 
)

Register one time application start event.

Parameters
[in]titleid- title ID of application to register event for.
[in]param- event parameters.
[in]eventId- ID number of event.
[in]a4- Unknown, set to 0.
[in]a5- Unknown, set to 0.
Returns
0 on success, <0 otherwise.

◆ sceTriggerUtilUnregisterDailyEvent()

int sceTriggerUtilUnregisterDailyEvent ( int  eventId,
int  a2,
int  a3 
)

Unregister daily event for caller application.

Parameters
[in]eventId- ID number of event to unregister.
[in]a2- Unknown, set to 0.
[in]a3- Unknown, set to 0.
Returns
0 on success, <0 otherwise.

◆ sceTriggerUtilUnregisterOneTimeEvent()

int sceTriggerUtilUnregisterOneTimeEvent ( int  eventId,
int  a2,
int  a3 
)

Unregister one time event for caller application.

Parameters
[in]eventId- ID number of event to unregister.
[in]a2- Unknown, set to 0.
[in]a3- Unknown, set to 0.
Returns
0 on success, <0 otherwise.

◆ sceTriggerUtilGetAutoStartStatus()

int sceTriggerUtilGetAutoStartStatus ( int *  status,
int  a2,
int  a3 
)

Get value from "Settings->System->Auto-Start Settings" for caller application.

Required to be 1 to use sceTriggerUtil

Parameters
[out]status- auto-start status. Required to be 1 to use sceTriggerUtil.
[in]a2- Unknown, set to 0.
[in]a3- Unknown, set to 0.
Returns
0 on success, <0 otherwise.

◆ sceTriggerUtilGetOneTimeEventInfo()

int sceTriggerUtilGetOneTimeEventInfo ( int  eventId,
SceRtcTick *  triggerTime,
int  a4,
int  a5 
)

Get one time event info for caller application.

Parameters
[in]eventId- ID number of event to get information for.
[out]triggerTime- SceRtcTick, UTC
[in]a4- Unknown, set to 0.
[in]a5- Unknown, set to 0.
Returns
0 on success, <0 otherwise.

◆ sceTriggerUtilGetDailyEventInfo()

int sceTriggerUtilGetDailyEventInfo ( int  eventId,
SceTriggerUtilEventParamDaily *  param,
int  a5,
int  a6 
)

Get daily event info for caller application.

Parameters
[in]eventId- ID number of event to get information for.
[out]param- event parameters.
[in]a5- Unknown, set to 0.
[in]a6- Unknown, set to 0.
Returns
0 on success, <0 otherwise.

◆ sceTriggerUtilGetUserAppInfo()

int sceTriggerUtilGetUserAppInfo ( const char *  titleid,
SceTriggerUtilUserAppInfo *  appInfo,
int  a4,
int  a5 
)

Get info for user application that has registered sceTriggerUtil events.

Parameters
[in]titleid- title ID of application to get info for.
[out]appInfo- application information
[in]a4- Unknown, set to 0.
[in]a5- Unknown, set to 0.
Returns
0 on success, <0 otherwise.

◆ sceTriggerUtilGetRegisteredUserTitleIdList()

int sceTriggerUtilGetRegisteredUserTitleIdList ( char *  titleIdBuffer,
int  numOfIds 
)

Get list of user applications that has registered sceTriggerUtil events.

List contains null-separated title IDs

Parameters
[out]titleIdBuffer- pointer to buffer to recieve title ID list. Max size is 0x1000, min size is unlimited
[out]numOfIds- number of title IDs stored in the list
Returns
0 on success, <0 otherwise.

◆ sceTriggerUtilGetSystemAppInfo()

int sceTriggerUtilGetSystemAppInfo ( const char *  titleid,
SceTriggerUtilSystemAppInfo *  appInfo,
int  a4,
int  a5 
)

Get info for system application that has registered sceTriggerUtil events.

Parameters
[in]titleid- title ID of application to get info for.
[out]appInfo- application information
[in]a4- Unknown, set to 0.
[in]a5- Unknown, set to 0.
Returns
0 on success, <0 otherwise.

◆ sceTriggerUtilGetRegisteredSystemTitleIdList()

int sceTriggerUtilGetRegisteredSystemTitleIdList ( char *  buffer,
int  numOfIds 
)

Get list of system applications that has registered sceTriggerUtil events.

List contains null-separated fake title IDs

Parameters
[out]titleIdBuffer- pointer to buffer to recieve fake title ID list. Max size is 0x140, min size is unlimited
[out]numOfIds- number of fake title IDs stored in the list
Returns
0 on success, <0 otherwise.