Commit cd3ed720 authored by Max Kellermann's avatar Max Kellermann

lib/alsa/AllowedFormat: add API documentation

parent 37c27fa6
......@@ -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);
};
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment