This is an automated email from the ASF dual-hosted git repository.

GUIDINGLI pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git

commit 693be6bee41202a56572176ea8665f2b5aafed79
Author: fangyibo <[email protected]>
AuthorDate: Tue Nov 10 10:47:46 2026 +0800

    Documentation/audio: describe AUDIOIOC_DUMP
    
    Document what AUDIOIOC_DUMP records, how to stop it, and that buffers
    returned in interrupt context are not recorded.
    
    Assisted-by: Kiro:claude-opus-5-5
    Signed-off-by: fangyibo <[email protected]>
---
 Documentation/os/audio/index.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/Documentation/os/audio/index.rst b/Documentation/os/audio/index.rst
index 187753035ff..8008d800f52 100644
--- a/Documentation/os/audio/index.rst
+++ b/Documentation/os/audio/index.rst
@@ -260,6 +260,17 @@ Status and Notification
   Register, respectively remove, the message queue on which the driver reports
   ``AUDIO_MSG_DEQUEUE``, ``AUDIO_MSG_COMPLETE`` and error events.
 
+Debugging
+---------
+
+* ``AUDIOIOC_DUMP``
+  Record the data passing through the device.  The argument is a file path;
+  the upper half creates the file and writes every buffer the lower half
+  returns into it: the samples a playback buffer carried, or the samples a
+  capture buffer received.  A ``NULL`` argument stops the recording.  Buffers
+  returned in interrupt context are not recorded, since writing a file may
+  block.
+
 Multiple Applications
 =====================
 

Reply via email to