nRF Connect SDK API 3.4.99
Loading...
Searching...
No Matches
Audio rate control API

Audio rate control API for nRF Audio applications. More...

Data Structures

struct  audio_rate_control_ops
 Audio rate control's callback structure. More...
 
struct  audio_rate_control_ctx
 Audio rate control's private context. More...
 

Enumerations

enum  audio_rate_control_state { AUDIO_RATE_CONTROL_STATE_UNINITIALIZED = 0 , AUDIO_RATE_CONTROL_STATE_INITIALIZED }
 The state of the audio rate control. More...
 

Functions

int audio_rate_control_init (struct audio_rate_control_ctx *const ctx, struct audio_rate_control_imp_ctx *const imp_ctx, struct audio_rate_control_ops const *const imp_cb)
 Initialize an instance of the audio rate control module with the specified initial configuration.
 
int audio_rate_control_uninit (struct audio_rate_control_ctx *ctx)
 Uninitialize an audio rate control module.
 
int audio_rate_control_reset (struct audio_rate_control_ctx *const ctx)
 Reset an audio rate control module back to the last valid configuration.
 
int audio_rate_control_cfg_set (struct audio_rate_control_ctx *const ctx, struct audio_rate_control_cfg const *const cfg)
 Configure an audio rate control after it has been initialized.
 
int audio_rate_control_cfg_get (struct audio_rate_control_ctx const *const ctx, struct audio_rate_control_cfg *const cfg)
 Get the configuration of an audio rate control module.
 
int audio_rate_control_update (struct audio_rate_control_ctx *const ctx, void *const control_val_u)
 Update and get the new error between timestamps for an audio rate control module.
 

Detailed Description

Audio rate control API for nRF Audio applications.

This Audio Rate Control provides generic functions to manage the audio synchronization. On the nRF5340 SoC, the audio synchronization is typically controlled with the Audio Phase-Locked Loop (PLL). Although where this is not available, alternative methods can be configured through the callback functions.