Filter: update API documentation

This commit is contained in:
Max Kellermann 2014-08-12 16:05:37 +02:00
parent c94b4466d5
commit 4d5f610029

View File

@ -38,7 +38,7 @@ public:
* Opens the filter, preparing it for FilterPCM(). * Opens the filter, preparing it for FilterPCM().
* *
* @param filter the filter object * @param filter the filter object
* @param audio_format the audio format of incoming data; the * @param af the audio format of incoming data; the
* plugin may modify the object to enforce another input * plugin may modify the object to enforce another input
* format * format
* @param error location to store the error occurring, or nullptr * @param error location to store the error occurring, or nullptr
@ -63,7 +63,7 @@ public:
* @param error location to store the error occurring, or nullptr * @param error location to store the error occurring, or nullptr
* to ignore errors. * to ignore errors.
* @return the destination buffer on success (will be * @return the destination buffer on success (will be
* invalidated by filter_close() or filter_filter()), nullptr on * invalidated by Close() or FilterPCM()), nullptr on
* error * error
*/ */
virtual const void *FilterPCM(const void *src, size_t src_size, virtual const void *FilterPCM(const void *src, size_t src_size,