Update syscall description

maximecb · Sep 4, 2024 · 22422fb · 22422fb
1 parent 32a6d8f
commit 22422fb
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/api/syscalls.json b/api/syscalls.json
@@ -721,7 +721,7 @@
         ],
         "permission": "audio_output",
         "const_idx": 18,
-        "description": "Open an audio output device."
+        "description": "Open an audio output device, then spawn a new thread which will regularly call the specified callback function to generate audio samples."
       }
     ],
     "constants": [

diff --git a/doc/syscalls.md b/doc/syscalls.md
@@ -292,7 +292,7 @@ u32 audio_open_output(u32 sample_rate, u16 num_channels, u16 format, void* callb
 
 **Returns:** `u32 device_id`
 
-Open an audio output device.
+Open an audio output device, then spawn a new thread which will regularly call the specified callback function to generate audio samples.
 
 ## Constants
 These are the constants associated with the audio subsystem:

diff --git a/ncc/include/uvm/syscalls.h b/ncc/include/uvm/syscalls.h
@@ -90,7 +90,7 @@
 #define window_wait_event(__p_event) asm (__p_event) -> void { syscall window_wait_event; }
 
 // u32 audio_open_output(u32 sample_rate, u16 num_channels, u16 format, void* callback)
-// Open an audio output device.
+// Open an audio output device, then spawn a new thread which will regularly call the specified callback function to generate audio samples.
 #define audio_open_output(__sample_rate, __num_channels, __format, __callback) asm (__sample_rate, __num_channels, __format, __callback) -> u32 { syscall audio_open_output; }
 
 // u64 net_listen(const char* listen_addr, void* on_new_conn)