summaryrefslogtreecommitdiff
path: root/docs/PLUGIN_API
diff options
context:
space:
mode:
Diffstat (limited to 'docs/PLUGIN_API')
-rw-r--r--docs/PLUGIN_API41
1 files changed, 8 insertions, 33 deletions
diff --git a/docs/PLUGIN_API b/docs/PLUGIN_API
index 1febe9fdf4..84c203c05a 100644
--- a/docs/PLUGIN_API
+++ b/docs/PLUGIN_API
@@ -402,7 +402,7 @@ int count_mp3_frames(int fd, int startpos, int filesize, void (*progressfunc)(in
402 \description 402 \description
403 403
404void cpu_boost(bool on_off) 404void cpu_boost(bool on_off)
405 \conditions (!defined(SIMULATOR)) && (defined(HAVE_ADJUSTABLE_CPU_FREQ)) && !defined(CPU_BOOST_LOGGING) 405 \conditions (!defined(SIMULATOR)) && (defined(HAVE_ADJUSTABLE_CPU_FREQ)) && !defined(CPU_BOOST_LOGGING)
406 \param on_off 406 \param on_off
407 \description Boosts the CPU if =on_off= is true, otherwise it unboosts the CPU 407 \description Boosts the CPU if =on_off= is true, otherwise it unboosts the CPU
408 408
@@ -1368,31 +1368,6 @@ bool mp3info(struct mp3entry *entry, const char *filename)
1368 \return FALSE if successfull 1368 \return FALSE if successfull
1369 \description The given =entry= is filled in with whatever id3 info it could find about the given =filename= 1369 \description The given =entry= is filled in with whatever id3 info it could find about the given =filename=
1370 1370
1371bool mp3_is_playing(void)
1372 \group sound
1373 \conditions (!defined(SIMULATOR))
1374 \return true if an mp3 is playing, else return false
1375 \description Note: a paused mp3 is considered as a playing mp3
1376
1377void mp3_play_data(const unsigned char* start, int size, void (*get_more)(unsigned char** start, size_t* size))
1378 \group sound
1379 \conditions (!defined(SIMULATOR))
1380 \param start points to the begining of the file to play
1381 \param size is the size to play
1382 \param get_more is a callback function
1383 \description Plays a chunk of an mp3 file
1384
1385void mp3_play_pause(bool play)
1386 \group sound
1387 \conditions (!defined(SIMULATOR))
1388 \param play
1389 \description If playback was paused and =play= is TRUE, resume playback. If playback isn't paused and =play= is FALSE, pause playback.
1390
1391void mp3_play_stop(void)
1392 \group sound
1393 \conditions (!defined(SIMULATOR))
1394 \description Stops playback
1395
1396void mutex_init(struct mutex *m) 1371void mutex_init(struct mutex *m)
1397 \group kernel/ system 1372 \group kernel/ system
1398 \param m 1373 \param m
@@ -1470,7 +1445,7 @@ void pcm_play_data(pcm_more_callback_type get_more, unsigned char* start, size_t
1470 \param get_more Optional callback 1445 \param get_more Optional callback
1471 \param start is the address of raw 16-16, interleaved PCM data 1446 \param start is the address of raw 16-16, interleaved PCM data
1472 \param size is the size of the data to play 1447 \param size is the size of the data to play
1473 \description May be used without the callback parameter in order to play a single clip. If you wish to play sound continuously, then use the callback instead and return the buffer address and size to be played from that callback. Every time that a buffer is played out, the callback is asked for the next buffer to play but without stopping and starting playback. The callback is called asynchronously in interrupt context so what you may do in there is limited. 1448 \description May be used without the callback parameter in order to play a single clip. If you wish to play sound continuously, then use the callback instead and return the buffer address and size to be played from that callback. Every time that a buffer is played out, the callback is asked for the next buffer to play but without stopping and starting playback. The callback is called asynchronously in interrupt context so what you may do in there is limited.
1474 1449
1475void pcm_play_lock(void) 1450void pcm_play_lock(void)
1476 \group sound 1451 \group sound
@@ -2031,8 +2006,8 @@ struct gui_syncstatusbar *statusbars
2031 2006
2032int strcasecmp(const char *, const char *) 2007int strcasecmp(const char *, const char *)
2033 \group strings and memory 2008 \group strings and memory
2034 \param 2009 \param
2035 \param 2010 \param
2036 \return an integer less than, equal to, or greater than zero if s1 is found, respectively, to be less than, to match, or be greater than s2 2011 \return an integer less than, equal to, or greater than zero if s1 is found, respectively, to be less than, to match, or be greater than s2
2037 \description The strcasecmp() function compares the two strings s1 and s2, ignoring the case of the characters 2012 \description The strcasecmp() function compares the two strings s1 and s2, ignoring the case of the characters
2038 2013
@@ -2052,8 +2027,8 @@ char *strchr(const char *s, int c)
2052 2027
2053int strcmp(const char *, const char *) 2028int strcmp(const char *, const char *)
2054 \group strings and memory 2029 \group strings and memory
2055 \param 2030 \param
2056 \param 2031 \param
2057 \return 2032 \return
2058 \description strcmp() compares the string a to string b. If a sorts lexicographically after b, strcmp returns a number greater than zero. If the two strings match, strcmp returns zero. If a sorts lexicographically before b, strcmp returns a number less than zero. 2033 \description strcmp() compares the string a to string b. If a sorts lexicographically after b, strcmp returns a number greater than zero. If the two strings match, strcmp returns zero. If a sorts lexicographically before b, strcmp returns a number less than zero.
2059 2034
@@ -2081,8 +2056,8 @@ int strncasecmp(const char *s1, const char *s2, size_t n)
2081 2056
2082int strncmp(const char *, const char *, size_t) 2057int strncmp(const char *, const char *, size_t)
2083 \group strings and memory 2058 \group strings and memory
2084 \param 2059 \param
2085 \param 2060 \param
2086 \param size_t 2061 \param size_t
2087 \return 2062 \return
2088 \description 2063 \description