diff options
author | Lennart Poettering <lennart@poettering.net> | 2008-08-28 17:52:08 +0200 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2008-08-28 17:52:08 +0200 |
commit | f79c66581292fc76160e29c7e713354cb8037270 (patch) | |
tree | 7966ef6bc13f1159c273e1f1d2655cc2e31de6c7 /src/pulse/sample.h | |
parent | 3d07cc8112d693922b176c9dc6bf0fbc6b58a02c (diff) |
document in which direction we round
Diffstat (limited to 'src/pulse/sample.h')
-rw-r--r-- | src/pulse/sample.h | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/src/pulse/sample.h b/src/pulse/sample.h index 2680cf7e..7061272c 100644 --- a/src/pulse/sample.h +++ b/src/pulse/sample.h @@ -183,10 +183,14 @@ size_t pa_frame_size(const pa_sample_spec *spec) PA_GCC_PURE; /** Return the size of a sample with the specific sample type */ size_t pa_sample_size(const pa_sample_spec *spec) PA_GCC_PURE; -/** Calculate the time the specified bytes take to play with the specified sample type */ +/** Calculate the time the specified bytes take to play with the + * specified sample type. The return value will always be rounded + * down for non-integral return values. */ pa_usec_t pa_bytes_to_usec(uint64_t length, const pa_sample_spec *spec) PA_GCC_PURE; -/** Calculates the number of bytes that are required for the specified time. \since 0.9 */ +/** Calculates the number of bytes that are required for the specified + * time. The return value will always be rounded down for non-integral + * return values. \since 0.9 */ size_t pa_usec_to_bytes(pa_usec_t t, const pa_sample_spec *spec) PA_GCC_PURE; /** Return non-zero when the sample type specification is valid */ |