Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
M
miniaudio
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Packages
Packages
List
Container Registry
Analytics
Analytics
CI / CD
Code Review
Insights
Issues
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
MyCard
miniaudio
Commits
87bae569
Commit
87bae569
authored
Sep 10, 2025
by
David Reid
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fix typos in the documentation.
parent
293f5de1
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
6 additions
and
6 deletions
+6
-6
miniaudio.h
miniaudio.h
+6
-6
No files found.
miniaudio.h
View file @
87bae569
...
@@ -14,7 +14,7 @@ GitHub: https://github.com/mackron/miniaudio
...
@@ -14,7 +14,7 @@ GitHub: https://github.com/mackron/miniaudio
===============
===============
To use miniaudio, just include "miniaudio.h" like any other header and add "miniaudio.c" to your
To use miniaudio, just include "miniaudio.h" like any other header and add "miniaudio.c" to your
source tree. If you don't want to add it to your source tree you can compile and link to it like
source tree. If you don't want to add it to your source tree you can compile and link to it like
any other library. Note that ABI compatiblity is not guaranteed between versions, even with bug
any other library. Note that ABI compatib
i
lity is not guaranteed between versions, even with bug
fix releases, so take care if compiling as a shared object.
fix releases, so take care if compiling as a shared object.
miniaudio includes both low level and high level APIs. The low level API is good for those who want
miniaudio includes both low level and high level APIs. The low level API is good for those who want
...
@@ -295,7 +295,7 @@ The engine encapsulates both the resource manager and the node graph to create a
...
@@ -295,7 +295,7 @@ The engine encapsulates both the resource manager and the node graph to create a
use high level API. The resource manager and node graph APIs are covered in more later sections of
use high level API. The resource manager and node graph APIs are covered in more later sections of
this manual.
this manual.
The code below shows how you can initialize an engine using it
'
s default configuration.
The code below shows how you can initialize an engine using its default configuration.
```c
```c
ma_result result;
ma_result result;
...
@@ -383,7 +383,7 @@ Sounds are not started by default. Start a sound with `ma_sound_start()` and sto
...
@@ -383,7 +383,7 @@ Sounds are not started by default. Start a sound with `ma_sound_start()` and sto
`ma_sound_stop()`. When a sound is stopped, it is not rewound to the start. Use
`ma_sound_stop()`. When a sound is stopped, it is not rewound to the start. Use
`ma_sound_seek_to_pcm_frame(&sound, 0)` to seek back to the start of a sound. By default, starting
`ma_sound_seek_to_pcm_frame(&sound, 0)` to seek back to the start of a sound. By default, starting
and stopping sounds happens immediately, but sometimes it might be convenient to schedule the sound
and stopping sounds happens immediately, but sometimes it might be convenient to schedule the sound
t
he
be started and/or stopped at a specific time. This can be done with the following functions:
t
o
be started and/or stopped at a specific time. This can be done with the following functions:
```c
```c
ma_sound_set_start_time_in_pcm_frames()
ma_sound_set_start_time_in_pcm_frames()
...
@@ -529,7 +529,7 @@ you'll need to disable run-time linking with `MA_NO_RUNTIME_LINKING` and link wi
...
@@ -529,7 +529,7 @@ you'll need to disable run-time linking with `MA_NO_RUNTIME_LINKING` and link wi
The Emscripten build emits Web Audio JavaScript directly and should compile cleanly out of the box.
The Emscripten build emits Web Audio JavaScript directly and should compile cleanly out of the box.
You cannot use `-std=c*` compiler flags, nor `-ansi`.
You cannot use `-std=c*` compiler flags, nor `-ansi`.
You can enable the use of AudioWorkets by defining `MA_ENABLE_AUDIO_WORKLETS` and then compiling
You can enable the use of AudioWork
l
ets by defining `MA_ENABLE_AUDIO_WORKLETS` and then compiling
with the following options:
with the following options:
-sAUDIO_WORKLET=1 -sWASM_WORKERS=1 -sASYNCIFY
-sAUDIO_WORKLET=1 -sWASM_WORKERS=1 -sASYNCIFY
...
@@ -878,7 +878,7 @@ read data within a certain range of the underlying data. To do this you can use
...
@@ -878,7 +878,7 @@ read data within a certain range of the underlying data. To do this you can use
This is useful if you have a sound bank where many sounds are stored in the same file and you want
This is useful if you have a sound bank where many sounds are stored in the same file and you want
the data source to only play one of those sub-sounds. Note that once the range is set, everything
the data source to only play one of those sub-sounds. Note that once the range is set, everything
that takes a position, such as cursors and loop points, should always be relat
vi
e to the start of
that takes a position, such as cursors and loop points, should always be relat
iv
e to the start of
the range. When the range is set, any previously defined loop point will be reset.
the range. When the range is set, any previously defined loop point will be reset.
Custom loop points can also be used with data sources. By default, data sources will loop after
Custom loop points can also be used with data sources. By default, data sources will loop after
...
@@ -886,7 +886,7 @@ they reach the end of the data source, but if you need to loop at a specific loc
...
@@ -886,7 +886,7 @@ they reach the end of the data source, but if you need to loop at a specific loc
the following:
the following:
```c
```c
result = ma_data_set_loop_point_in_pcm_frames(pDataSource, loopBegInFrames, loopEndInFrames);
result = ma_data_s
ource_s
et_loop_point_in_pcm_frames(pDataSource, loopBegInFrames, loopEndInFrames);
if (result != MA_SUCCESS) {
if (result != MA_SUCCESS) {
return result; // Failed to set the loop point.
return result; // Failed to set the loop point.
}
}
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment