fdo-mirrors/wireplumber
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/wireplumber.git synced 2025-12-20 20:30:03 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
wireplumber/lib/wp/settings.h

70 lines
1.6 KiB
C
Raw Normal View History

lib: Introduce WpSettings API - WpSettings is a singleton object which attaches itself to the core and registry, it provides a get_instance () for its clients. - WpSettings provides API to get/set wireplumber settings and rules. - main.c loads the new object and makes sure it is available for for all the modules and scripts. This is achieved by introducing a new activation step. - Add the lua bindings for get_setting API.
2022-03-22 03:38:35 +05:30
/* WirePlumber
*
* Copyright © 2022 Collabora Ltd.
* @author Ashok Sidipotu <ashok.sidipotu@collabora.com>
*
* SPDX-License-Identifier: MIT
*/
#ifndef __WIREPLUMBER_SETTINGS_H__
#define __WIREPLUMBER_SETTINGS_H__
#include "object.h"
settings: use WpSpaJson to parse the settings We need to use WpSpaJson to parse the values in WpSettings. This is because the wireplumber configuration is written in JSON, so WpSettings should only hold JSON values. To fix this, 2 API changes have been done: - wp_settings_get_int() only accepts gint values, instead of gint64 values. This is because the WpSpaJson API only parses int values, like spa_json_parse_int(). - wp_settings_get_string() now returns a newly allocated string, this is because the string needs to be decoded in case it has quotes.
2022-08-11 11:30:10 -04:00
#include "spa-json.h"
lib: Introduce WpSettings API - WpSettings is a singleton object which attaches itself to the core and registry, it provides a get_instance () for its clients. - WpSettings provides API to get/set wireplumber settings and rules. - main.c loads the new object and makes sure it is available for for all the modules and scripts. This is achieved by introducing a new activation step. - Add the lua bindings for get_setting API.
2022-03-22 03:38:35 +05:30
G_BEGIN_DECLS
/*!
* \brief Flags to be used as WpObjectFeatures on WpSettings subclasses.
* \ingroup wpsettings
*/
settings: fix doxygen/g-i strings/commands and link them to the sphinx site
2022-05-04 14:45:55 +03:00
typedef enum { /*< flags >*/
/*! Loads the settings */
lib: Introduce WpSettings API - WpSettings is a singleton object which attaches itself to the core and registry, it provides a get_instance () for its clients. - WpSettings provides API to get/set wireplumber settings and rules. - main.c loads the new object and makes sure it is available for for all the modules and scripts. This is achieved by introducing a new activation step. - Add the lua bindings for get_setting API.
2022-03-22 03:38:35 +05:30
WP_SETTINGS_LOADED = (1 << 0),
} WpSettingsFeatures;
/*!
* \brief The WpSettings GType
* \ingroup wpsettings
*/
#define WP_TYPE_SETTINGS (wp_settings_get_type ())
WP_API
G_DECLARE_FINAL_TYPE (WpSettings, wp_settings, WP, SETTINGS, WpObject)
WP_API
lib: Add wp_settings_apply_rule() API - add C based tests - add lua binding for the API and corresponding lua tests - address comments from previous commits
2022-04-25 10:45:34 +05:30
WpSettings * wp_settings_get_instance (WpCore * core,
const gchar *metadata_name);
lib: Introduce WpSettings API - WpSettings is a singleton object which attaches itself to the core and registry, it provides a get_instance () for its clients. - WpSettings provides API to get/set wireplumber settings and rules. - main.c loads the new object and makes sure it is available for for all the modules and scripts. This is achieved by introducing a new activation step. - Add the lua bindings for get_setting API.
2022-03-22 03:38:35 +05:30
lib: wpsettings: Add _register_callback () API
2022-05-26 13:15:22 +05:30
/*!
settings: use WpSpaJson instead of raw string in WpSettingsChangedCallback Avoids users to construct a WpSpaJson every time the callback is triggered.
2022-09-01 08:22:56 -04:00
* \brief callback conveying the changed setting and its json value
lib: wpsettings: Add _register_callback () API
2022-05-26 13:15:22 +05:30
*
* \ingroup wpsettings
* \param obj the wpsettings object
* \param setting the changed setting
settings: use WpSpaJson instead of raw string in WpSettingsChangedCallback Avoids users to construct a WpSpaJson every time the callback is triggered.
2022-09-01 08:22:56 -04:00
* \param value json value of the the changed setting
lib: wpsettings: Add _register_callback () API
2022-05-26 13:15:22 +05:30
* \param user_data data passed in the \a wp_settings_subscribe
*/
typedef void (*WpSettingsChangedCallback) (WpSettings *obj,
settings: use WpSpaJson instead of raw string in WpSettingsChangedCallback Avoids users to construct a WpSpaJson every time the callback is triggered.
2022-09-01 08:22:56 -04:00
const gchar *setting, WpSpaJson *value, gpointer user_data);
lib: wpsettings: Add _register_callback () API
2022-05-26 13:15:22 +05:30
WP_API
guintptr wp_settings_subscribe (WpSettings *self,
const gchar *pattern, WpSettingsChangedCallback callback,
gpointer user_data);
WP_API
guintptr wp_settings_subscribe_closure (WpSettings *self,
const gchar *pattern, GClosure * closure);
WP_API
gboolean wp_settings_unsubscribe (WpSettings *self,
guintptr subscription_id);
settings: use WpSpaJson to parse the settings We need to use WpSpaJson to parse the values in WpSettings. This is because the wireplumber configuration is written in JSON, so WpSettings should only hold JSON values. To fix this, 2 API changes have been done: - wp_settings_get_int() only accepts gint values, instead of gint64 values. This is because the WpSpaJson API only parses int values, like spa_json_parse_int(). - wp_settings_get_string() now returns a newly allocated string, this is because the string needs to be decoded in case it has quotes.
2022-08-11 11:30:10 -04:00
WP_API
WpSpaJson * wp_settings_get (WpSettings *self, const gchar *setting);
lib: Add _get_float() wpsettings API - also add the corresponding C & Lua tests.
2022-05-09 12:43:36 +05:30
lib: Introduce WpSettings API - WpSettings is a singleton object which attaches itself to the core and registry, it provides a get_instance () for its clients. - WpSettings provides API to get/set wireplumber settings and rules. - main.c loads the new object and makes sure it is available for for all the modules and scripts. This is achieved by introducing a new activation step. - Add the lua bindings for get_setting API.
2022-03-22 03:38:35 +05:30
G_END_DECLS
#endif
Reference in a new issue Copy permalink