Merge "Clarify return values of get_presentation_position" into klp-dev

1 files changed, 9 insertions, 1 deletions

diff --git a/include/hardware/audio.h b/include/hardware/audio.h
index f8419807..6ba2544e 100644
--- a/include/hardware/audio.h
+++ b/include/hardware/audio.h
@@ -358,10 +358,18 @@ struct audio_stream_out {
    int (*flush)(struct audio_stream_out* stream);
 
     /**
-     * Return the number of audio frames presented to an external observer.
+     * Return a recent count of the number of audio frames presented to an external observer.
      * This excludes frames which have been written but are still in the pipeline.
      * The count is not reset to zero when output enters standby.
      * Also returns the value of CLOCK_MONOTONIC as of this presentation count.
+     * The returned count is expected to be 'recent',
+     * but does not need to be the most recent possible value.
+     * However, the associated time should correspond to whatever count is returned.
+     * Example:  assume that N+M frames have been presented, where M is a 'small' number.
+     * Then it is permissible to return N instead of N+M,
+     * and the timestamp should correspond to N rather than N+M.
+     * The terms 'recent' and 'small' are not defined.
+     * They reflect the quality of the implementation.
      *
      * 3.0 and higher only.
      */