diff options
Diffstat (limited to 'docs/PLUGIN_API')
-rw-r--r-- | docs/PLUGIN_API | 88 |
1 files changed, 1 insertions, 87 deletions
diff --git a/docs/PLUGIN_API b/docs/PLUGIN_API index 768342bd80..b2fb94ed7e 100644 --- a/docs/PLUGIN_API +++ b/docs/PLUGIN_API | |||
@@ -810,25 +810,6 @@ enum yesno_res gui_syncyesno_run(const struct text_message * main_message, const | |||
810 | \return | 810 | \return |
811 | \description | 811 | \description |
812 | 812 | ||
813 | void i2c_begin(void) | ||
814 | \group MAS communication | ||
815 | \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)) && ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)) | ||
816 | \description | ||
817 | |||
818 | void i2c_end(void) | ||
819 | \group MAS communication | ||
820 | \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)) && ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)) | ||
821 | \description | ||
822 | |||
823 | int i2c_write(int address, const unsigned char* buf, int count ) | ||
824 | \group MAS communication | ||
825 | \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)) && ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)) | ||
826 | \param address | ||
827 | \param buf | ||
828 | \param count | ||
829 | \return | ||
830 | \description | ||
831 | |||
832 | void invalidate_icache(void) | 813 | void invalidate_icache(void) |
833 | \conditions (defined(CACHE_FUNCTIONS_AS_CALL)) | 814 | \conditions (defined(CACHE_FUNCTIONS_AS_CALL)) |
834 | \description | 815 | \description |
@@ -1433,56 +1414,6 @@ const unsigned long *rec_freq_sampr | |||
1433 | \return | 1414 | \return |
1434 | \description | 1415 | \description |
1435 | 1416 | ||
1436 | int mas_codec_readreg(int reg) | ||
1437 | \group MAS communication | ||
1438 | \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)) && ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)) | ||
1439 | \param reg | ||
1440 | \return | ||
1441 | \description | ||
1442 | |||
1443 | int mas_codec_writereg(int reg, unsigned int val) | ||
1444 | \group MAS communication | ||
1445 | \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)) && ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)) | ||
1446 | \param reg | ||
1447 | \param val | ||
1448 | \return | ||
1449 | \description | ||
1450 | |||
1451 | int mas_readmem(int bank, int addr, unsigned long* dest, int len) | ||
1452 | \group MAS communication | ||
1453 | \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)) | ||
1454 | \param bank | ||
1455 | \param addr | ||
1456 | \param dest | ||
1457 | \param len | ||
1458 | \return | ||
1459 | \description | ||
1460 | |||
1461 | int mas_readreg(int reg) | ||
1462 | \group MAS communication | ||
1463 | \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)) | ||
1464 | \param reg | ||
1465 | \return | ||
1466 | \description | ||
1467 | |||
1468 | int mas_writemem(int bank, int addr, const unsigned long* src, int len) | ||
1469 | \group MAS communication | ||
1470 | \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)) | ||
1471 | \param bank | ||
1472 | \param addr | ||
1473 | \param src | ||
1474 | \param len | ||
1475 | \return | ||
1476 | \description | ||
1477 | |||
1478 | int mas_writereg(int reg, unsigned int val) | ||
1479 | \group MAS communication | ||
1480 | \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)) | ||
1481 | \param reg | ||
1482 | \param val | ||
1483 | \return | ||
1484 | \description | ||
1485 | |||
1486 | void *memchr(const void *s1, int c, size_t n) | 1417 | void *memchr(const void *s1, int c, size_t n) |
1487 | \group strings and memory | 1418 | \group strings and memory |
1488 | \param s1 | 1419 | \param s1 |
@@ -1709,23 +1640,6 @@ void pcm_stop_recording(void) | |||
1709 | \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING)) | 1640 | \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING)) |
1710 | \description | 1641 | \description |
1711 | 1642 | ||
1712 | bool peak_meter_get_use_dbfs(void) | ||
1713 | \conditions ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)) | ||
1714 | \return 1 if the meter currently is displaying dBfs values, 0 if the meter is displaying percent values | ||
1715 | \description | ||
1716 | |||
1717 | unsigned short peak_meter_scale_value(unsigned short val, int meterwidth) | ||
1718 | \conditions ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)) | ||
1719 | \param val is the volume value (range: 0 <= val < MAX_PEAK) | ||
1720 | \param meterwidth is the width of the meter in pixel | ||
1721 | \return a value between 0 and meterwidth | ||
1722 | \description Scales a peak value as read from the MAS to the range of =meterwidth=. The scaling is performed according to the scaling method (dBfs / linear) and the range (peak_meter_range_min .. peak_meter_range_max). | ||
1723 | |||
1724 | void peak_meter_set_use_dbfs(bool use) | ||
1725 | \conditions ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)) | ||
1726 | \param use If =use= is 0 use linear percent scale, else use dBfs | ||
1727 | \description Specifies whether the values displayed are scaled as dBfs or as linear percent values | ||
1728 | |||
1729 | int playlist_amount(void) | 1643 | int playlist_amount(void) |
1730 | \group playback control | 1644 | \group playback control |
1731 | \return the number of tracks in current playlist | 1645 | \return the number of tracks in current playlist |
@@ -2208,7 +2122,7 @@ void sound_set(int setting, int value) | |||
2208 | 2122 | ||
2209 | void sound_set_pitch(int pitch) | 2123 | void sound_set_pitch(int pitch) |
2210 | \group playback control | 2124 | \group playback control |
2211 | \conditions ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F) || (CONFIG_CODEC == SWCODEC)) | 2125 | \conditions (CONFIG_CODEC == SWCODEC) |
2212 | \param pitch | 2126 | \param pitch |
2213 | \description | 2127 | \description |
2214 | 2128 | ||