mirrors/mumble
2
0
Fork 0
mirror of https://github.com/mumble-voip/mumble.git synced 2025-10-26 11:19:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
master
mumble/docs/dev/plugins/PluginLifecycle.md
Robert Adam 54012c5a07 DOCS: Document new plugin system
2021-06-06 17:49:41 +02:00

1.0 KiB
Raw Permalink Blame History

Mumble plugin lifecycle

Initialization

When the user chooses to activate an installed plugin, the following functions inside that plugin will be called (if implemented):

  1. mumble_setMumbleInfo - Tells the plugin about which version of Mumble is about to load it
  2. mumble_getAPIVersion - Ask the plugin which API version it is using
  3. mumble_registerAPIFunctions - Provides the Mumble-API functions to the plugin
  4. mumble_init - Actually initialize the plugin

Most notably: The plugin will always receive the Mumble-API function before mumble_init is called. Therefore the API can already be used in mumble_init, if required.

Shutdown

When deactivating a plugin, mumble_shutdown will be called. Note that during this shutdown method it is still safe to use the Mumble-API. As soon as this function returns though, the Mumble-API that was given to the plugin must be considered invalid and must no longer be used. This is important if your plugin has spawned a separate thread that might end asynchronously.