summaryrefslogtreecommitdiff
path: root/include/kitchensink/kitcodec.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/kitchensink/kitcodec.h')
-rw-r--r--include/kitchensink/kitcodec.h13
1 files changed, 12 insertions, 1 deletions
diff --git a/include/kitchensink/kitcodec.h b/include/kitchensink/kitcodec.h
index 76b53a4..589f84d 100644
--- a/include/kitchensink/kitcodec.h
+++ b/include/kitchensink/kitcodec.h
@@ -1,6 +1,14 @@
#ifndef KITCODEC_H
#define KITCODEC_H
+/**
+ * @brief Codec type
+ *
+ * @file kitcodec.h
+ * @author Tuomas Virtanen
+ * @date 2018-06-25
+ */
+
#ifdef __cplusplus
extern "C" {
#endif
@@ -8,8 +16,11 @@ extern "C" {
#define KIT_CODEC_NAME_MAX 8
#define KIT_CODEC_DESC_MAX 48
+/**
+ * @brief Contains information about the used codec for playback
+ */
typedef struct Kit_Codec {
- unsigned int threads; ///< Currently enabled threads
+ unsigned int threads; ///< Currently enabled threads (For all decoders)
char name[KIT_CODEC_NAME_MAX]; ///< Codec short name, eg. "ogg" or "webm"
char description[KIT_CODEC_DESC_MAX]; ///< Codec longer, more descriptive name
} Kit_Codec;