sf_audio_playback_hw_api_t Struct Reference

#include <sf_audio_playback_hw_api.h>

Data Fields
ssp_err_t(*	open )(sf_audio_playback_hw_ctrl_t *const p_ctrl, sf_audio_playback_hw_cfg_t const *const p_cfg)
ssp_err_t(*	start )(sf_audio_playback_hw_ctrl_t *const p_ctrl)
ssp_err_t(*	stop )(sf_audio_playback_hw_ctrl_t *const p_ctrl)
ssp_err_t(*	play )(sf_audio_playback_hw_ctrl_t *const p_ctrl, int16_t const *const p_buffer, uint32_t length)
ssp_err_t(*	dataTypeGet )(sf_audio_playback_hw_ctrl_t *const p_ctrl, sf_audio_playback_data_type_t *const p_data_type)
ssp_err_t(*	close )(sf_audio_playback_hw_ctrl_t *const p_ctrl)
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)

Detailed Description

Audio playback API definition.

Field Documentation

close

ssp_err_t(* sf_audio_playback_hw_api_t::close) (sf_audio_playback_hw_ctrl_t *const p_ctrl)

Close the audio driver.

Implemented as

• SF_AUDIO_PLAYBACK_HW_DAC_Close()

Parameters

[in]

p_ctrl

Pointer to control block initialized in sf_audio_playback_hw_api_t::open.

dataTypeGet

ssp_err_t(* sf_audio_playback_hw_api_t::dataTypeGet) (sf_audio_playback_hw_ctrl_t *const p_ctrl, sf_audio_playback_data_type_t *const p_data_type)

Stores expected data type in provided pointer p_data_type.

Implemented as

• SF_AUDIO_PLAYBACK_HW_DAC_DataTypeGet()

Parameters

[in]	p_ctrl	Pointer to control block initialized in sf_audio_playback_hw_api_t::open.
[out]	p_data_type	Pointer to audio sample data type required by hardware.

open

ssp_err_t(* sf_audio_playback_hw_api_t::open) (sf_audio_playback_hw_ctrl_t *const p_ctrl, sf_audio_playback_hw_cfg_t const *const p_cfg)

Open a device channel for read/write and control.

Implemented as

• SF_AUDIO_PLAYBACK_HW_DAC_Open()

Parameters

[in,out]	p_ctrl	Pointer to memory allocated for control block.
[in]	p_cfg	Pointer to the hardware configurations.

play

ssp_err_t(* sf_audio_playback_hw_api_t::play) (sf_audio_playback_hw_ctrl_t *const p_ctrl, int16_t const *const p_buffer, uint32_t length)

Play audio buffer.

Implemented as

• SF_AUDIO_PLAYBACK_HW_DAC_Play()

Parameters

[in]	p_ctrl	Pointer to control block initialized in sf_audio_playback_hw_api_t::open.
[in]	p_buffer	Pointer to buffer with PCM samples to play. Data must be scaled for audio playback hardware.
[in]	length	Length of data in p_buffer.

start

ssp_err_t(* sf_audio_playback_hw_api_t::start) (sf_audio_playback_hw_ctrl_t *const p_ctrl)

Start audio playback hardware.

Implemented as

• SF_AUDIO_PLAYBACK_HW_DAC_Start()

Parameters

[in]

p_ctrl

Pointer to control block initialized in sf_audio_playback_hw_api_t::open.

stop

ssp_err_t(* sf_audio_playback_hw_api_t::stop) (sf_audio_playback_hw_ctrl_t *const p_ctrl)

Stop audio playback hardware.

Implemented as

• SF_AUDIO_PLAYBACK_HW_DAC_Stop()

Parameters

[in]

p_ctrl

Pointer to control block initialized in sf_audio_playback_hw_api_t::open.

versionGet

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

Return the version of the driver.

Implemented as

• SF_AUDIO_PLAYBACK_HW_DAC_VersionGet()

Parameters

[out]

p_version

Pointer to variable that will be populated with version information.

---

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

• sf_audio_playback_hw_api.h