mirror of
https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git
synced 2025-11-09 13:29:59 -05:00
replace a few remaining uppercase "Polypaudio" occurences with "PulseAudio"
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@1036 fefdeb5f-60dc-0310-8127-8f9354f1896f
This commit is contained in:
parent
955e33db60
commit
10b5e997d7
20 changed files with 53 additions and 53 deletions
|
|
@ -59,7 +59,7 @@
|
|||
*
|
||||
* \li \subpage mainloop - A minimal but fast implementation based on poll().
|
||||
* \li \subpage threaded_mainloop - A special version of the previous
|
||||
* implementation where all of Polypaudio's
|
||||
* implementation where all of PulseAudio's
|
||||
* internal handling runs in a separate
|
||||
* thread.
|
||||
* \li \subpage glib-mainloop - A wrapper around GLIB's main loop. Available
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@
|
|||
* \section overv_sec Overview
|
||||
*
|
||||
* Sometimes it is necessary to query and modify global settings in the
|
||||
* server. For this, Polypaudio has the introspection API. It can list sinks,
|
||||
* server. For this, PulseAudio has the introspection API. It can list sinks,
|
||||
* sources, samples and other aspects of the server. It can also modify the
|
||||
* attributes of the server that will affect operations on a global level,
|
||||
* and not just the application's context.
|
||||
|
|
@ -121,7 +121,7 @@
|
|||
*
|
||||
* \subsection module_subsec Driver Modules
|
||||
*
|
||||
* Polypaudio driver modules are identified by index and are retrieved using either
|
||||
* PulseAudio driver modules are identified by index and are retrieved using either
|
||||
* pa_context_get_module_info() or pa_context_get_module_info_list(). The
|
||||
* information structure is called pa_module_info.
|
||||
*
|
||||
|
|
@ -137,7 +137,7 @@
|
|||
*
|
||||
* \subsection client_subsec Clients
|
||||
*
|
||||
* Polypaudio clients are also identified by index and are retrieved using
|
||||
* PulseAudio clients are also identified by index and are retrieved using
|
||||
* either pa_context_get_client_info() or pa_context_get_client_info_list().
|
||||
* The information structure is called pa_client_info.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@
|
|||
* \li The complete but somewhat complicated to use asynchronous API
|
||||
* \li The simplified, easy to use, but limited synchronous API
|
||||
*
|
||||
* All strings in Polypaudio are in the UTF-8 encoding, regardless of current
|
||||
* All strings in PulseAudio are in the UTF-8 encoding, regardless of current
|
||||
* locale. Some functions will filter invalid sequences from the string, some
|
||||
* will simply fail. To ensure reliable behaviour, make sure everything you
|
||||
* pass to the API is already in UTF-8.
|
||||
|
|
|
|||
|
|
@ -32,12 +32,12 @@
|
|||
*
|
||||
* \section overv_sec Overview
|
||||
*
|
||||
* Polypaudio is capable of handling a multitude of sample formats, rates
|
||||
* PulseAudio is capable of handling a multitude of sample formats, rates
|
||||
* and channels, transparently converting and mixing them as needed.
|
||||
*
|
||||
* \section format_sec Sample Format
|
||||
*
|
||||
* Polypaudio supports the following sample formats:
|
||||
* PulseAudio supports the following sample formats:
|
||||
*
|
||||
* \li PA_SAMPLE_U8 - Unsigned 8 bit PCM.
|
||||
* \li PA_SAMPLE_S16LE - Signed 16 bit PCM, little endian.
|
||||
|
|
@ -54,20 +54,20 @@
|
|||
*
|
||||
* \section rate_sec Sample Rates
|
||||
*
|
||||
* Polypaudio supports any sample rate between 1 Hz and 4 GHz. There is no
|
||||
* PulseAudio supports any sample rate between 1 Hz and 4 GHz. There is no
|
||||
* point trying to exceed the sample rate of the output device though as the
|
||||
* signal will only get downsampled, consuming CPU on the machine running the
|
||||
* server.
|
||||
*
|
||||
* \section chan_sec Channels
|
||||
*
|
||||
* Polypaudio supports up to 16 individiual channels. The order of the
|
||||
* PulseAudio supports up to 16 individiual channels. The order of the
|
||||
* channels is up to the application, but they must be continous. To map
|
||||
* channels to speakers, see \ref channelmap.
|
||||
*
|
||||
* \section calc_sec Calculations
|
||||
*
|
||||
* The Polypaudio library contains a number of convenience functions to do
|
||||
* The PulseAudio library contains a number of convenience functions to do
|
||||
* calculations on sample formats:
|
||||
*
|
||||
* \li pa_bytes_per_second() - The number of bytes one second of audio will
|
||||
|
|
|
|||
|
|
@ -107,7 +107,7 @@
|
|||
* wrap. The current read/write index may be queried using
|
||||
* pa_stream_get_timing_info() (see below for more information). In
|
||||
* case of a buffer underrun the read index is equal or larger than
|
||||
* the write index. Unless the prebuf value is 0, Polypaudio will
|
||||
* the write index. Unless the prebuf value is 0, PulseAudio will
|
||||
* temporarily pause playback in such a case, and wait until the
|
||||
* buffer is filled up to prebuf bytes again. If prebuf is 0, the
|
||||
* read index may be larger than the write index, in which case
|
||||
|
|
@ -169,7 +169,7 @@
|
|||
* \section latency_sec Latency
|
||||
*
|
||||
* A major problem with networked audio is the increased latency caused by
|
||||
* the network. To remedy this, Polypaudio supports an advanced system of
|
||||
* the network. To remedy this, PulseAudio supports an advanced system of
|
||||
* monitoring the current latency.
|
||||
*
|
||||
* To get the raw data needed to calculate latencies, call
|
||||
|
|
@ -183,14 +183,14 @@
|
|||
* pa_stream_update_timing_info() operation is executed. (i.e. before
|
||||
* the first call to this function the timing information structure is
|
||||
* not available!) Since it is a lot of work to keep this structure
|
||||
* up-to-date manually, Polypaudio can do that automatically for you:
|
||||
* up-to-date manually, PulseAudio can do that automatically for you:
|
||||
* if PA_STREAM_AUTO_TIMING_UPDATE is passed when connecting the
|
||||
* stream Polypaudio will automatically update the structure every
|
||||
* stream PulseAudio will automatically update the structure every
|
||||
* 100ms and every time a function is called that might invalidate the
|
||||
* previously known timing data (such as pa_stream_write() or
|
||||
* pa_stream_flush()). Please note however, that there always is a
|
||||
* short time window when the data in the timing information structure
|
||||
* is out-of-date. Polypaudio tries to mark these situations by
|
||||
* is out-of-date. PulseAudio tries to mark these situations by
|
||||
* setting the write_index_corrupt and read_index_corrupt fields
|
||||
* accordingly.
|
||||
*
|
||||
|
|
@ -208,7 +208,7 @@
|
|||
*
|
||||
* Since updating the timing info structure usually requires a full
|
||||
* network round trip and some applications monitor the timing very
|
||||
* often Polypaudio offers a timing interpolation system. If
|
||||
* often PulseAudio offers a timing interpolation system. If
|
||||
* PA_STREAM_INTERPOLATE_TIMING is passed when connecting the stream,
|
||||
* pa_stream_get_time() and pa_stream_get_latency() will try to
|
||||
* interpolate the current playback time/latency by estimating the
|
||||
|
|
@ -228,7 +228,7 @@
|
|||
*
|
||||
* \section sync_streams Sychronizing Multiple Playback Streams
|
||||
*
|
||||
* Polypaudio allows applications to fully synchronize multiple
|
||||
* PulseAudio allows applications to fully synchronize multiple
|
||||
* playback streams that are connected to the same output device. That
|
||||
* means the streams will always be played back sample-by-sample
|
||||
* synchronously. If stream operations like pa_stream_cork() are
|
||||
|
|
@ -441,7 +441,7 @@ const pa_channel_map* pa_stream_get_channel_map(pa_stream *s);
|
|||
|
||||
/** Return the buffer metrics of the stream. Only valid after the
|
||||
* stream has been connected successfuly and if the server is at least
|
||||
* Polypaudio 0.9. \since 0.9.0 */
|
||||
* PulseAudio 0.9. \since 0.9.0 */
|
||||
const pa_buffer_attr* pa_stream_get_buffer_attr(pa_stream *s);
|
||||
|
||||
PA_C_DECL_END
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ PA_C_DECL_BEGIN
|
|||
*
|
||||
* The added feature in the threaded main loop is that it spawns a new thread
|
||||
* that runs the real main loop. This allows a synchronous application to use
|
||||
* the asynchronous API without risking to stall the Polypaudio library.
|
||||
* the asynchronous API without risking to stall the PulseAudio library.
|
||||
*
|
||||
* \section creat_sec Creation
|
||||
*
|
||||
|
|
@ -48,7 +48,7 @@ PA_C_DECL_BEGIN
|
|||
*
|
||||
* \section destr_sec Destruction
|
||||
*
|
||||
* When the Polypaudio connection has been terminated, the thread must be
|
||||
* When the PulseAudio connection has been terminated, the thread must be
|
||||
* stopped and the resources freed. Stopping the thread is done using
|
||||
* pa_threaded_mainloop_stop(), which must be called without the lock (see
|
||||
* below) held. When that function returns, the thread is stopped and the
|
||||
|
|
@ -56,7 +56,7 @@ PA_C_DECL_BEGIN
|
|||
*
|
||||
* \section lock_sec Locking
|
||||
*
|
||||
* Since the Polypaudio API doesn't allow concurrent accesses to objects,
|
||||
* Since the PulseAudio API doesn't allow concurrent accesses to objects,
|
||||
* a locking scheme must be used to guarantee safe usage. The threaded main
|
||||
* loop API provides such a scheme through the functions
|
||||
* pa_threaded_mainloop_lock() and pa_threaded_mainloop_unlock().
|
||||
|
|
@ -65,7 +65,7 @@ PA_C_DECL_BEGIN
|
|||
* thread. Just make sure you call pa_threaded_mainloop_unlock() the same
|
||||
* number of times you called pa_threaded_mainloop_lock().
|
||||
*
|
||||
* The lock needs to be held whenever you call any Polypaudio function that
|
||||
* The lock needs to be held whenever you call any PulseAudio function that
|
||||
* uses an object associated with this main loop. Make sure you do not hold
|
||||
* on to the lock more than necessary though, as the threaded main loop stops
|
||||
* while the lock is held.
|
||||
|
|
@ -91,12 +91,12 @@ PA_C_DECL_BEGIN
|
|||
*
|
||||
* \section cb_sec Callbacks
|
||||
*
|
||||
* Callbacks in Polypaudio are asynchronous, so they require extra care when
|
||||
* Callbacks in PulseAudio are asynchronous, so they require extra care when
|
||||
* using them together with a threaded main loop.
|
||||
*
|
||||
* The easiest way to turn the callback based operations into synchronous
|
||||
* ones, is to simply wait for the callback to be called and continue from
|
||||
* there. This is the approach chosen in Polypaudio's threaded API.
|
||||
* there. This is the approach chosen in PulseAudio's threaded API.
|
||||
*
|
||||
* \subsection basic_subsec Basic callbacks
|
||||
*
|
||||
|
|
@ -216,7 +216,7 @@ PA_C_DECL_BEGIN
|
|||
*
|
||||
* \subsection async_subsec Asynchronous callbacks
|
||||
*
|
||||
* Polypaudio also has callbacks that are completely asynchronous, meaning
|
||||
* PulseAudio also has callbacks that are completely asynchronous, meaning
|
||||
* that they can be called at any time. The threading main loop API provides
|
||||
* the locking mechanism to handle concurrent accesses, but nothing else.
|
||||
* Applications will have to handle communication from the callback to the
|
||||
|
|
|
|||
|
|
@ -39,12 +39,12 @@ it. */
|
|||
/** Return the version of the library the current application is linked to. */
|
||||
const char* pa_get_library_version(void);
|
||||
|
||||
/** The current API version. Version 6 relates to pulseaudio
|
||||
/** The current API version. Version 6 relates to Polypaudio
|
||||
* 0.6. Prior versions (i.e. Polypaudio 0.5.1 and older) have
|
||||
* PA_API_VERSION undefined. */
|
||||
#define PA_API_VERSION @PA_API_VERSION@
|
||||
|
||||
/** The current protocol version. Version 8 relates to pulseaudio 0.8.
|
||||
/** The current protocol version. Version 8 relates to Polypaudio 0.8/PulseAudio 0.9.
|
||||
* \since 0.8 */
|
||||
#define PA_PROTOCOL_VERSION @PA_PROTOCOL_VERSION@
|
||||
|
||||
|
|
|
|||
|
|
@ -31,10 +31,10 @@
|
|||
* \section overv_sec Overview
|
||||
*
|
||||
* Sinks, sources, sink inputs and samples can all have their own volumes.
|
||||
* To deal with these, The Polypaudio libray contains a number of functions
|
||||
* To deal with these, The PulseAudio libray contains a number of functions
|
||||
* that ease handling.
|
||||
*
|
||||
* The basic volume type in Polypaudio is the \ref pa_volume_t type. Most of
|
||||
* The basic volume type in PulseAudio is the \ref pa_volume_t type. Most of
|
||||
* the time, applications will use the aggregated pa_cvolume structure that
|
||||
* can store the volume of all channels at once.
|
||||
*
|
||||
|
|
@ -43,7 +43,7 @@
|
|||
*
|
||||
* \section calc_sec Calculations
|
||||
*
|
||||
* The volumes in Polypaudio are logarithmic in nature and applications
|
||||
* The volumes in PulseAudio are logarithmic in nature and applications
|
||||
* shouldn't perform calculations with them directly. Instead, they should
|
||||
* be converted to and from either dB or a linear scale:
|
||||
*
|
||||
|
|
@ -64,7 +64,7 @@
|
|||
*
|
||||
* \section conv_sec Convenience Functions
|
||||
*
|
||||
* To handle the pa_cvolume structure, the Polypaudio library provides a
|
||||
* To handle the pa_cvolume structure, the PulseAudio library provides a
|
||||
* number of convenienc functions:
|
||||
*
|
||||
* \li pa_cvolume_valid() - Tests if a pa_cvolume structure is valid.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue