Read the Docs Template Documentation, Release
• ESP_OK
• ESP_FAIL
Parameters
•
el
: The audio element handle
esp_err_t
audio_element_stop
el
)
Request stop of the Audio Element. After receiving the stop request, the element will ignore the actions being
performed (read/write, wait for the ringbuffer . . . ) and close the task, reset the state variables. Note: this API
only sends requests, Element does not actually stop when this function returns.
Return
• ESP_OK
• ESP_FAIL
Parameters
•
el
: The audio element handle
esp_err_t
audio_element_wait_for_stop
el
)
After the
audio_element_stop
function is called, the Element task will perform some abort procedures.
This function will be blocked until Element Task has done and exit.
Return
• ESP_OK
• ESP_FAIL
Parameters
•
el
: The audio element handle
esp_err_t
audio_element_pause
el
)
Request audio Element enter ‘PAUSE’ state, in this state, the task will wait for any event.
Return
• ESP_OK
• ESP_FAIL
Parameters
•
el
: The audio element handle
esp_err_t
audio_element_resume
el
, float
wait_for_rb_threshold
, TickType_t
timeout
)
Request audio Element enter ‘RUNNING’ state, in this state, the task listens to event and invokes the callback
functions. At the same time it will wait until the size/total_size of the output ringbuffer is greater than or equal
to
wait_for_rb_threshold
If the timeout period has been exceeded and ringbuffer output has not yet
reached
wait_for_rb_threshold
then the function will return.
• ESP_FAIL
Return
• ESP_OK
2.1. Audio Framework
31
Summary of Contents for ESP32-LyraT
Page 1: ...Read the Docs Template Documentation Release Read the Docs Jul 01 2018...
Page 2: ......
Page 4: ...ii...
Page 6: ...Read the Docs Template Documentation Release 2 Contents...
Page 92: ...Read the Docs Template Documentation Release 88 Chapter 4 Resources...
Page 94: ...Read the Docs Template Documentation Release 90 Chapter 5 Copyrights and Licenses...
