mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-03 09:01:54 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

stream: update pw_time docs a little.

Browse source 
See #2241
This commit is contained in:
Wim Taymans 2022-03-26 20:01:24 +01:00
parent 4dff7f0e5f
commit 34380ff02e
1 changed files with 16 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

21
src/pipewire/stream.h
View file

@ -193,13 +193,24 @@ struct pw_stream_control {
/** A time structure */ /** A time structure */
struct pw_time { struct pw_time {
int64_t now; /**< the monotonic time in nanoseconds */ int64_t now; /**< the monotonic time in nanoseconds. This is the time
struct spa_fraction rate; /**< the rate of \a ticks and delay */ * when this time report was updated. It is usually
* updated every graph cycle. You can use the current
* monotonic time to calculate the elapsed time between
* this report and the current state and calculate
* updated ticks and delay values. */
struct spa_fraction rate; /**< the rate of \a ticks and delay. This is usually
* 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
* the remote end is reading/writing. */ * the remote end is reading/writing. */
int64_t delay; /**< delay to device, add to ticks to get the time of the int64_t delay; /**< delay to device. This is the time it will take for
* device. Positive for INPUT streams and * the next sample in the stream to be presented by
* negative for OUTPUT streams. */ * the playback device or the time a sample traveled
* from the capture device. This delay includes the
* delay introduced by all filters on the path between
* the stream and the device. The delay is normally
* constant in a graph and can change when the topology
* of the graph or the quantum changes. */
uint64_t queued; /**< data queued in the stream, this is the sum uint64_t queued; /**< data queued in the stream, this is the sum
* of the size fields in the pw_buffer that are * of the size fields in the pw_buffer that are
* currently queued */ * currently queued */