summaryrefslogtreecommitdiff
path: root/docs/PLUGIN_API
diff options
context:
space:
mode:
authorSolomon Peachy <pizza@shaftnet.org>2020-10-30 20:30:27 -0400
committerSolomon Peachy <pizza@shaftnet.org>2020-10-31 01:18:27 +0000
commitfe2d52cc7d0180acff26349f2904fba854de6fbc (patch)
tree62dbbe9a6e6ebc011e8e02f7428b8f620a83f698 /docs/PLUGIN_API
parent2d85c7215169780168032617603e9e7b06d7ba25 (diff)
downloadrockbox-fe2d52cc7d0180acff26349f2904fba854de6fbc.tar.gz
rockbox-fe2d52cc7d0180acff26349f2904fba854de6fbc.zip
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/PLUGIN_API')
-rw-r--r--docs/PLUGIN_API12
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)
1430 \conditions defined(HAVE_RECORDING) 1430 \conditions defined(HAVE_RECORDING)
1431 \description 1431 \description
1432 1432
1433bool pcm_is_paused(void)
1434 \group sound
1435 \return true if playback is paused, else false
1436 \description
1437
1438bool pcm_is_playing(void) 1433bool pcm_is_playing(void)
1439 \group sound 1434 \group sound
1440 \return true unless playback is paused 1435 \return true unless playback is paused
@@ -1451,14 +1446,9 @@ void pcm_play_lock(void)
1451 \group sound 1446 \group sound
1452 \description 1447 \description
1453 1448
1454void pcm_play_pause(bool play)
1455 \group sound
1456 \param play
1457 \description Pauses or unpauses the playback depending on the truth value of =play=
1458
1459void pcm_play_stop(void) 1449void pcm_play_stop(void)
1460 \group sound 1450 \group sound
1461 \description Stops the playback and empties the audio buffer unlike [F[pcm_play_pause]] 1451 \description Stops the playback and empties the audio buffer.
1462 1452
1463void pcm_play_unlock(void) 1453void pcm_play_unlock(void)
1464 \group sound 1454 \group sound