diff --git a/staging/ext-image-copy-capture/ext-image-copy-capture-v1.xml b/staging/ext-image-copy-capture/ext-image-copy-capture-v1.xml index 1ac4369..d541bdc 100644 --- a/staging/ext-image-copy-capture/ext-image-copy-capture-v1.xml +++ b/staging/ext-image-copy-capture/ext-image-copy-capture-v1.xml @@ -34,7 +34,7 @@ only be done by creating a new major version of the extension. - + This object is a manager which offers requests to start capturing from a source. @@ -199,7 +199,7 @@ - + This object represents an image capture frame. @@ -367,6 +367,42 @@ + + + + This event reports the time, in CLOCK_MONOTONIC, at which the + compositor sampled the source content into the capture buffer + for this frame. It is the symmetric counterpart of the + presentation_time event on the same interface: presentation_time + reports when the frame was or will be presented on its output; + capture_time reports when the frame's content was captured. + + Together with the wall-clock time at which the client receives + the ready event, this allows the client to determine how much + time has elapsed between the source becoming current and the + buffer becoming readable, and to embed an accurate source + timestamp in any downstream stream encoded from this frame. + + Compositors may emit this event before the ready event. + Compositors that cannot determine the sampling time precisely + must not send this event; consumers must handle absence + gracefully. + + At most one capture_time event is sent per frame. The format of + the timestamp matches presentation_time: the seconds part is a + 64-bit value combined from tv_sec_hi and tv_sec_lo, and tv_nsec + is in [0, 999999999]. + + This event is informational. It does not change the buffer + delivery contract or the meaning of the ready event. + + + + +