summaryrefslogtreecommitdiffstats
path: root/src/polyp/sample.h
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2006-02-20 17:09:39 +0000
committerLennart Poettering <lennart@poettering.net>2006-02-20 17:09:39 +0000
commit98cb6aa4a30a993ddf2c15f0a03cb4d94383d4d9 (patch)
treef55eec2774433bba2fa065260f60ced629a17b43 /src/polyp/sample.h
parent71e063a69533fedc283c55eed735332e5b00713e (diff)
* a lot of doxygen updates
* s/pa_operation_callback/pa_operation_callback_t/g * add more typedefs for function prototypes * add API to query the channel map used by a pa_stream git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@530 fefdeb5f-60dc-0310-8127-8f9354f1896f
Diffstat (limited to 'src/polyp/sample.h')
-rw-r--r--src/polyp/sample.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/polyp/sample.h b/src/polyp/sample.h
index c1b98f1c..db4c6c70 100644
--- a/src/polyp/sample.h
+++ b/src/polyp/sample.h
@@ -33,7 +33,7 @@
PA_C_DECL_BEGIN
-/* Maximum allowed channels */
+/** Maximum allowed channels */
#define PA_CHANNELS_MAX 16
/** Sample format */
@@ -43,8 +43,8 @@ typedef enum pa_sample_format {
PA_SAMPLE_ULAW, /**< 8 Bit mu-Law */
PA_SAMPLE_S16LE, /**< Signed 16 Bit PCM, little endian (PC) */
PA_SAMPLE_S16BE, /**< Signed 16 Bit PCM, big endian */
- PA_SAMPLE_FLOAT32LE, /**< 32 Bit IEEE floating point, little endian, range -1..1 */
- PA_SAMPLE_FLOAT32BE, /**< 32 Bit IEEE floating point, big endian, range -1..1 */
+ PA_SAMPLE_FLOAT32LE, /**< 32 Bit IEEE floating point, little endian, range -1 to 1 */
+ PA_SAMPLE_FLOAT32BE, /**< 32 Bit IEEE floating point, big endian, range -1 to 1 */
PA_SAMPLE_MAX, /**< Upper limit of valid sample types */
PA_SAMPLE_INVALID = -1 /**< An invalid value */
} pa_sample_format_t;
@@ -100,7 +100,7 @@ int pa_sample_spec_valid(const pa_sample_spec *spec);
/** Return non-zero when the two sample type specifications match */
int pa_sample_spec_equal(const pa_sample_spec*a, const pa_sample_spec*b);
-/* Return a descriptive string for the specified sample format. \since 0.8 */
+/** Return a descriptive string for the specified sample format. \since 0.8 */
const char *pa_sample_format_to_string(pa_sample_format_t f);
/** Parse a sample format text. Inverse of pa_sample_format_to_string() */