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

Update documentation.

Browse Source
This commit is contained in:
David Reid
2020-02-08 18:29:39 +10:00
parent 2dd4e63210
commit b85e34cbb2
1 changed files with 54 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
miniaudio.h
+54 -21
View File
@@ -1803,7 +1803,6 @@ ma_result ma_channel_converter_process_pcm_frames(ma_channel_converter* pConvert
/************************************************************************************************************************************************************** /**************************************************************************************************************************************************************
Data Conversion Data Conversion
===============
**************************************************************************************************************************************************************/ **************************************************************************************************************************************************************/
typedef struct typedef struct
@@ -2323,43 +2322,77 @@ typedef struct
/* /*
The callback for processing audio data from the device. The callback for processing audio data from the device.
pOutput is a pointer to a buffer that will receive audio data that will later be played back through the speakers. This will be non-null The data callback is fired by miniaudio whenever the device needs to have more data delivered to a playback device, or when a capture device has some data
for a playback or full-duplex device and null for a capture device. available. This is called as soon as the backend asks for more data which means it may be called with inconsistent frame counts. You cannot assume the
callback will be fired with a consistent frame count.
pInput is a pointer to a buffer containing input data from the device. This will be non-null for a capture or full-duplex device, and Parameters
null for a playback device. ----------
pDevice (in)
A pointer to the relevant device.
frameCount is the number of PCM frames to process. If an output buffer is provided (pOutput is not null), applications should write out pOutput (out)
to the entire output buffer. Note that frameCount will not necessarily be exactly what you asked for when you initialized the deviced. A pointer to the output buffer that will receive audio data that will later be played back through the speakers. This will be non-null for a playback or
The bufferSizeInFrames and bufferSizeInMilliseconds members of the device config are just hints, and are not necessarily exactly what full-duplex device and null for a capture and loopback device.
you'll get.
Do _not_ call any miniaudio APIs from the callback. Attempting the stop the device can result in a deadlock. The proper way to stop the pInput (in)
device is to call ma_device_stop() from a different thread, normally the main application thread. A pointer to the buffer containing input data from a recording device. This will be non-null for a capture, full-duplex or loopback device and null for a
playback device.
frameCount (in)
The number of PCM frames to process. Note that this will not necessarily be equal to what you requested when you initialized the device. The
`bufferSizeInFrames` and `bufferSizeInMilliseconds` members of the device config are just hints, and are not necessarily exactly what you'll get. You must
not assume this will always be the same value each time the callback is fired.
Remarks
-------
You cannot stop and start the device from inside the callback or else you'll get a deadlock. You must also not uninitialize the device from inside the
callback. The following APIs cannot be called from inside the callback:
ma_device_init()
ma_device_init_ex()
ma_device_uninit()
ma_device_start()
ma_device_stop()
The proper way to stop the device is to call `ma_device_stop()` from a different thread, normally the main application thread.
*/ */
typedef void (* ma_device_callback_proc)(ma_device* pDevice, void* pOutput, const void* pInput, ma_uint32 frameCount); typedef void (* ma_device_callback_proc)(ma_device* pDevice, void* pOutput, const void* pInput, ma_uint32 frameCount);
/* /*
The callback for when the device has been stopped. The callback for when the device has been stopped.
This will be called when the device is stopped explicitly with ma_device_stop() and also called implicitly when the device is stopped This will be called when the device is stopped explicitly with `ma_device_stop()` and also called implicitly when the device is stopped through external forces
through external forces such as being unplugged or an internal error occuring. such as being unplugged or an internal error occuring.
Do not restart the device from the callback. Do not restart or uninitialize the device from the callback.
*/ */
typedef void (* ma_stop_proc)(ma_device* pDevice); typedef void (* ma_stop_proc)(ma_device* pDevice);
/* /*
The callback for handling log messages. The callback for handling log messages.
It is possible for pDevice to be null in which case the log originated from the context. If it is non-null you can assume the message Parameters
came from the device. ----------
pContext (in)
A pointer to the context the log message originated from.
logLevel is one of the following: pDevice (in)
MA_LOG_LEVEL_VERBOSE A pointer to the device the log message originate from, if any. This can be null, in which case the message came from the context.
MA_LOG_LEVEL_INFO
MA_LOG_LEVEL_WARNING logLevel (in)
MA_LOG_LEVEL_ERROR The log level. This can be one of the following:
MA_LOG_LEVEL_VERBOSE
MA_LOG_LEVEL_INFO
MA_LOG_LEVEL_WARNING
MA_LOG_LEVEL_ERROR
message (in)
The log message.
Remarks
-------
Do not modify the state of the device from inside the callback.
*/ */
typedef void (* ma_log_proc)(ma_context* pContext, ma_device* pDevice, ma_uint32 logLevel, const char* message); typedef void (* ma_log_proc)(ma_context* pContext, ma_device* pDevice, ma_uint32 logLevel, const char* message);