summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsanine <sanine.not@pm.me>2022-09-05 19:57:38 -0500
committersanine <sanine.not@pm.me>2022-09-05 19:57:38 -0500
commitad468a64f20d82b15fe3512bdea7914a20cac283 (patch)
treeb84a4d8e9a7dfde0cc64c378b33a38fec2ada259
parentbe94297366c4a016a23f428613f65da0957df1b4 (diff)
add mossrose_channel_stop documentation to READMEHEADmain
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3424af7..070ddb4 100644
--- a/README.md
+++ b/README.md
@@ -107,6 +107,17 @@ Resume a channel.
This function has no effect if the channel is already playing.
+### `void mossrose_channel_stop(int channel)` ###
+
+Stop a channel.
+
+ * `channel` - the index of the channel.
+
+Stopped channels cannot be resumed and are made available for new samples to
+be loaded into them.
+
+
+
### `void mossrose_channel_set_callback(int channel, mossrose_channel_callback_t callback, void *userdata)` ###
Set a callback to run each time playback of audio on a channel completes.