oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

lib/alsa/AllowedFormat: add API documentation

Browse Source
This commit is contained in:
Max Kellermann 2017-12-19 08:26:06 +01:00
parent 37c27fa606
commit cd3ed720e0
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/lib/alsa/AllowedFormat.hxx
View File

@ -29,14 +29,28 @@ struct StringView;
namespace Alsa {
/**
* An audio format for the "allowed_formats" setting of
* #AlsaOutputPlugin.
*/
struct AllowedFormat {
AudioFormat format;
#ifdef ENABLE_DSD
bool dop;
#endif
/**
* Parse a format string.
*
* Throws std::runtime_error on error.
*/
explicit AllowedFormat(StringView s);
/**
* Parse a list of formats separated by space.
*
* Throws std::runtime_error on error.
*/
static std::forward_list<AllowedFormat> ParseList(StringView s);
};