sf_audio_record_api_t Struct Reference

#include <sf_audio_record_api.h>

Data Fields
ssp_err_t(*	open )(sf_audio_record_ctrl_t *const p_ctrl, sf_audio_record_cfg_t const *const p_cfg)
	Initializes audio recording framework. More...
ssp_err_t(*	start )(sf_audio_record_ctrl_t *const p_ctrl)
	Starts audio recording. More...
ssp_err_t(*	stop )(sf_audio_record_ctrl_t *const p_ctrl)
	Stops audio recording. More...
ssp_err_t(*	infoGet )(sf_audio_record_ctrl_t *const p_ctrl, sf_audio_record_info_t *p_info)
	Gets channel information(Mono/Stereo). More...
ssp_err_t(*	close )(sf_audio_record_ctrl_t *const p_ctrl)
	Releases channel mutex and closes channel at HAL layer. More...
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)
	Gets version and stores it in provided pointer p_version. More...

Detailed Description

Framework Audio Recording API structure. Implementations will use the following API.

Field Documentation

close

ssp_err_t(* sf_audio_record_api_t::close) (sf_audio_record_ctrl_t *const p_ctrl)

Releases channel mutex and closes channel at HAL layer.

Implemented as

• SF_AUDIO_RECORD_ADC_Close()
• SF_AUDIO_RECORD_I2S_Close()

Parameters

[in]

p_ctrl

Pointer to control block.

infoGet

ssp_err_t(* sf_audio_record_api_t::infoGet) (sf_audio_record_ctrl_t *const p_ctrl, sf_audio_record_info_t *p_info)

Gets channel information(Mono/Stereo).

Implemented as

• SF_AUDIO_RECORD_ADC_InfoGet()
• SF_AUDIO_RECORD_I2S_InfoGet()

Parameters

[in]	p_ctrl	Pointer to control block.
[out]	p_info	Pointer to information block.

open

ssp_err_t(* sf_audio_record_api_t::open) (sf_audio_record_ctrl_t *const p_ctrl, sf_audio_record_cfg_t const *const p_cfg)

Initializes audio recording framework.

Implemented as

• SF_AUDIO_RECORD_ADC_Open()
• SF_AUDIO_RECORD_I2S_Open()

Parameters

[in,out]	p_ctrl	Pointer to a structure allocated by user. Elements initialized here.
[in]	p_cfg	Pointer to configuration structure. All elements of the structure must be set by user.

start

ssp_err_t(* sf_audio_record_api_t::start) (sf_audio_record_ctrl_t *const p_ctrl)

Starts audio recording.

Implemented as

• SF_AUDIO_RECORD_ADC_Start()
• SF_AUDIO_RECORD_I2S_Start()

Parameters

[in]

p_ctrl

Pointer to control block set

stop

ssp_err_t(* sf_audio_record_api_t::stop) (sf_audio_record_ctrl_t *const p_ctrl)

Stops audio recording.

Implemented as

• SF_AUDIO_RECORD_ADC_Stop()
• SF_AUDIO_RECORD_I2S_Stop()

Parameters

[in]

p_ctrl

Pointer to control block.

versionGet

ssp_err_t(* sf_audio_record_api_t::versionGet) (ssp_version_t *const p_version)

Gets version and stores it in provided pointer p_version.

Implemented as

• SF_AUDIO_RECORD_ADC_VersionGet()
• SF_AUDIO_RECORD_I2S_VersionGet()

Parameters

[out]

p_version

Code and API version used.

---

The documentation for this struct was generated from the following file:

• sf_audio_record_api.h