From cc62a39c5b78e25f669b278cc949ce574c2fda84 Mon Sep 17 00:00:00 2001 From: David Reid Date: Sat, 8 Jan 2022 19:07:48 +1000 Subject: [PATCH] Update documentation. --- docs/manual/index.html | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/manual/index.html b/docs/manual/index.html index e8aa032c..5aa4e192 100644 --- a/docs/manual/index.html +++ b/docs/manual/index.html @@ -2827,10 +2827,10 @@ decoded, meaning the raw file data will be stored in memory, and then dynamicall memory, use the MA_RESOURCE_MANAGER_DATA_SOURCE_FLAG_DECODE flag. By default, the sound file will be loaded synchronously, meaning ma_resource_manager_data_source_init() will only return after the entire file has been loaded. This is good for simplicity, but can be prohibitively slow. You -can instead load the sound asynchronously using the MA_DATA_SOURCE_ASYNC flag. This will result -in ma_resource_manager_data_source_init() returning quickly, but no data will be returned by -ma_data_source_read_pcm_frames() until some data is available. When no data is available because -the asynchronous decoding hasn't caught up, MA_BUSY will be returned by +can instead load the sound asynchronously using the MA_RESOURCE_MANAGER_DATA_SOURCE_ASYNC flag. +This will result in ma_resource_manager_data_source_init() returning quickly, but no data will be +returned by ma_data_source_read_pcm_frames() until some data is available. When no data is +available because the asynchronous decoding hasn't caught up, MA_BUSY will be returned by ma_data_source_read_pcm_frames().

@@ -2926,7 +2926,7 @@ ma_fence_wait(&fence);

In the example above we used a fence for waiting until the entire file has been fully decoded. If -You only need to wait for the initialization of the internal decoder to complete, you can use the +you only need to wait for the initialization of the internal decoder to complete, you can use the init member of the ma_resource_manager_pipeline_notifications object:

@@ -3192,7 +3192,7 @@ it will return immediately. When frames are read from a data stream using ma_resource_manager_data_source_read_pcm_frames(), MA_BUSY will be returned if there are no frames available. If there are some frames available, but less than the number requested, MA_SUCCESS will be returned, but the actual number of frames -read will be less than the number requested. Due to the asymchronous nature of data streams, +read will be less than the number requested. Due to the asynchronous nature of data streams, seeking is also asynchronous. If the data stream is in the middle of a seek, MA_BUSY will be returned when trying to read frames.