wireplumber/lib/wp/plugin.h

/* WirePlumber
 *
 * Copyright © 2020 Collabora Ltd.
 *    @author George Kiagiadakis <george.kiagiadakis@collabora.com>
 *
 * SPDX-License-Identifier: MIT
 */

#ifndef __WIREPLUMBER_PLUGIN_H__
#define __WIREPLUMBER_PLUGIN_H__

#include "object.h"

G_BEGIN_DECLS

/*!
 * \brief Flags to be used as WpObjectFeatures on WpPlugin subclasses.
 * \ingroup wpplugin
 */
typedef enum { /*< flags >*/
  /*! enables the plugin */
  WP_PLUGIN_FEATURE_ENABLED = (1 << 0),
} WpPluginFeatures;

/*!
 * \brief The WpPlugin GType
 * \ingroup wpplugin
 */
#define WP_TYPE_PLUGIN (wp_plugin_get_type ())
WP_API
G_DECLARE_DERIVABLE_TYPE (WpPlugin, wp_plugin, WP, PLUGIN, WpObject)

struct _WpPluginClass
{
  WpObjectClass parent_class;

  void (*enable) (WpPlugin * self, WpTransition * transition);
  void (*disable) (WpPlugin * self);
  /* New virtual method: called during core shutdown before registry is cleared.
     Uses one of the padding slots to preserve ABI. */
  void (*prepare_shutdown) (WpPlugin * self);

  /*< private >*/
  WP_PADDING(5)
};

WP_API
WpPlugin * wp_plugin_find (WpCore * core, const gchar * plugin_name);

WP_API
const gchar * wp_plugin_get_name (WpPlugin * self);

WP_API
void wp_plugin_prepare_shutdown (WpPlugin * self);

G_END_DECLS

#endif