plugin_lifecycle.h

Go to the documentation of this file.

 
#pragma once
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* REQUIRED - API level compatibility */
uint16_t plugin_required_api_major(void);
uint16_t plugin_required_api_minor(void);
 
/* REQUIRED - lifecycle */
int plugin_init  (void);                /* once after load */
int plugin_deinit(void);                /* before unload */
int plugin_on_enter(void);              /* user opens the plugin */
int plugin_on_exit (void);              /* user leaves the plugin */
 
/* OPTIONAL - event handlers, omit if not used */
int plugin_on_action(uint32_t action_id, uint32_t selected_idx, uint32_t user_data);
int plugin_on_button(uint32_t button_code);
int plugin_on_event (uint32_t event_type, uint32_t event_value);
int plugin_on_tick  (uint64_t uptime_ms);
int plugin_on_cmd   (uint32_t len);     /* host pushed a command; pull via host_cmd_consume */
 
/* OPTIONAL - declare this export if any prerequisite uses on_fail=callback */
int plugin_on_prerequisite_failed(uint32_t prereq_id, uint32_t error_code);
 
#ifdef __cplusplus
}
#endif