From d8c03a124acb26d34e501f1a50a0ce7eeba493a8 Mon Sep 17 00:00:00 2001 From: trialuser02 Date: Sat, 1 Aug 2015 09:37:11 +0000 Subject: updated api documentation git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@5296 90c681e8-e032-0410-971d-27865f9a5e38 --- src/qmmp/audioparameters.h | 3 +++ src/qmmp/decoder.h | 7 ++++++- src/qmmpui/metadataformatter.h | 9 +++++++-- 3 files changed, 16 insertions(+), 3 deletions(-) (limited to 'src') diff --git a/src/qmmp/audioparameters.h b/src/qmmp/audioparameters.h index 94e113eca..ac229af6b 100644 --- a/src/qmmp/audioparameters.h +++ b/src/qmmp/audioparameters.h @@ -66,6 +66,9 @@ public: * Returns number of channels. */ int channels() const; + /*! + * Returns channel map. + */ const ChannelMap channelMap() const; /*! * Returns pcm format. diff --git a/src/qmmp/decoder.h b/src/qmmp/decoder.h index 38c65967c..59e461327 100644 --- a/src/qmmp/decoder.h +++ b/src/qmmp/decoder.h @@ -179,7 +179,12 @@ protected: * @param f Audio format. */ void configure(quint32 srate, const ChannelMap &map, Qmmp::AudioFormat f = Qmmp::PCM_S16LE); - + /*! + * Use this function inside initialize() reimplementation to tell other plugins about audio parameters. + * @param srate Sample rate. + * @param channels Number of channels (internal channel sequence). + * @param f Audio format. + */ void configure(quint32 srate, int channels, Qmmp::AudioFormat f = Qmmp::PCM_S16LE); private: diff --git a/src/qmmpui/metadataformatter.h b/src/qmmpui/metadataformatter.h index 2ea6ce045..8f841ba9f 100644 --- a/src/qmmpui/metadataformatter.h +++ b/src/qmmpui/metadataformatter.h @@ -55,9 +55,14 @@ public: * %if(A,B,C) or %if(A&B&C,D,E) - condition. */ MetaDataFormatter(const QString &pattern = QString()); - + /*! + * Setups metadata template. + * @param pattern Metadata template string. + */ void setPattern(const QString &pattern); - + /*! + * Returns metadata template. + */ const QString pattern() const; /*! -- cgit v1.2.3-13-gbd6f