]> code.delx.au - pulseaudio/commitdiff
stream: Mention pa_stream_new_extended() in the high-level stream creation documentation
authorTanu Kaskinen <tanu.kaskinen@linux.intel.com>
Wed, 4 Dec 2013 04:18:42 +0000 (06:18 +0200)
committerTanu Kaskinen <tanu.kaskinen@linux.intel.com>
Wed, 8 Jan 2014 19:32:02 +0000 (21:32 +0200)
src/pulse/stream.h

index bec668fc76ca98626b8a1dc8e508b9a7b8fd7212..49f5789ad922c64452d0e487e2fdb0e97b580ea8 100644 (file)
  * \section create_sec Creating
  *
  * To access a stream, a pa_stream object must be created using
- * pa_stream_new(). At this point the audio sample format and mapping of
- * channels must be specified. See \ref sample and \ref channelmap for more
- * information about those structures.
+ * pa_stream_new() or pa_stream_new_extended(). pa_stream_new() is for PCM
+ * streams only, while pa_stream_new_extended() can be used for both PCM and
+ * compressed audio streams. At this point the application must specify what
+ * stream format(s) it supports. See \ref sample and \ref channelmap for more
+ * information on the stream format parameters. FIXME: Those references only
+ * talk about PCM parameters, we should also have an overview page for how the
+ * pa_format_info based stream format configuration works. Bug filed:
+ * https://bugs.freedesktop.org/show_bug.cgi?id=72265
  *
  * This first step will only create a client-side object, representing the
  * stream. To use the stream, a server-side object must be created and