Skip to content

Commit 11a1171

Browse files
committed
new API docs in readme
1 parent 50616ea commit 11a1171

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,8 @@ with miniaudio.PlaybackDevice(output_format=miniaudio.SampleFormat.SIGNED16,
100100

101101
## API
102102

103-
104103
*enum class* ``Backend``
105-
names: ``WASAPI`` ``DSOUND`` ``WINMM`` ``COREAUDIO`` ``SNDIO`` ``AUDIO4`` ``OSS`` ``PULSEAUDIO`` ``ALSA`` ``JACK`` ``AAUDIO`` ``OPENSL`` ``WEBAUDIO`` ``NULL``
104+
names: ``WASAPI`` ``DSOUND`` ``WINMM`` ``COREAUDIO`` ``SNDIO`` ``AUDIO4`` ``OSS`` ``PULSEAUDIO`` ``ALSA`` ``JACK`` ``AAUDIO`` ``OPENSL`` ``WEBAUDIO`` ``CUSTOM`` ``NULL``
106105
> Operating system audio backend to use (only a subset will be available)
107106
108107

@@ -198,10 +197,28 @@ a fixed chunk size and cannot be used as a generic miniaudio decoder input strea
198197
stream_file() instead.
199198

200199

200+
*function* ``get_enabled_backends () -> Set[miniaudio.Backend]``
201+
> Returns the set of available backends by the compilation environment for the underlying miniaudio
202+
C library
203+
204+
201205
*function* ``get_file_info (filename: str) -> miniaudio.SoundFileInfo``
202206
> Fetch some information about the audio file.
203207
204208

209+
*function* ``is_backend_enabled (backend: miniaudio.Backend) -> bool``
210+
> Determines whether or not the given backend is available by the compilation environment for the
211+
underlying miniaudio C library
212+
213+
214+
*function* ``is_loopback_supported (backend: miniaudio.Backend) -> bool``
215+
> Determines whether or not loopback mode is support by a backend.
216+
217+
218+
*function* ``lib_version () -> str``
219+
> Returns the version string of the underlying miniaudio C library
220+
221+
205222
*function* ``mp3_get_file_info (filename: str) -> miniaudio.SoundFileInfo``
206223
> Fetch some information about the audio file (mp3 format).
207224

0 commit comments

Comments
 (0)