extend documentation for pa_channel_map_init()

[pulseaudio] / src / pulse / channelmap.h

diff --git a/src/pulse/channelmap.h b/src/pulse/channelmap.h
index 035f9b1a1c8ed902e698149dc7fa4bd37d19b5ff..8ea3daec49b92edbb6ea7118f2981dfb39739cda 100644 (file)
--- a/src/pulse/channelmap.h
+++ b/src/pulse/channelmap.h
@@ -157,6 +157,9 @@ typedef enum pa_channel_map_def {
     PA_CHANNEL_MAP_OSS,
     /**< The default channel mapping used by OSS as defined in the OSS 4.0 API specs */
 
+    /**< Upper limit of valid channel mapping definitions */
+    PA_CHANNEL_MAP_DEF_MAX,
+
     PA_CHANNEL_MAP_DEFAULT = PA_CHANNEL_MAP_AIFF
     /**< The default channel map */
 } pa_channel_map_def_t;
@@ -172,7 +175,9 @@ typedef struct pa_channel_map {
     /**< Channel labels */
 } pa_channel_map;
 
-/** Initialize the specified channel map and return a pointer to it */
+/** Initialize the specified channel map and return a pointer to
+ * it. The channel map will have a defined state but
+ * pa_channel_map_valid() will fail for it. */
 pa_channel_map* pa_channel_map_init(pa_channel_map *m);
 
 /** Initialize the specified channel map for monoaural audio and return a pointer to it */
@@ -211,7 +216,7 @@ pa_channel_map *pa_channel_map_parse(pa_channel_map *map, const char *s);
 /** Compare two channel maps. Return 1 if both match. */
 int pa_channel_map_equal(const pa_channel_map *a, const pa_channel_map *b) PA_GCC_PURE;
 
-/** Return non-zero of the specified channel map is considered valid */
+/** Return non-zero if the specified channel map is considered valid */
 int pa_channel_map_valid(const pa_channel_map *map) PA_GCC_PURE;
 
 /** Return non-zero if the specified channel map is compatible with