mirror/miniaudio
1
0
Fork 0
mirror of https://github.com/mackron/miniaudio.git synced 2026-04-22 08:14:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Clarify scheduling of sound start times.

Browse Source
This commit is contained in:
David Reid
2022-03-02 05:56:18 +10:00
parent eebdd2960d
commit 0a214db53e
1 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
miniaudio.h
+10 -1
View File
@@ -400,7 +400,13 @@ the be started and/or stopped at a specific time. This can be done with the foll
The start/stop time needs to be specified based on the absolute timer which is controlled by the The start/stop time needs to be specified based on the absolute timer which is controlled by the
engine. The current global time time in PCM frames can be retrieved with `ma_engine_get_time()`. engine. The current global time time in PCM frames can be retrieved with `ma_engine_get_time()`.
The engine's global time can be changed with `ma_engine_set_time()` for synchronization purposes if The engine's global time can be changed with `ma_engine_set_time()` for synchronization purposes if
required. required. Note that scheduling a start time still requires an explicit call to `ma_sound_start()`
before anything will play:
```c
ma_sound_set_start_time_in_pcm_frames(&sound, ma_engine_get_time(&engine) + (ma_engine_get_sample_rate(&engine) * 2);
ma_sound_start(&sound);
```
The third parameter of `ma_sound_init_from_file()` is a set of flags that control how the sound be The third parameter of `ma_sound_init_from_file()` is a set of flags that control how the sound be
loaded and a few options on which features should be enabled for that sound. By default, the sound loaded and a few options on which features should be enabled for that sound. By default, the sound
@@ -1393,6 +1399,9 @@ can be useful to schedule a sound to start or stop:
ma_sound_set_stop_time_in_pcm_frames(&sound, ma_engine_get_time(&engine) + (ma_engine_get_sample_rate(&engine) * 2)); ma_sound_set_stop_time_in_pcm_frames(&sound, ma_engine_get_time(&engine) + (ma_engine_get_sample_rate(&engine) * 2));
``` ```
Note that scheduling a start time still requires an explicit call to `ma_sound_start()` before
anything will play.
The time is specified in global time which is controlled by the engine. You can get the engine's The time is specified in global time which is controlled by the engine. You can get the engine's
current time with `ma_engine_get_time()`. The engine's global time is incremented automatically as current time with `ma_engine_get_time()`. The engine's global time is incremented automatically as
audio data is read, but it can be reset with `ma_engine_set_time()` in case it needs to be audio data is read, but it can be reset with `ma_engine_set_time()` in case it needs to be