mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-10-29 05:40:23 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

stream: Mention pa_stream_new_extended() in the high-level stream creation documentation

Browse source
This commit is contained in:
Tanu Kaskinen 2013-12-04 06:18:42 +02:00
parent a36bf31cae
commit fdf72d3d21
1 changed files with 8 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

11
src/pulse/stream.h
View file

@ -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