|
2 | 2 | <!-- NewPage --> |
3 | 3 | <html lang="en"> |
4 | 4 | <head> |
5 | | -<!-- Generated by javadoc (1.8.0_101) on Thu Oct 20 12:37:32 BST 2016 --> |
| 5 | +<!-- Generated by javadoc (1.8.0_45-internal) on Tue Dec 20 12:04:43 GMT 2016 --> |
6 | 6 | <title>BaseRenderer (library API)</title> |
7 | | -<meta name="date" content="2016-10-20"> |
| 7 | +<meta name="date" content="2016-12-20"> |
8 | 8 | <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
9 | 9 | <script type="text/javascript" src="../../../../script.js"></script> |
10 | 10 | </head> |
|
18 | 18 | catch(err) { |
19 | 19 | } |
20 | 20 | //--> |
21 | | -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10}; |
| 21 | +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10}; |
22 | 22 | var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
23 | 23 | var altColor = "altColor"; |
24 | 24 | var rowColor = "rowColor"; |
@@ -244,108 +244,115 @@ <h3>Method Summary</h3> |
244 | 244 | </td> |
245 | 245 | </tr> |
246 | 246 | <tr id="i10" class="altColor"> |
| 247 | +<td class="colFirst"><code>boolean</code></td> |
| 248 | +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#isCurrentStreamFinal--">isCurrentStreamFinal</a></span>()</code> |
| 249 | +<div class="block">Returns whether the current <a href="../../../../com/google/android/exoplayer2/source/SampleStream.html" title="interface in com.google.android.exoplayer2.source"><code>SampleStream</code></a> will be the final one supplied before the |
| 250 | + renderer is next disabled or reset.</div> |
| 251 | +</td> |
| 252 | +</tr> |
| 253 | +<tr id="i11" class="rowColor"> |
247 | 254 | <td class="colFirst"><code>protected boolean</code></td> |
248 | 255 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#isSourceReady--">isSourceReady</a></span>()</code> |
249 | 256 | <div class="block">Returns whether the upstream source is ready.</div> |
250 | 257 | </td> |
251 | 258 | </tr> |
252 | | -<tr id="i11" class="rowColor"> |
| 259 | +<tr id="i12" class="altColor"> |
253 | 260 | <td class="colFirst"><code>void</code></td> |
254 | 261 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#maybeThrowStreamError--">maybeThrowStreamError</a></span>()</code> |
255 | 262 | <div class="block">Throws an error that's preventing the renderer from reading from its <a href="../../../../com/google/android/exoplayer2/source/SampleStream.html" title="interface in com.google.android.exoplayer2.source"><code>SampleStream</code></a>.</div> |
256 | 263 | </td> |
257 | 264 | </tr> |
258 | | -<tr id="i12" class="altColor"> |
| 265 | +<tr id="i13" class="rowColor"> |
259 | 266 | <td class="colFirst"><code>protected void</code></td> |
260 | 267 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#onDisabled--">onDisabled</a></span>()</code> |
261 | 268 | <div class="block">Called when the renderer is disabled.</div> |
262 | 269 | </td> |
263 | 270 | </tr> |
264 | | -<tr id="i13" class="rowColor"> |
| 271 | +<tr id="i14" class="altColor"> |
265 | 272 | <td class="colFirst"><code>protected void</code></td> |
266 | 273 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#onEnabled-boolean-">onEnabled</a></span>(boolean joining)</code> |
267 | 274 | <div class="block">Called when the renderer is enabled.</div> |
268 | 275 | </td> |
269 | 276 | </tr> |
270 | | -<tr id="i14" class="altColor"> |
| 277 | +<tr id="i15" class="rowColor"> |
271 | 278 | <td class="colFirst"><code>protected void</code></td> |
272 | 279 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#onPositionReset-long-boolean-">onPositionReset</a></span>(long positionUs, |
273 | 280 | boolean joining)</code> |
274 | 281 | <div class="block">Called when the position is reset.</div> |
275 | 282 | </td> |
276 | 283 | </tr> |
277 | | -<tr id="i15" class="rowColor"> |
| 284 | +<tr id="i16" class="altColor"> |
278 | 285 | <td class="colFirst"><code>protected void</code></td> |
279 | 286 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#onStarted--">onStarted</a></span>()</code> |
280 | 287 | <div class="block">Called when the renderer is started.</div> |
281 | 288 | </td> |
282 | 289 | </tr> |
283 | | -<tr id="i16" class="altColor"> |
| 290 | +<tr id="i17" class="rowColor"> |
284 | 291 | <td class="colFirst"><code>protected void</code></td> |
285 | 292 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#onStopped--">onStopped</a></span>()</code> |
286 | 293 | <div class="block">Called when the renderer is stopped.</div> |
287 | 294 | </td> |
288 | 295 | </tr> |
289 | | -<tr id="i17" class="rowColor"> |
| 296 | +<tr id="i18" class="altColor"> |
290 | 297 | <td class="colFirst"><code>protected void</code></td> |
291 | 298 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#onStreamChanged-com.google.android.exoplayer2.Format:A-">onStreamChanged</a></span>(<a href="../../../../com/google/android/exoplayer2/Format.html" title="class in com.google.android.exoplayer2">Format</a>[] formats)</code> |
292 | 299 | <div class="block">Called when the renderer's stream has changed.</div> |
293 | 300 | </td> |
294 | 301 | </tr> |
295 | | -<tr id="i18" class="altColor"> |
| 302 | +<tr id="i19" class="rowColor"> |
296 | 303 | <td class="colFirst"><code>protected int</code></td> |
297 | 304 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#readSource-com.google.android.exoplayer2.FormatHolder-com.google.android.exoplayer2.decoder.DecoderInputBuffer-">readSource</a></span>(<a href="../../../../com/google/android/exoplayer2/FormatHolder.html" title="class in com.google.android.exoplayer2">FormatHolder</a> formatHolder, |
298 | 305 | <a href="../../../../com/google/android/exoplayer2/decoder/DecoderInputBuffer.html" title="class in com.google.android.exoplayer2.decoder">DecoderInputBuffer</a> buffer)</code> |
299 | 306 | <div class="block">Reads from the enabled upstream source.</div> |
300 | 307 | </td> |
301 | 308 | </tr> |
302 | | -<tr id="i19" class="rowColor"> |
| 309 | +<tr id="i20" class="altColor"> |
303 | 310 | <td class="colFirst"><code>void</code></td> |
304 | 311 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#replaceStream-com.google.android.exoplayer2.Format:A-com.google.android.exoplayer2.source.SampleStream-long-">replaceStream</a></span>(<a href="../../../../com/google/android/exoplayer2/Format.html" title="class in com.google.android.exoplayer2">Format</a>[] formats, |
305 | 312 | <a href="../../../../com/google/android/exoplayer2/source/SampleStream.html" title="interface in com.google.android.exoplayer2.source">SampleStream</a> stream, |
306 | 313 | long offsetUs)</code> |
307 | 314 | <div class="block">Replaces the <a href="../../../../com/google/android/exoplayer2/source/SampleStream.html" title="interface in com.google.android.exoplayer2.source"><code>SampleStream</code></a> from which samples will be consumed.</div> |
308 | 315 | </td> |
309 | 316 | </tr> |
310 | | -<tr id="i20" class="altColor"> |
| 317 | +<tr id="i21" class="rowColor"> |
311 | 318 | <td class="colFirst"><code>void</code></td> |
312 | 319 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#resetPosition-long-">resetPosition</a></span>(long positionUs)</code> |
313 | 320 | <div class="block">Signals to the renderer that a position discontinuity has occurred.</div> |
314 | 321 | </td> |
315 | 322 | </tr> |
316 | | -<tr id="i21" class="rowColor"> |
| 323 | +<tr id="i22" class="altColor"> |
317 | 324 | <td class="colFirst"><code>void</code></td> |
318 | | -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#setCurrentStreamIsFinal--">setCurrentStreamIsFinal</a></span>()</code> |
| 325 | +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#setCurrentStreamFinal--">setCurrentStreamFinal</a></span>()</code> |
319 | 326 | <div class="block">Signals to the renderer that the current <a href="../../../../com/google/android/exoplayer2/source/SampleStream.html" title="interface in com.google.android.exoplayer2.source"><code>SampleStream</code></a> will be the final one supplied |
320 | 327 | before it is next disabled or reset.</div> |
321 | 328 | </td> |
322 | 329 | </tr> |
323 | | -<tr id="i22" class="altColor"> |
| 330 | +<tr id="i23" class="rowColor"> |
324 | 331 | <td class="colFirst"><code>void</code></td> |
325 | 332 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#setIndex-int-">setIndex</a></span>(int index)</code> |
326 | 333 | <div class="block">Sets the index of this renderer within the player.</div> |
327 | 334 | </td> |
328 | 335 | </tr> |
329 | | -<tr id="i23" class="rowColor"> |
| 336 | +<tr id="i24" class="altColor"> |
330 | 337 | <td class="colFirst"><code>protected void</code></td> |
331 | 338 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#skipToKeyframeBefore-long-">skipToKeyframeBefore</a></span>(long timeUs)</code> |
332 | 339 | <div class="block">Attempts to skip to the keyframe before the specified time.</div> |
333 | 340 | </td> |
334 | 341 | </tr> |
335 | | -<tr id="i24" class="altColor"> |
| 342 | +<tr id="i25" class="rowColor"> |
336 | 343 | <td class="colFirst"><code>void</code></td> |
337 | 344 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#start--">start</a></span>()</code> |
338 | 345 | <div class="block">Starts the renderer, meaning that calls to <a href="../../../../com/google/android/exoplayer2/Renderer.html#render-long-long-"><code>Renderer.render(long, long)</code></a> will cause media to be |
339 | 346 | rendered.</div> |
340 | 347 | </td> |
341 | 348 | </tr> |
342 | | -<tr id="i25" class="rowColor"> |
| 349 | +<tr id="i26" class="altColor"> |
343 | 350 | <td class="colFirst"><code>void</code></td> |
344 | 351 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#stop--">stop</a></span>()</code> |
345 | 352 | <div class="block">Stops the renderer, transitioning it to the <a href="../../../../com/google/android/exoplayer2/Renderer.html#STATE_ENABLED"><code>Renderer.STATE_ENABLED</code></a> state.</div> |
346 | 353 | </td> |
347 | 354 | </tr> |
348 | | -<tr id="i26" class="altColor"> |
| 355 | +<tr id="i27" class="rowColor"> |
349 | 356 | <td class="colFirst"><code>int</code></td> |
350 | 357 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#supportsMixedMimeTypeAdaptation--">supportsMixedMimeTypeAdaptation</a></span>()</code> |
351 | 358 | <div class="block">Returns the extent to which the <a href="../../../../com/google/android/exoplayer2/Renderer.html" title="interface in com.google.android.exoplayer2"><code>Renderer</code></a> supports adapting between supported formats |
@@ -619,22 +626,38 @@ <h4>hasReadStreamToEnd</h4> |
619 | 626 | </dl> |
620 | 627 | </li> |
621 | 628 | </ul> |
622 | | -<a name="setCurrentStreamIsFinal--"> |
| 629 | +<a name="setCurrentStreamFinal--"> |
623 | 630 | <!-- --> |
624 | 631 | </a> |
625 | 632 | <ul class="blockList"> |
626 | 633 | <li class="blockList"> |
627 | | -<h4>setCurrentStreamIsFinal</h4> |
628 | | -<pre>public final void setCurrentStreamIsFinal()</pre> |
629 | | -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../com/google/android/exoplayer2/Renderer.html#setCurrentStreamIsFinal--">Renderer</a></code></span></div> |
| 634 | +<h4>setCurrentStreamFinal</h4> |
| 635 | +<pre>public final void setCurrentStreamFinal()</pre> |
| 636 | +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../com/google/android/exoplayer2/Renderer.html#setCurrentStreamFinal--">Renderer</a></code></span></div> |
630 | 637 | <div class="block">Signals to the renderer that the current <a href="../../../../com/google/android/exoplayer2/source/SampleStream.html" title="interface in com.google.android.exoplayer2.source"><code>SampleStream</code></a> will be the final one supplied |
631 | 638 | before it is next disabled or reset. |
632 | 639 | <p> |
633 | 640 | This method may be called when the renderer is in the following states: |
634 | 641 | <a href="../../../../com/google/android/exoplayer2/Renderer.html#STATE_ENABLED"><code>Renderer.STATE_ENABLED</code></a>, <a href="../../../../com/google/android/exoplayer2/Renderer.html#STATE_STARTED"><code>Renderer.STATE_STARTED</code></a>.</div> |
635 | 642 | <dl> |
636 | 643 | <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
637 | | -<dd><code><a href="../../../../com/google/android/exoplayer2/Renderer.html#setCurrentStreamIsFinal--">setCurrentStreamIsFinal</a></code> in interface <code><a href="../../../../com/google/android/exoplayer2/Renderer.html" title="interface in com.google.android.exoplayer2">Renderer</a></code></dd> |
| 644 | +<dd><code><a href="../../../../com/google/android/exoplayer2/Renderer.html#setCurrentStreamFinal--">setCurrentStreamFinal</a></code> in interface <code><a href="../../../../com/google/android/exoplayer2/Renderer.html" title="interface in com.google.android.exoplayer2">Renderer</a></code></dd> |
| 645 | +</dl> |
| 646 | +</li> |
| 647 | +</ul> |
| 648 | +<a name="isCurrentStreamFinal--"> |
| 649 | +<!-- --> |
| 650 | +</a> |
| 651 | +<ul class="blockList"> |
| 652 | +<li class="blockList"> |
| 653 | +<h4>isCurrentStreamFinal</h4> |
| 654 | +<pre>public final boolean isCurrentStreamFinal()</pre> |
| 655 | +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../com/google/android/exoplayer2/Renderer.html#isCurrentStreamFinal--">Renderer</a></code></span></div> |
| 656 | +<div class="block">Returns whether the current <a href="../../../../com/google/android/exoplayer2/source/SampleStream.html" title="interface in com.google.android.exoplayer2.source"><code>SampleStream</code></a> will be the final one supplied before the |
| 657 | + renderer is next disabled or reset.</div> |
| 658 | +<dl> |
| 659 | +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| 660 | +<dd><code><a href="../../../../com/google/android/exoplayer2/Renderer.html#isCurrentStreamFinal--">isCurrentStreamFinal</a></code> in interface <code><a href="../../../../com/google/android/exoplayer2/Renderer.html" title="interface in com.google.android.exoplayer2">Renderer</a></code></dd> |
638 | 661 | </dl> |
639 | 662 | </li> |
640 | 663 | </ul> |
@@ -906,7 +929,7 @@ <h4>readSource</h4> |
906 | 929 | <pre>protected final int readSource(<a href="../../../../com/google/android/exoplayer2/FormatHolder.html" title="class in com.google.android.exoplayer2">FormatHolder</a> formatHolder, |
907 | 930 | <a href="../../../../com/google/android/exoplayer2/decoder/DecoderInputBuffer.html" title="class in com.google.android.exoplayer2.decoder">DecoderInputBuffer</a> buffer)</pre> |
908 | 931 | <div class="block">Reads from the enabled upstream source. If the upstream source has been read to the end then |
909 | | - <a href="../../../../com/google/android/exoplayer2/C.html#RESULT_BUFFER_READ"><code>C.RESULT_BUFFER_READ</code></a> is only returned if <a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#setCurrentStreamIsFinal--"><code>setCurrentStreamIsFinal()</code></a> has been |
| 932 | + <a href="../../../../com/google/android/exoplayer2/C.html#RESULT_BUFFER_READ"><code>C.RESULT_BUFFER_READ</code></a> is only returned if <a href="../../../../com/google/android/exoplayer2/BaseRenderer.html#setCurrentStreamFinal--"><code>setCurrentStreamFinal()</code></a> has been |
910 | 933 | called. <a href="../../../../com/google/android/exoplayer2/C.html#RESULT_NOTHING_READ"><code>C.RESULT_NOTHING_READ</code></a> is returned otherwise.</div> |
911 | 934 | <dl> |
912 | 935 | <dt><span class="paramLabel">Parameters:</span></dt> |
|
0 commit comments