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

Fix a documentation error.

Browse Source
This commit is contained in:
David Reid
2023-10-27 17:05:56 +10:00
parent 1d17b09e41
commit 2730775e79
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
miniaudio.h
+8 -1
View File
@@ -2675,9 +2675,16 @@ outputting any audio data. To output audio data, use `ma_encoder_write_pcm_frame
example below: example below:
```c ```c
framesWritten = ma_encoder_write_pcm_frames(&encoder, pPCMFramesToWrite, framesToWrite); ma_uint64 framesWritten;
result = ma_encoder_write_pcm_frames(&encoder, pPCMFramesToWrite, framesToWrite, &framesWritten);
if (result != MA_SUCCESS) {
... handle error ...
}
``` ```
The `framesWritten` variable will contain the number of PCM frames that were actually written. This
is optionally and you can pass in `NULL` if you need this.
Encoders must be uninitialized with `ma_encoder_uninit()`. Encoders must be uninitialized with `ma_encoder_uninit()`.