Synergy Software Package User's Manual
sf_audio_playback_instance_ctrl_t Struct Reference

#include <sf_audio_playback.h>

Data Fields

uint32_t open
 Used to determine if driver is initialized.
 
TX_THREAD * p_owner
 
void(* p_callback )(sf_message_callback_args_t *p_args)
 
uint8_t class_instance
 Class instance used to identify the stream to the messaging framework.
 
uint32_t samples_remaining
 Internal state of data samples remaining for this stream.
 
uint32_t samples_total
 Total number of samples to play (independent of sample size like 8/12/16).
 
uint32_t index
 Internal state of current data index for this stream.
 
uint32_t end
 Used to track completion of looped playback.
 
sf_audio_playback_data_tp_data [2]
 Audio data read from queue.
 
sf_audio_playback_status_t status
 Status of current stream.
 
sf_audio_playback_common_instance_ctrl_tp_common_ctrl
 

Detailed Description

Audio stream instance control block. DO NOT INITIALIZE. Initialization occurs when sf_audio_playback_api_t::open is called.

Field Documentation

◆ p_callback

void(* sf_audio_playback_instance_ctrl_t::p_callback) (sf_message_callback_args_t *p_args)

Callback called when playback of a buffer passed to sf_audio_playback_api_t::start is complete.

◆ p_common_ctrl

sf_audio_playback_common_instance_ctrl_t* sf_audio_playback_instance_ctrl_t::p_common_ctrl

Pointer to the hardware control block used by this stream.

◆ p_owner

TX_THREAD* sf_audio_playback_instance_ctrl_t::p_owner

Pointer to thread that began the stream at this index. Used to ensure multiple threads don't interleave data on the same stream.


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