diff options
| author | Tanu Kaskinen <tanu.kaskinen@linux.intel.com> | 2013-12-04 06:18:42 +0200 |
|---|---|---|
| committer | Tanu Kaskinen <tanu.kaskinen@linux.intel.com> | 2014-01-08 21:32:02 +0200 |
| commit | fdf72d3d21b7e8d88aac283293359c04b4877c77 (patch) | |
| tree | 5e199265bd01c0240c8c2cd6af27467cdd7bd2fa | |
| parent | a36bf31cae89594b3d56f3264b85fded763fd567 (diff) | |
stream: Mention pa_stream_new_extended() in the high-level stream creation documentation
| -rw-r--r-- | src/pulse/stream.h | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/src/pulse/stream.h b/src/pulse/stream.h index bec668fc..49f5789a 100644 --- a/src/pulse/stream.h +++ b/src/pulse/stream.h @@ -52,9 +52,14 @@ * \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 |