Audio Regulator API

Audio Regulator API for nRF Audio applications. More...

Data Structures
struct	audio_regulator_ops
	Audio regulator's API structure. More...
struct	audio_regulator_ctx
	Audio regulator's private configuration. More...

Enumerations
enum	audio_regulator_state { AUDIO_REGULATOR_STATE_UNINITIALIZED = 0 , AUDIO_REGULATOR_STATE_INITIALIZED }
	The state of the audio regulator. More...

Functions
int	audio_regulator_init (struct audio_regulator_ctx *const ctx, struct audio_regulator_imp_ctx *const imp_ctx, struct audio_regulator_ops const *const imp_cb)
	Initialize an instance of the audio regulator module with the specified initial configuration.
int	audio_regulator_uninit (struct audio_regulator_ctx *ctx)
	Uninitialize an audio regulator module.
int	audio_regulator_reset (struct audio_regulator_ctx *const ctx)
	Reset an audio regulator module back to the last configuration.
int	audio_regulator_cfg_set (struct audio_regulator_ctx *const ctx, struct audio_regulator_cfg const *const cfg)
	Configure an audio regulator after it has been initialized.
int	audio_regulator_cfg_get (struct audio_regulator_ctx const *const ctx, struct audio_regulator_cfg *const cfg)
	Get the configuration of an audio regulator module.
int	audio_regulator_update_control (struct audio_regulator_ctx const *const ctx, void *const ref_val_r, void *const meas_val_y, void *const control_val_u)
	Update and get the new control_val_u between the reference value and the measured value for an audio regulator module.
int	audio_regulator_control_get (struct audio_regulator_ctx const *const ctx, void *const control_val_u)
	Get the control_val_u of an audio regulator module.

Detailed Description

Audio Regulator API for nRF Audio applications.

This Audio Regulator provides generic functions to manage the audio synchronisation. It uses the specified method given by the callback functions. Note that asynchronous regulators are not supported, and the update function must be called in a synchronous manner.