Skip to content

Commit 4548949

Browse files
committed
Update javadoc for ExoPlayer 2.18.7
PiperOrigin-RevId: 532770925 (cherry picked from commit 937f3b5)
1 parent 5b8d793 commit 4548949

17 files changed

+112
-68026
lines changed

docs/doc/reference/com/google/android/exoplayer2/decoder/Buffer.html

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
catch(err) {
2626
}
2727
//-->
28-
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
28+
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
2929
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
3030
var altColor = "altColor";
3131
var rowColor = "rowColor";
@@ -241,6 +241,13 @@ <h3>Method Summary</h3>
241241
</td>
242242
</tr>
243243
<tr id="i9" class="rowColor">
244+
<td class="colFirst"><code>boolean</code></td>
245+
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLastSample()">isLastSample</a></span>()</code></th>
246+
<td class="colLast">
247+
<div class="block">Returns whether the <a href="../C.html#BUFFER_FLAG_LAST_SAMPLE"><code>C.BUFFER_FLAG_LAST_SAMPLE</code></a> flag is set.</div>
248+
</td>
249+
</tr>
250+
<tr id="i10" class="altColor">
244251
<td class="colFirst"><code>void</code></td>
245252
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFlags(@com.google.android.exoplayer2.C.BufferFlagsint)">setFlags</a></span>&#8203;(@com.google.android.exoplayer2.C.BufferFlags int&nbsp;flags)</code></th>
246253
<td class="colLast">
@@ -340,6 +347,16 @@ <h4>isKeyFrame</h4>
340347
<div class="block">Returns whether the <a href="../C.html#BUFFER_FLAG_KEY_FRAME"><code>C.BUFFER_FLAG_KEY_FRAME</code></a> flag is set.</div>
341348
</li>
342349
</ul>
350+
<a id="isLastSample()">
351+
<!-- -->
352+
</a>
353+
<ul class="blockList">
354+
<li class="blockList">
355+
<h4>isLastSample</h4>
356+
<pre class="methodSignature">public final&nbsp;boolean&nbsp;isLastSample()</pre>
357+
<div class="block">Returns whether the <a href="../C.html#BUFFER_FLAG_LAST_SAMPLE"><code>C.BUFFER_FLAG_LAST_SAMPLE</code></a> flag is set.</div>
358+
</li>
359+
</ul>
343360
<a id="hasSupplementalData()">
344361
<!-- -->
345362
</a>

docs/doc/reference/com/google/android/exoplayer2/decoder/DecoderInputBuffer.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,7 @@ <h3>Method Summary</h3>
356356
<!-- -->
357357
</a>
358358
<h3>Methods inherited from class&nbsp;com.google.android.exoplayer2.decoder.<a href="Buffer.html" title="class in com.google.android.exoplayer2.decoder">Buffer</a></h3>
359-
<code><a href="Buffer.html#addFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">addFlag</a>, <a href="Buffer.html#clearFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">clearFlag</a>, <a href="Buffer.html#getFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">getFlag</a>, <a href="Buffer.html#hasSupplementalData()">hasSupplementalData</a>, <a href="Buffer.html#isDecodeOnly()">isDecodeOnly</a>, <a href="Buffer.html#isEndOfStream()">isEndOfStream</a>, <a href="Buffer.html#isFirstSample()">isFirstSample</a>, <a href="Buffer.html#isKeyFrame()">isKeyFrame</a>, <a href="Buffer.html#setFlags(@com.google.android.exoplayer2.C.BufferFlagsint)">setFlags</a></code></li>
359+
<code><a href="Buffer.html#addFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">addFlag</a>, <a href="Buffer.html#clearFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">clearFlag</a>, <a href="Buffer.html#getFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">getFlag</a>, <a href="Buffer.html#hasSupplementalData()">hasSupplementalData</a>, <a href="Buffer.html#isDecodeOnly()">isDecodeOnly</a>, <a href="Buffer.html#isEndOfStream()">isEndOfStream</a>, <a href="Buffer.html#isFirstSample()">isFirstSample</a>, <a href="Buffer.html#isKeyFrame()">isKeyFrame</a>, <a href="Buffer.html#isLastSample()">isLastSample</a>, <a href="Buffer.html#setFlags(@com.google.android.exoplayer2.C.BufferFlagsint)">setFlags</a></code></li>
360360
</ul>
361361
<ul class="blockList">
362362
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

docs/doc/reference/com/google/android/exoplayer2/decoder/DecoderOutputBuffer.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ <h3>Method Summary</h3>
252252
<!-- -->
253253
</a>
254254
<h3>Methods inherited from class&nbsp;com.google.android.exoplayer2.decoder.<a href="Buffer.html" title="class in com.google.android.exoplayer2.decoder">Buffer</a></h3>
255-
<code><a href="Buffer.html#addFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">addFlag</a>, <a href="Buffer.html#clear()">clear</a>, <a href="Buffer.html#clearFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">clearFlag</a>, <a href="Buffer.html#getFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">getFlag</a>, <a href="Buffer.html#hasSupplementalData()">hasSupplementalData</a>, <a href="Buffer.html#isDecodeOnly()">isDecodeOnly</a>, <a href="Buffer.html#isEndOfStream()">isEndOfStream</a>, <a href="Buffer.html#isFirstSample()">isFirstSample</a>, <a href="Buffer.html#isKeyFrame()">isKeyFrame</a>, <a href="Buffer.html#setFlags(@com.google.android.exoplayer2.C.BufferFlagsint)">setFlags</a></code></li>
255+
<code><a href="Buffer.html#addFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">addFlag</a>, <a href="Buffer.html#clear()">clear</a>, <a href="Buffer.html#clearFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">clearFlag</a>, <a href="Buffer.html#getFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">getFlag</a>, <a href="Buffer.html#hasSupplementalData()">hasSupplementalData</a>, <a href="Buffer.html#isDecodeOnly()">isDecodeOnly</a>, <a href="Buffer.html#isEndOfStream()">isEndOfStream</a>, <a href="Buffer.html#isFirstSample()">isFirstSample</a>, <a href="Buffer.html#isKeyFrame()">isKeyFrame</a>, <a href="Buffer.html#isLastSample()">isLastSample</a>, <a href="Buffer.html#setFlags(@com.google.android.exoplayer2.C.BufferFlagsint)">setFlags</a></code></li>
256256
</ul>
257257
<ul class="blockList">
258258
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

docs/doc/reference/com/google/android/exoplayer2/decoder/SimpleDecoderOutputBuffer.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ <h3>Method Summary</h3>
258258
<!-- -->
259259
</a>
260260
<h3>Methods inherited from class&nbsp;com.google.android.exoplayer2.decoder.<a href="Buffer.html" title="class in com.google.android.exoplayer2.decoder">Buffer</a></h3>
261-
<code><a href="Buffer.html#addFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">addFlag</a>, <a href="Buffer.html#clearFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">clearFlag</a>, <a href="Buffer.html#getFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">getFlag</a>, <a href="Buffer.html#hasSupplementalData()">hasSupplementalData</a>, <a href="Buffer.html#isDecodeOnly()">isDecodeOnly</a>, <a href="Buffer.html#isEndOfStream()">isEndOfStream</a>, <a href="Buffer.html#isFirstSample()">isFirstSample</a>, <a href="Buffer.html#isKeyFrame()">isKeyFrame</a>, <a href="Buffer.html#setFlags(@com.google.android.exoplayer2.C.BufferFlagsint)">setFlags</a></code></li>
261+
<code><a href="Buffer.html#addFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">addFlag</a>, <a href="Buffer.html#clearFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">clearFlag</a>, <a href="Buffer.html#getFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">getFlag</a>, <a href="Buffer.html#hasSupplementalData()">hasSupplementalData</a>, <a href="Buffer.html#isDecodeOnly()">isDecodeOnly</a>, <a href="Buffer.html#isEndOfStream()">isEndOfStream</a>, <a href="Buffer.html#isFirstSample()">isFirstSample</a>, <a href="Buffer.html#isKeyFrame()">isKeyFrame</a>, <a href="Buffer.html#isLastSample()">isLastSample</a>, <a href="Buffer.html#setFlags(@com.google.android.exoplayer2.C.BufferFlagsint)">setFlags</a></code></li>
262262
</ul>
263263
<ul class="blockList">
264264
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

docs/doc/reference/com/google/android/exoplayer2/decoder/VideoDecoderOutputBuffer.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ <h3>Method Summary</h3>
350350
<!-- -->
351351
</a>
352352
<h3>Methods inherited from class&nbsp;com.google.android.exoplayer2.decoder.<a href="Buffer.html" title="class in com.google.android.exoplayer2.decoder">Buffer</a></h3>
353-
<code><a href="Buffer.html#addFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">addFlag</a>, <a href="Buffer.html#clear()">clear</a>, <a href="Buffer.html#clearFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">clearFlag</a>, <a href="Buffer.html#getFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">getFlag</a>, <a href="Buffer.html#hasSupplementalData()">hasSupplementalData</a>, <a href="Buffer.html#isDecodeOnly()">isDecodeOnly</a>, <a href="Buffer.html#isEndOfStream()">isEndOfStream</a>, <a href="Buffer.html#isFirstSample()">isFirstSample</a>, <a href="Buffer.html#isKeyFrame()">isKeyFrame</a>, <a href="Buffer.html#setFlags(@com.google.android.exoplayer2.C.BufferFlagsint)">setFlags</a></code></li>
353+
<code><a href="Buffer.html#addFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">addFlag</a>, <a href="Buffer.html#clear()">clear</a>, <a href="Buffer.html#clearFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">clearFlag</a>, <a href="Buffer.html#getFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">getFlag</a>, <a href="Buffer.html#hasSupplementalData()">hasSupplementalData</a>, <a href="Buffer.html#isDecodeOnly()">isDecodeOnly</a>, <a href="Buffer.html#isEndOfStream()">isEndOfStream</a>, <a href="Buffer.html#isFirstSample()">isFirstSample</a>, <a href="Buffer.html#isKeyFrame()">isKeyFrame</a>, <a href="Buffer.html#isLastSample()">isLastSample</a>, <a href="Buffer.html#setFlags(@com.google.android.exoplayer2.C.BufferFlagsint)">setFlags</a></code></li>
354354
</ul>
355355
<ul class="blockList">
356356
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

docs/doc/reference/com/google/android/exoplayer2/metadata/MetadataInputBuffer.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ <h3>Methods inherited from class&nbsp;com.google.android.exoplayer2.decoder.<a h
231231
<!-- -->
232232
</a>
233233
<h3>Methods inherited from class&nbsp;com.google.android.exoplayer2.decoder.<a href="../decoder/Buffer.html" title="class in com.google.android.exoplayer2.decoder">Buffer</a></h3>
234-
<code><a href="../decoder/Buffer.html#addFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">addFlag</a>, <a href="../decoder/Buffer.html#clearFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">clearFlag</a>, <a href="../decoder/Buffer.html#getFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">getFlag</a>, <a href="../decoder/Buffer.html#hasSupplementalData()">hasSupplementalData</a>, <a href="../decoder/Buffer.html#isDecodeOnly()">isDecodeOnly</a>, <a href="../decoder/Buffer.html#isEndOfStream()">isEndOfStream</a>, <a href="../decoder/Buffer.html#isFirstSample()">isFirstSample</a>, <a href="../decoder/Buffer.html#isKeyFrame()">isKeyFrame</a>, <a href="../decoder/Buffer.html#setFlags(@com.google.android.exoplayer2.C.BufferFlagsint)">setFlags</a></code></li>
234+
<code><a href="../decoder/Buffer.html#addFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">addFlag</a>, <a href="../decoder/Buffer.html#clearFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">clearFlag</a>, <a href="../decoder/Buffer.html#getFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">getFlag</a>, <a href="../decoder/Buffer.html#hasSupplementalData()">hasSupplementalData</a>, <a href="../decoder/Buffer.html#isDecodeOnly()">isDecodeOnly</a>, <a href="../decoder/Buffer.html#isEndOfStream()">isEndOfStream</a>, <a href="../decoder/Buffer.html#isFirstSample()">isFirstSample</a>, <a href="../decoder/Buffer.html#isKeyFrame()">isKeyFrame</a>, <a href="../decoder/Buffer.html#isLastSample()">isLastSample</a>, <a href="../decoder/Buffer.html#setFlags(@com.google.android.exoplayer2.C.BufferFlagsint)">setFlags</a></code></li>
235235
</ul>
236236
<ul class="blockList">
237237
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

docs/doc/reference/com/google/android/exoplayer2/testutil/FakeSampleStream.html

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,8 @@ <h3>Method Summary</h3>
305305
</tr>
306306
<tr id="i9" class="rowColor">
307307
<td class="colFirst"><code>boolean</code></td>
308-
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#seekToUs(long)">seekToUs</a></span>&#8203;(long&nbsp;positionUs)</code></th>
308+
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#seekToUs(long,boolean)">seekToUs</a></span>&#8203;(long&nbsp;positionUs,
309+
boolean&nbsp;allowTimeBeyondBuffer)</code></th>
309310
<td class="colLast">
310311
<div class="block">Seeks the stream to a new position using already available data in the queue.</div>
311312
</td>
@@ -420,17 +421,20 @@ <h4>writeData</h4>
420421
</dl>
421422
</li>
422423
</ul>
423-
<a id="seekToUs(long)">
424+
<a id="seekToUs(long,boolean)">
424425
<!-- -->
425426
</a>
426427
<ul class="blockList">
427428
<li class="blockList">
428429
<h4>seekToUs</h4>
429-
<pre class="methodSignature">public&nbsp;boolean&nbsp;seekToUs&#8203;(long&nbsp;positionUs)</pre>
430+
<pre class="methodSignature">public&nbsp;boolean&nbsp;seekToUs&#8203;(long&nbsp;positionUs,
431+
boolean&nbsp;allowTimeBeyondBuffer)</pre>
430432
<div class="block">Seeks the stream to a new position using already available data in the queue.</div>
431433
<dl>
432434
<dt><span class="paramLabel">Parameters:</span></dt>
433435
<dd><code>positionUs</code> - The new position, in microseconds.</dd>
436+
<dd><code>allowTimeBeyondBuffer</code> - Whether the operation can succeed if timeUs is beyond the end of
437+
the queue, by seeking to the last sample (or keyframe).</dd>
434438
<dt><span class="returnLabel">Returns:</span></dt>
435439
<dd>Whether seeking inside the available data was possible.</dd>
436440
</dl>

docs/doc/reference/com/google/android/exoplayer2/text/SubtitleInputBuffer.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ <h3>Methods inherited from class&nbsp;com.google.android.exoplayer2.decoder.<a h
231231
<!-- -->
232232
</a>
233233
<h3>Methods inherited from class&nbsp;com.google.android.exoplayer2.decoder.<a href="../decoder/Buffer.html" title="class in com.google.android.exoplayer2.decoder">Buffer</a></h3>
234-
<code><a href="../decoder/Buffer.html#addFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">addFlag</a>, <a href="../decoder/Buffer.html#clearFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">clearFlag</a>, <a href="../decoder/Buffer.html#getFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">getFlag</a>, <a href="../decoder/Buffer.html#hasSupplementalData()">hasSupplementalData</a>, <a href="../decoder/Buffer.html#isDecodeOnly()">isDecodeOnly</a>, <a href="../decoder/Buffer.html#isEndOfStream()">isEndOfStream</a>, <a href="../decoder/Buffer.html#isFirstSample()">isFirstSample</a>, <a href="../decoder/Buffer.html#isKeyFrame()">isKeyFrame</a>, <a href="../decoder/Buffer.html#setFlags(@com.google.android.exoplayer2.C.BufferFlagsint)">setFlags</a></code></li>
234+
<code><a href="../decoder/Buffer.html#addFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">addFlag</a>, <a href="../decoder/Buffer.html#clearFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">clearFlag</a>, <a href="../decoder/Buffer.html#getFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">getFlag</a>, <a href="../decoder/Buffer.html#hasSupplementalData()">hasSupplementalData</a>, <a href="../decoder/Buffer.html#isDecodeOnly()">isDecodeOnly</a>, <a href="../decoder/Buffer.html#isEndOfStream()">isEndOfStream</a>, <a href="../decoder/Buffer.html#isFirstSample()">isFirstSample</a>, <a href="../decoder/Buffer.html#isKeyFrame()">isKeyFrame</a>, <a href="../decoder/Buffer.html#isLastSample()">isLastSample</a>, <a href="../decoder/Buffer.html#setFlags(@com.google.android.exoplayer2.C.BufferFlagsint)">setFlags</a></code></li>
235235
</ul>
236236
<ul class="blockList">
237237
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

docs/doc/reference/com/google/android/exoplayer2/text/SubtitleOutputBuffer.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ <h3>Methods inherited from class&nbsp;com.google.android.exoplayer2.decoder.<a h
281281
<!-- -->
282282
</a>
283283
<h3>Methods inherited from class&nbsp;com.google.android.exoplayer2.decoder.<a href="../decoder/Buffer.html" title="class in com.google.android.exoplayer2.decoder">Buffer</a></h3>
284-
<code><a href="../decoder/Buffer.html#addFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">addFlag</a>, <a href="../decoder/Buffer.html#clearFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">clearFlag</a>, <a href="../decoder/Buffer.html#getFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">getFlag</a>, <a href="../decoder/Buffer.html#hasSupplementalData()">hasSupplementalData</a>, <a href="../decoder/Buffer.html#isDecodeOnly()">isDecodeOnly</a>, <a href="../decoder/Buffer.html#isEndOfStream()">isEndOfStream</a>, <a href="../decoder/Buffer.html#isFirstSample()">isFirstSample</a>, <a href="../decoder/Buffer.html#isKeyFrame()">isKeyFrame</a>, <a href="../decoder/Buffer.html#setFlags(@com.google.android.exoplayer2.C.BufferFlagsint)">setFlags</a></code></li>
284+
<code><a href="../decoder/Buffer.html#addFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">addFlag</a>, <a href="../decoder/Buffer.html#clearFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">clearFlag</a>, <a href="../decoder/Buffer.html#getFlag(@com.google.android.exoplayer2.C.BufferFlagsint)">getFlag</a>, <a href="../decoder/Buffer.html#hasSupplementalData()">hasSupplementalData</a>, <a href="../decoder/Buffer.html#isDecodeOnly()">isDecodeOnly</a>, <a href="../decoder/Buffer.html#isEndOfStream()">isEndOfStream</a>, <a href="../decoder/Buffer.html#isFirstSample()">isFirstSample</a>, <a href="../decoder/Buffer.html#isKeyFrame()">isKeyFrame</a>, <a href="../decoder/Buffer.html#isLastSample()">isLastSample</a>, <a href="../decoder/Buffer.html#setFlags(@com.google.android.exoplayer2.C.BufferFlagsint)">setFlags</a></code></li>
285285
</ul>
286286
<ul class="blockList">
287287
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

0 commit comments

Comments
 (0)