AudioSink/TimeFrame1: API doc: Add notes about integer stored milliseconds for PTS and duration, i.e. good for 24.855 days

1 files changed, 11 insertions, 0 deletions

diff --git a/src/java/com/jogamp/common/av/AudioSink.java b/src/java/com/jogamp/common/av/AudioSink.java
index 1b7b736..f3ed5a8 100644
--- a/src/java/com/jogamp/common/av/AudioSink.java
+++ b/src/java/com/jogamp/common/av/AudioSink.java
@@ -404,11 +404,22 @@ public interface AudioSink {
 
     /**
      * Return the current audio presentation timestamp (PTS) in milliseconds.
+     * <p>
+     * In case implementation updates the audio buffer passively, consider using {@link #updateQueue()}.
+     * </p>
+     * <p>
+     * The relative millisecond PTS since start of the presentation stored in integer
+     * covers a time span of 2'147'483'647 ms (see {@link Integer#MAX_VALUE}
+     * or 2'147'483 seconds or 24.855 days.
+     * </p>
+     * @see #updateQueue()
+     * @see #enqueueData(int, ByteBuffer, int)
      */
     public int getPTS();
 
     /**
      * Return the last buffered audio presentation timestamp (PTS) in milliseconds.
+     * @see #getPTS()
      */
     public int getLastBufferedPTS();