The audio_pipeline_stop function sends requests to the elements and exits. The stopped audio_pipeline restart by audio_pipeline_resume.Įsp_err_t audio_pipeline_wait_for_stop ( audio_pipeline_handle_t pipeline ) ¶ The link state of the elements in the pipeline is kept, events are still registered. Used with audio_pipeline_wait_for_stop to keep in sync.
Everything remains the same except the data processing is stopped.Įsp_err_t audio_pipeline_stop ( audio_pipeline_handle_t pipeline ) ¶ This function will set all the elements to the PAUSED state.
This function will set all the elements to the RUNNING state and process the audio data as an inherent feature of audio_pipeline.Įsp_err_t audio_pipeline_pause ( audio_pipeline_handle_t pipeline ) ¶ ticks_to_wait: The maximum amount of time to block wait for element destroyĮsp_err_t audio_pipeline_resume ( audio_pipeline_handle_t pipeline ) ¶ Stop Audio Pipeline with specific ticks for timeout. With this function audio_pipeline will destroy tasks of all elements, that have been linked using the linking functions.Įsp_err_t audio_pipeline_terminate_with_ticks ( audio_pipeline_handle_t pipeline, TickType_t ticks_to_wait ) ¶ With this function audio_pipeline will create tasks for all elements, that have been linked using the linking functions.Įsp_err_t audio_pipeline_terminate ( audio_pipeline_handle_t pipeline ) ¶ Unregister the audio_element in audio_pipeline, remove it from the list.Įsp_err_t audio_pipeline_run ( audio_pipeline_handle_t pipeline ) ¶ name: The name identifier of the audio_element in this audio_pipelineĮsp_err_t audio_pipeline_unregister ( audio_pipeline_handle_t pipeline, audio_element_handle_t el ) ¶ Please register element strictly in the following order: input element first, process middle, output element last. Registering an element for audio_pipeline, each element can be registered multiple times, but name (as String) must be unique in audio_pipeline, which is used to identify the element for link creation mentioned in the audio_pipeline_linkīecause of stop pipeline or pause pipeline depend much on register order. Briefly, frees all memory.Įsp_err_t audio_pipeline_register ( audio_pipeline_handle_t pipeline, audio_element_handle_t el, const char * name ) ¶
This function removes all of the element’s links in audio_pipeline, cancels the registration of all events, invokes the destroy functions of the registered elements, and frees the memory allocated by the init function. Also get events from each element, process events or pass it to a higher layer.Ĭonfig: The configuration - audio_pipeline_cfg_tĮsp_err_t audio_pipeline_deinit ( audio_pipeline_handle_t pipeline ) ¶ Initialize audio_pipeline_handle_t object audio_pipeline is responsible for controlling the audio data stream and connecting the audio elements with the ringbuffer It will connect and start the audio element in order, responsible for retrieving the data from the previous element and passing it to the element after it. Sample Organization of Elements in Audio Pipeline ¶ API Reference ¶ Header File ¶įunctions ¶ audio_pipeline_handle_t audio_pipeline_init ( audio_pipeline_cfg_t * config ) ¶