system/pipewire
system/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire synced 2024-09-16 06:29:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

stream: update some docs

Browse source
This commit is contained in:
Wim Taymans 2024-03-13 15:27:47 +01:00
parent 69cc3832d4
commit 1d8a96d240
1 changed files with 12 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
src/pipewire/stream.h
View file

@ -206,7 +206,12 @@ enum pw_stream_state {
* structure can grow as more field are added in the future */ * structure can grow as more field are added in the future */
struct pw_buffer { struct pw_buffer {
struct spa_buffer *buffer; /**< the spa buffer */ struct spa_buffer *buffer; /**< the spa buffer */
void *user_data; /**< user data attached to the buffer */ void *user_data; /**< user data attached to the buffer. The user of
* the stream can set custom data associated with the
* buffer, typically in the add_buffer event. Any
* cleanup should be performed in the remove_buffer
* event. The user data is returned unmodified each
* time a buffer is dequeued. */
uint64_t size; /**< This field is set by the user and the sum of uint64_t size; /**< This field is set by the user and the sum of
* all queued buffer is returned in the time info. * all queued buffer is returned in the time info.
* For audio, it is advised to use the number of * For audio, it is advised to use the number of
@ -303,12 +308,12 @@ struct pw_stream_control {
*\endcode *\endcode
*/ */
struct pw_time { struct pw_time {
int64_t now; /**< the monotonic time in nanoseconds. This is the time int64_t now; /**< the time in nanoseconds. This is the time when this
* when this time report was updated. It is usually * time report was updated. It is usually updated every
* updated every graph cycle. You can use the current * graph cycle. You can use pw_stream_get_nsec() to
* monotonic time to calculate the elapsed time between * calculate the elapsed time between this report and
* this report and the current state and calculate * the current time and calculate updated ticks and delay
* updated ticks and delay values. */ * values. */
struct spa_fraction rate; /**< the rate of \a ticks and delay. This is usually struct spa_fraction rate; /**< the rate of \a ticks and delay. This is usually
* expressed in 1/<samplerate>. */ * expressed in 1/<samplerate>. */
uint64_t ticks; /**< the ticks at \a now. This is the current time that uint64_t ticks; /**< the ticks at \a now. This is the current time that