mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-10-31 22:25:33 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

merge and deduplicate some pa_buffer_attr documentation

Browse source
This commit is contained in:
jnqnfe 2017-09-08 04:31:42 +01:00 • committed by Tanu Kaskinen
parent b683350856
commit 26b1d0fc84
2 changed files with 44 additions and 78 deletions
Download patch file Download diff file Expand all files Collapse all files

46
src/pulse/def.h
View file

@ -401,13 +401,18 @@ typedef struct pa_buffer_attr {
uint32_t tlength;
/**< Playback only: target length of the buffer. The server tries
* to assure that at least tlength bytes are always available in
* the per-stream server-side playback buffer. It is recommended
* to set this to (uint32_t) -1, which will initialize this to a
* value that is deemed sensible by the server. However, this
* value will default to something like 2s, i.e. for applications
* that have specific latency requirements this value should be
* set to the maximum latency that the application can deal
* with. When PA_STREAM_ADJUST_LATENCY is not set this value will
* the per-stream server-side playback buffer. The server will
* only send requests for more data as long as the buffer has
* less than this number of bytes of data.
*
* It is recommended to set this to (uint32_t) -1, which will
* initialize this to a value that is deemed sensible by the
* server. However, this value will default to something like 2s;
* for applications that have specific latency requirements
* this value should be set to the maximum latency that the
* application can deal with.
*
* When PA_STREAM_ADJUST_LATENCY is not set this value will
* influence only the per-stream playback buffer size. When
* PA_STREAM_ADJUST_LATENCY is set the overall latency of the sink
* plus the playback buffer size is configured to this value. Set
@ -421,11 +426,19 @@ typedef struct pa_buffer_attr {
* playback before at least prebuf bytes are available in the
* buffer. It is recommended to set this to (uint32_t) -1, which
* will initialize this to the same value as tlength, whatever
* that may be. Initialize to 0 to enable manual start/stop
* control of the stream. This means that playback will not stop
* on underrun and playback will not start automatically. Instead
* pa_stream_cork() needs to be called explicitly. If you set
* this value to 0 you should also set PA_STREAM_START_CORKED. */
* that may be.
*
* Initialize to 0 to enable manual start/stop control of the stream.
* This means that playback will not stop on underrun and playback
* will not start automatically, instead pa_stream_cork() needs to
* be called explicitly. If you set this value to 0 you should also
* set PA_STREAM_START_CORKED. Should underrun occur, the read index
* of the output buffer overtakes the write index, and hence the
* fill level of the buffer is negative.
*
* Start of playback can be forced using pa_stream_trigger() even
* though the prebuffer size hasn't been reached. If a buffer
* underrun occurs, this prebuffering will be again enabled. */
uint32_t minreq;
/**< Playback only: minimum request. The server does not request
@ -444,11 +457,12 @@ typedef struct pa_buffer_attr {
* but decrease control overhead. It is recommended to set this to
* (uint32_t) -1, which will initialize this to a value that is
* deemed sensible by the server. However, this value will default
* to something like 2s, i.e. for applications that have specific
* to something like 2s; For applications that have specific
* latency requirements this value should be set to the maximum
* latency that the application can deal with. If
* PA_STREAM_ADJUST_LATENCY is set the overall source latency will
* be adjusted according to this value. If it is not set the
* latency that the application can deal with.
*
* If PA_STREAM_ADJUST_LATENCY is set the overall source latency
* will be adjusted according to this value. If it is not set the
* source latency is left unmodified. */
} pa_buffer_attr;