am 063c87f2: am 22b42bc5: Merge "Clarify return values of get_presentation_position" into klp-dev

* commit '063c87f2b96d6a2914dc57f7e7b9b4541de71dbc':
  Clarify return values of get_presentation_position
This commit is contained in:
Glenn Kasten 2013-09-11 17:23:10 -07:00 committed by Android Git Automerger
commit e17899314b

View file

@ -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.
*/