sf_audio_playback_data_t Struct Reference

#include <sf_audio_playback_api.h>

Data Fields
sf_message_header_t	header
	Required common members of messaging framework payloads.
sf_audio_playback_data_type_t	type
	Data type. Must be uncompressed.
uint32_t	size_bytes
	Size of data in bytes.
void const *	p_data
	Pointer to data. Data start address must be 4-byte aligned.
UINT	loop_timeout
bool	stream_end

Detailed Description

Audio data for playback.

Field Documentation

loop_timeout

UINT sf_audio_playback_data_t::loop_timeout

ThreadX timeout, select TX_NO_WAIT to play the entire buffer once, TX_WAIT_FOREVER to loop until SF_AUDIO_PLAYBACK_Pause is called from another thread, or any timeout value from (0x00000001 through 0xFFFFFFFE) in ThreadX tick counts to loop until the tick counts expire.

stream_end

bool sf_audio_playback_data_t::stream_end

This releases ownership of the stream and allows other threads to post data. Set to true if not more data will be sent as a part of this logical bitstream. Set to false if more packets are being prepared.

---

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

• sf_audio_playback_api.h