Merge commit 'fml/master' into next
[paraslash.git] / vss.h
diff --git a/vss.h b/vss.h
index efabdf3..9bdc449 100644 (file)
--- a/vss.h
+++ b/vss.h
@@ -23,8 +23,6 @@ const char *supported_audio_formats(void);
 #define VSS_REPOS 4
 /** Currently playing. */
 #define VSS_PLAYING 8
-/** A client requested to change the audio file selector. */
-#define VSS_CHANGE 16
 
 /**
  * Each paraslash sender may register arbitrary many clients to the virtual
@@ -38,11 +36,17 @@ const char *supported_audio_formats(void);
  */
 struct fec_client;
 
+/** FEC parameters requested by FEC clients. */
 struct fec_client_parms {
+       /** Number of data slices plus redundant slices. */
        uint8_t slices_per_group;
+       /** Number of slices minus number of redundant slices. */
        uint8_t data_slices_per_group;
+       /** Maximal number of bytes per slice. */
        uint16_t max_slice_bytes;
+       /** Called by vss.c when the next slice should be sent. */
        int (*send)(char *buf, size_t num_bytes, void *private_data);
+       /** Passed verbatim to \a send(). */
        void *private_data;
 };