mirror of
https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git
synced 2025-12-16 08:56:40 -05:00
doc: Assorted spelling and grammar fixes for doxygen output
Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>
This commit is contained in:
parent
0c4c2b3110
commit
ad61ef4477
4 changed files with 7 additions and 7 deletions
|
|
@ -87,7 +87,7 @@
|
||||||
* Whenever the library creates an object, it will have an initial
|
* Whenever the library creates an object, it will have an initial
|
||||||
* reference count of one. Most of the time, this single reference will be
|
* reference count of one. Most of the time, this single reference will be
|
||||||
* sufficient for the application, so all required reference count
|
* sufficient for the application, so all required reference count
|
||||||
* interaction will be a single call to the objects unref function.
|
* interaction will be a single call to the object's unref function.
|
||||||
*
|
*
|
||||||
* \section context_sec Context
|
* \section context_sec Context
|
||||||
*
|
*
|
||||||
|
|
|
||||||
|
|
@ -326,7 +326,7 @@ typedef enum pa_stream_flags {
|
||||||
* PA_STREAM_ADJUST_LATENCY. \since 0.9.12 */
|
* PA_STREAM_ADJUST_LATENCY. \since 0.9.12 */
|
||||||
|
|
||||||
PA_STREAM_DONT_INHIBIT_AUTO_SUSPEND = 0x8000U,
|
PA_STREAM_DONT_INHIBIT_AUTO_SUSPEND = 0x8000U,
|
||||||
/**< If set this stream won't be taken into account when we it is
|
/**< If set this stream won't be taken into account when it is
|
||||||
* checked whether the device this stream is connected to should
|
* checked whether the device this stream is connected to should
|
||||||
* auto-suspend. \since 0.9.15 */
|
* auto-suspend. \since 0.9.15 */
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -127,7 +127,7 @@
|
||||||
* (which is recommended) the server will choose the same
|
* (which is recommended) the server will choose the same
|
||||||
* value as tlength here.
|
* value as tlength here.
|
||||||
*
|
*
|
||||||
* \li minreq - Minimum free number of the bytes in the playback
|
* \li minreq - Minimum number of free bytes in the playback
|
||||||
* buffer before the server will request more data. It is
|
* buffer before the server will request more data. It is
|
||||||
* recommended to fill in (uint32_t) -1 here. This value
|
* recommended to fill in (uint32_t) -1 here. This value
|
||||||
* influences how much time the sound server has to move
|
* influences how much time the sound server has to move
|
||||||
|
|
@ -154,13 +154,13 @@
|
||||||
* PA_STREAM_ADJUST_LATENCY if you want to control the overall
|
* PA_STREAM_ADJUST_LATENCY if you want to control the overall
|
||||||
* playback latency for your stream. Unset it if you want to control
|
* playback latency for your stream. Unset it if you want to control
|
||||||
* only the latency induced by the server-side, rewritable playback
|
* only the latency induced by the server-side, rewritable playback
|
||||||
* buffer. The server will try to fulfill the clients latency requests
|
* buffer. The server will try to fulfill the client's latency requests
|
||||||
* as good as possible. However if the underlying hardware cannot
|
* as good as possible. However if the underlying hardware cannot
|
||||||
* change the hardware buffer length or only in a limited range, the
|
* change the hardware buffer length or only in a limited range, the
|
||||||
* actually resulting latency might be different from what the client
|
* actually resulting latency might be different from what the client
|
||||||
* requested. Thus, for synchronization clients always need to check
|
* requested. Thus, for synchronization clients always need to check
|
||||||
* the actual measured latency via pa_stream_get_latency() or a
|
* the actual measured latency via pa_stream_get_latency() or a
|
||||||
* similar call, and not make any assumptions. about the latency
|
* similar call, and not make any assumptions about the latency
|
||||||
* available. The function pa_stream_get_buffer_attr() will always
|
* available. The function pa_stream_get_buffer_attr() will always
|
||||||
* return the actual size of the server-side per-stream buffer in
|
* return the actual size of the server-side per-stream buffer in
|
||||||
* tlength/fragsize, regardless whether PA_STREAM_ADJUST_LATENCY is
|
* tlength/fragsize, regardless whether PA_STREAM_ADJUST_LATENCY is
|
||||||
|
|
@ -434,7 +434,7 @@ int pa_stream_is_suspended(pa_stream *s);
|
||||||
int pa_stream_is_corked(pa_stream *s);
|
int pa_stream_is_corked(pa_stream *s);
|
||||||
|
|
||||||
/** Connect the stream to a sink. It is strongly recommended to pass
|
/** Connect the stream to a sink. It is strongly recommended to pass
|
||||||
* NULL in both \a dev and \a volume and not to set either
|
* NULL in both \a dev and \a volume and to set neither
|
||||||
* PA_STREAM_START_MUTED nor PA_STREAM_START_UNMUTED -- unless these
|
* PA_STREAM_START_MUTED nor PA_STREAM_START_UNMUTED -- unless these
|
||||||
* options are directly dependent on user input or configuration.
|
* options are directly dependent on user input or configuration.
|
||||||
*
|
*
|
||||||
|
|
|
||||||
|
|
@ -226,7 +226,7 @@ PA_C_DECL_BEGIN
|
||||||
* that they can be called at any time. The threaded main loop API provides
|
* that they can be called at any time. The threaded main loop API provides
|
||||||
* the locking mechanism to handle concurrent accesses, but nothing else.
|
* the locking mechanism to handle concurrent accesses, but nothing else.
|
||||||
* Applications will have to handle communication from the callback to the
|
* Applications will have to handle communication from the callback to the
|
||||||
* main program through its own mechanisms.
|
* main program through their own mechanisms.
|
||||||
*
|
*
|
||||||
* The callbacks that are completely asynchronous are:
|
* The callbacks that are completely asynchronous are:
|
||||||
*
|
*
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue