path: root/docs
diff options
authorSolomon Peachy <>2020-10-30 20:30:27 -0400
committerSolomon Peachy <>2020-10-31 01:18:27 +0000
commitfe2d52cc7d0180acff26349f2904fba854de6fbc (patch)
tree62dbbe9a6e6ebc011e8e02f7428b8f620a83f698 /docs
parent2d85c7215169780168032617603e9e7b06d7ba25 (diff)
pcm: Get rid of pcm_play_pause() and associated APIs
Nothing in the core has used it for some time. It's exported to the plugin API but the last plugins to use it were switched to the mixer API back in 2011. This allows us to get rid of pcm_play_dma_pause() from all audio drivers Change-Id: Ic3fa02592316f84963e41d792d1cabb436d1ff6b
Diffstat (limited to 'docs')
1 files changed, 1 insertions, 11 deletions
diff --git a/docs/PLUGIN_API b/docs/PLUGIN_API
index 84c203c05a..b77d25a4b9 100644
--- a/docs/PLUGIN_API
+++ b/docs/PLUGIN_API
@@ -1430,11 +1430,6 @@ void pcm_init_recording(void)
\conditions defined(HAVE_RECORDING)
-bool pcm_is_paused(void)
- \group sound
- \return true if playback is paused, else false
- \description
bool pcm_is_playing(void)
\group sound
\return true unless playback is paused
@@ -1451,14 +1446,9 @@ void pcm_play_lock(void)
\group sound
-void pcm_play_pause(bool play)
- \group sound
- \param play
- \description Pauses or unpauses the playback depending on the truth value of =play=
void pcm_play_stop(void)
\group sound
- \description Stops the playback and empties the audio buffer unlike [F[pcm_play_pause]]
+ \description Stops the playback and empties the audio buffer.
void pcm_play_unlock(void)
\group sound