path: root/apps/plugins/lua/rocklib.h
diff options
authorWilliam Wilgus <>2019-06-27 11:28:34 -0500
committerWilliam Wilgus <>2019-07-19 20:48:34 -0500
commit3e2b50ed3b58daa5e3be5ea336d276b1655565f1 (patch)
treea56ba215a934ab60c0be0ffcb73f0c193c5c7e38 /apps/plugins/lua/rocklib.h
parentb0de98ad3b1391ec0dfe4f8eced0a6833490cd8f (diff)
lua events from rockbox
This library allows events to be subscribed / recieved within a lua script most events in rb are synchronous so flags are set and later checked by a secondary thread to make them (semi?) asynchronous. There are a few caveats to be aware of: FIRST, The main lua state is halted till the lua callback(s) are finished Yielding will not return control to your script from within a callback Also, subsequent callbacks may be delayed by the code in your lua callback SECOND, You must store the value returned from the event_register function you might get away with it for a bit but gc will destroy your callback eventually if you do not store the event THIRD, You only get one cb per event type ["action", "button", "custom", "playback", "timer"] (Re-registration of an event overwrites the previous one) Usage: possible events =["action", "button", "custom", "playback", "timer"] local evX = rockev.register("event", cb_function, [timeout / flags]) cb_function([id] [, data]) ... end rockev.suspend(["event"/nil][true/false]) passing nil affects all events stops event from executing, any but the last event before re-enabling will be lost, passing false, unregistering or re-registering an event will clear the suspend rockev.trigger("event", [true/false], [id]) sets an event to triggered, NOTE!, CUSTOM_EVENT must be unset manually id is only passed to callback by custom and playback events rockev.unregister(evX) Use unregister(evX) to remove an event Unregistering is not necessary before script end, it will be cleaned up on script exit Change-Id: Iea12a5cc0c0295b955dcc1cdf2eec835ca7e354d
Diffstat (limited to 'apps/plugins/lua/rocklib.h')
1 files changed, 2 insertions, 0 deletions
diff --git a/apps/plugins/lua/rocklib.h b/apps/plugins/lua/rocklib.h
index 5d3abe30ec..02b5ff6c88 100644
--- a/apps/plugins/lua/rocklib.h
+++ b/apps/plugins/lua/rocklib.h
@@ -46,8 +46,10 @@ struct lua_str_reg {
LUALIB_API int (luaopen_rock) (lua_State *L) __attribute__((aligned(0x8)));
+/* in rockaux.c */
int get_current_path(lua_State *L, int level);
int filetol(int fd, long *num);
+int get_plugin_action(int timeout, bool with_remote);
#endif /* _ROCKLIB_H_ */