Skip to content

Commit 05ac6ab

Browse files
committed
Update Javadoc for 2.18.4
PiperOrigin-RevId: 513516267 (cherry picked from commit 658b503)
1 parent c641307 commit 05ac6ab

28 files changed

+65333
-175
lines changed

docs/doc/reference/allclasses-index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3657,7 +3657,7 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
36573657
<tr id="i580" class="altColor">
36583658
<td class="colFirst"><a href="com/google/android/exoplayer2/ForwardingPlayer.html" title="class in com.google.android.exoplayer2">ForwardingPlayer</a></td>
36593659
<th class="colLast" scope="row">
3660-
<div class="block">A <a href="com/google/android/exoplayer2/Player.html" title="interface in com.google.android.exoplayer2"><code>Player</code></a> that forwards operations to another <a href="com/google/android/exoplayer2/Player.html" title="interface in com.google.android.exoplayer2"><code>Player</code></a>.</div>
3660+
<div class="block">A <a href="com/google/android/exoplayer2/Player.html" title="interface in com.google.android.exoplayer2"><code>Player</code></a> that forwards method calls to another <a href="com/google/android/exoplayer2/Player.html" title="interface in com.google.android.exoplayer2"><code>Player</code></a>.</div>
36613661
</th>
36623662
</tr>
36633663
<tr id="i581" class="rowColor">
@@ -7767,7 +7767,7 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
77677767
<tr id="i1256" class="altColor">
77687768
<td class="colFirst"><a href="com/google/android/exoplayer2/text/webvtt/WebvttCssStyle.html" title="class in com.google.android.exoplayer2.text.webvtt">WebvttCssStyle</a></td>
77697769
<th class="colLast" scope="row">
7770-
<div class="block">Style object of a Css style block in a Webvtt file.</div>
7770+
<div class="block">Style object of a CSS style block in a WebVTT file.</div>
77717771
</th>
77727772
</tr>
77737773
<tr id="i1257" class="rowColor">

docs/doc/reference/com/google/android/exoplayer2/C.SpatializationBehavior.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ <h2 title="Annotation Type C.SpatializationBehavior" class="title">Annotation Ty
117117
<a href="https://developer.android.com/reference/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="externalLink">@Retention</a>(<a href="https://developer.android.com/reference/java/lang/annotation/RetentionPolicy.html?is-external=true#SOURCE" title="class or interface in java.lang.annotation" class="externalLink" target="_top">SOURCE</a>)
118118
<a href="https://developer.android.com/reference/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="externalLink">@Target</a>(<a href="https://developer.android.com/reference/java/lang/annotation/ElementType.html?is-external=true#TYPE_USE" title="class or interface in java.lang.annotation" class="externalLink" target="_top">TYPE_USE</a>)
119119
public static @interface <span class="memberNameLabel">C.SpatializationBehavior</span></pre>
120-
<div class="block">Represents the behavior affecting whether spatialization will be used.</div>
120+
<div class="block">Represents the behavior affecting whether spatialization will be used. One of <a href="C.html#SPATIALIZATION_BEHAVIOR_AUTO"><code>C.SPATIALIZATION_BEHAVIOR_AUTO</code></a> or <a href="C.html#SPATIALIZATION_BEHAVIOR_NEVER"><code>C.SPATIALIZATION_BEHAVIOR_NEVER</code></a>.</div>
121121
</li>
122122
</ul>
123123
</div>

docs/doc/reference/com/google/android/exoplayer2/ForwardingPlayer.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ <h2 title="Class ForwardingPlayer" class="title">Class ForwardingPlayer</h2>
136136
<pre>public class <span class="typeNameLabel">ForwardingPlayer</span>
137137
extends <a href="https://developer.android.com/reference/java/lang/Object.html" title="class or interface in java.lang" class="externalLink" target="_top">Object</a>
138138
implements <a href="Player.html" title="interface in com.google.android.exoplayer2">Player</a></pre>
139-
<div class="block">A <a href="Player.html" title="interface in com.google.android.exoplayer2"><code>Player</code></a> that forwards operations to another <a href="Player.html" title="interface in com.google.android.exoplayer2"><code>Player</code></a>. Applications can use this
139+
<div class="block">A <a href="Player.html" title="interface in com.google.android.exoplayer2"><code>Player</code></a> that forwards method calls to another <a href="Player.html" title="interface in com.google.android.exoplayer2"><code>Player</code></a>. Applications can use this
140140
class to suppress or modify specific operations, by overriding the respective methods.</div>
141141
</li>
142142
</ul>

docs/doc/reference/com/google/android/exoplayer2/extractor/FlacStreamMetadata.html

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -131,18 +131,20 @@ <h2 title="Class FlacStreamMetadata" class="title">Class FlacStreamMetadata</h2>
131131
<hr>
132132
<pre>public final class <span class="typeNameLabel">FlacStreamMetadata</span>
133133
extends <a href="https://developer.android.com/reference/java/lang/Object.html" title="class or interface in java.lang" class="externalLink" target="_top">Object</a></pre>
134-
<div class="block">Holder for FLAC metadata.</div>
135-
<dl>
136-
<dt><span class="seeLabel">See Also:</span></dt>
137-
<dd><a href="https://xiph.org/flac/format.html#metadata_block_streaminfo">FLAC format
138-
METADATA_BLOCK_STREAMINFO</a>,
139-
<a href="https://xiph.org/flac/format.html#metadata_block_seektable">FLAC format
140-
METADATA_BLOCK_SEEKTABLE</a>,
141-
<a href="https://xiph.org/flac/format.html#metadata_block_vorbis_comment">FLAC format
142-
METADATA_BLOCK_VORBIS_COMMENT</a>,
143-
<a href="https://xiph.org/flac/format.html#metadata_block_picture">FLAC format
144-
METADATA_BLOCK_PICTURE</a></dd>
145-
</dl>
134+
<div class="block">Holder for FLAC metadata.
135+
136+
<p>See the following spec references:
137+
138+
<ul>
139+
<li><a href="https://xiph.org/flac/format.html#metadata_block_streaminfo">FLAC format
140+
METADATA_BLOCK_STREAMINFO</a>
141+
<li><a href="https://xiph.org/flac/format.html#metadata_block_seektable">FLAC format
142+
METADATA_BLOCK_SEEKTABLE</a>
143+
<li><a href="https://xiph.org/flac/format.html#metadata_block_vorbis_comment">FLAC format
144+
METADATA_BLOCK_VORBIS_COMMENT</a>
145+
<li><a href="https://xiph.org/flac/format.html#metadata_block_picture">FLAC format
146+
METADATA_BLOCK_PICTURE</a>
147+
</ul></div>
146148
</li>
147149
</ul>
148150
</div>

docs/doc/reference/com/google/android/exoplayer2/extractor/VorbisBitArray.html

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -131,12 +131,10 @@ <h2 title="Class VorbisBitArray" class="title">Class VorbisBitArray</h2>
131131
<hr>
132132
<pre>public final class <span class="typeNameLabel">VorbisBitArray</span>
133133
extends <a href="https://developer.android.com/reference/java/lang/Object.html" title="class or interface in java.lang" class="externalLink" target="_top">Object</a></pre>
134-
<div class="block">Wraps a byte array, providing methods that allow it to be read as a Vorbis bitstream.</div>
135-
<dl>
136-
<dt><span class="seeLabel">See Also:</span></dt>
137-
<dd><a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-360002">Vorbis bitpacking
138-
specification</a></dd>
139-
</dl>
134+
<div class="block">Wraps a byte array, providing methods that allow it to be read as a Vorbis bitstream.
135+
136+
<p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-360002">Vorbis
137+
bitpacking specification</a></div>
140138
</li>
141139
</ul>
142140
</div>

docs/doc/reference/com/google/android/exoplayer2/extractor/VorbisUtil.VorbisIdHeader.html

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -129,12 +129,10 @@ <h2 title="Class VorbisUtil.VorbisIdHeader" class="title">Class VorbisUtil.Vorbi
129129
<hr>
130130
<pre>public static final class <span class="typeNameLabel">VorbisUtil.VorbisIdHeader</span>
131131
extends <a href="https://developer.android.com/reference/java/lang/Object.html" title="class or interface in java.lang" class="externalLink" target="_top">Object</a></pre>
132-
<div class="block">Vorbis identification header.</div>
133-
<dl>
134-
<dt><span class="seeLabel">See Also:</span></dt>
135-
<dd><a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-630004.2.2">Vorbis
136-
spec/Identification header</a></dd>
137-
</dl>
132+
<div class="block">Vorbis identification header.
133+
134+
<p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-630004.2.2">Vorbis
135+
spec/Identification header</a></div>
138136
</li>
139137
</ul>
140138
</div>

docs/doc/reference/com/google/android/exoplayer2/extractor/VorbisUtil.html

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -277,15 +277,15 @@ <h3>Method Detail</h3>
277277
<li class="blockList">
278278
<h4>iLog</h4>
279279
<pre class="methodSignature">public static&nbsp;int&nbsp;iLog&#8203;(int&nbsp;x)</pre>
280-
<div class="block">Returns ilog(x), which is the index of the highest set bit in <code>x</code>.</div>
280+
<div class="block">Returns ilog(x), which is the index of the highest set bit in <code>x</code>.
281+
282+
<p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-1190009.2.1">Vorbis
283+
spec</a></div>
281284
<dl>
282285
<dt><span class="paramLabel">Parameters:</span></dt>
283286
<dd><code>x</code> - the value of which the ilog should be calculated.</dd>
284287
<dt><span class="returnLabel">Returns:</span></dt>
285288
<dd>ilog(x)</dd>
286-
<dt><span class="seeLabel">See Also:</span></dt>
287-
<dd><a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-1190009.2.1">Vorbis
288-
spec</a></dd>
289289
</dl>
290290
</li>
291291
</ul>
@@ -297,17 +297,17 @@ <h4>iLog</h4>
297297
<h4>readVorbisIdentificationHeader</h4>
298298
<pre class="methodSignature">public static&nbsp;<a href="VorbisUtil.VorbisIdHeader.html" title="class in com.google.android.exoplayer2.extractor">VorbisUtil.VorbisIdHeader</a>&nbsp;readVorbisIdentificationHeader&#8203;(<a href="../util/ParsableByteArray.html" title="class in com.google.android.exoplayer2.util">ParsableByteArray</a>&nbsp;headerData)
299299
throws <a href="../ParserException.html" title="class in com.google.android.exoplayer2">ParserException</a></pre>
300-
<div class="block">Reads a Vorbis identification header from <code>headerData</code>.</div>
300+
<div class="block">Reads a Vorbis identification header from <code>headerData</code>.
301+
302+
<p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-630004.2.2">Vorbis
303+
spec/Identification header</a></div>
301304
<dl>
302305
<dt><span class="paramLabel">Parameters:</span></dt>
303306
<dd><code>headerData</code> - a <a href="../util/ParsableByteArray.html" title="class in com.google.android.exoplayer2.util"><code>ParsableByteArray</code></a> wrapping the header data.</dd>
304307
<dt><span class="returnLabel">Returns:</span></dt>
305308
<dd>a <a href="VorbisUtil.VorbisIdHeader.html" title="class in com.google.android.exoplayer2.extractor"><code>VorbisUtil.VorbisIdHeader</code></a> with meta data.</dd>
306309
<dt><span class="throwsLabel">Throws:</span></dt>
307310
<dd><code><a href="../ParserException.html" title="class in com.google.android.exoplayer2">ParserException</a></code> - thrown if invalid capture pattern is detected.</dd>
308-
<dt><span class="seeLabel">See Also:</span></dt>
309-
<dd><a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-630004.2.2">Vorbis
310-
spec/Identification header</a></dd>
311311
</dl>
312312
</li>
313313
</ul>
@@ -319,17 +319,17 @@ <h4>readVorbisIdentificationHeader</h4>
319319
<h4>readVorbisCommentHeader</h4>
320320
<pre class="methodSignature">public static&nbsp;<a href="VorbisUtil.CommentHeader.html" title="class in com.google.android.exoplayer2.extractor">VorbisUtil.CommentHeader</a>&nbsp;readVorbisCommentHeader&#8203;(<a href="../util/ParsableByteArray.html" title="class in com.google.android.exoplayer2.util">ParsableByteArray</a>&nbsp;headerData)
321321
throws <a href="../ParserException.html" title="class in com.google.android.exoplayer2">ParserException</a></pre>
322-
<div class="block">Reads a Vorbis comment header.</div>
322+
<div class="block">Reads a Vorbis comment header.
323+
324+
<p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-640004.2.3">Vorbis
325+
spec/Comment header</a></div>
323326
<dl>
324327
<dt><span class="paramLabel">Parameters:</span></dt>
325328
<dd><code>headerData</code> - A <a href="../util/ParsableByteArray.html" title="class in com.google.android.exoplayer2.util"><code>ParsableByteArray</code></a> wrapping the header data.</dd>
326329
<dt><span class="returnLabel">Returns:</span></dt>
327330
<dd>A <a href="VorbisUtil.CommentHeader.html" title="class in com.google.android.exoplayer2.extractor"><code>VorbisUtil.CommentHeader</code></a> with all the comments.</dd>
328331
<dt><span class="throwsLabel">Throws:</span></dt>
329332
<dd><code><a href="../ParserException.html" title="class in com.google.android.exoplayer2">ParserException</a></code> - If an error occurs parsing the comment header.</dd>
330-
<dt><span class="seeLabel">See Also:</span></dt>
331-
<dd><a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-640004.2.3">Vorbis
332-
spec/Comment header</a></dd>
333333
</dl>
334334
</li>
335335
</ul>
@@ -345,7 +345,10 @@ <h4>readVorbisCommentHeader</h4>
345345
throws <a href="../ParserException.html" title="class in com.google.android.exoplayer2">ParserException</a></pre>
346346
<div class="block">Reads a Vorbis comment header.
347347

348-
<p>The data provided may not contain the Vorbis metadata common header and the framing bit.</div>
348+
<p>The data provided may not contain the Vorbis metadata common header and the framing bit.
349+
350+
<p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-640004.2.3">Vorbis
351+
spec/Comment header</a></div>
349352
<dl>
350353
<dt><span class="paramLabel">Parameters:</span></dt>
351354
<dd><code>headerData</code> - A <a href="../util/ParsableByteArray.html" title="class in com.google.android.exoplayer2.util"><code>ParsableByteArray</code></a> wrapping the header data.</dd>
@@ -356,9 +359,6 @@ <h4>readVorbisCommentHeader</h4>
356359
<dd>A <a href="VorbisUtil.CommentHeader.html" title="class in com.google.android.exoplayer2.extractor"><code>VorbisUtil.CommentHeader</code></a> with all the comments.</dd>
357360
<dt><span class="throwsLabel">Throws:</span></dt>
358361
<dd><code><a href="../ParserException.html" title="class in com.google.android.exoplayer2">ParserException</a></code> - If an error occurs parsing the comment header.</dd>
359-
<dt><span class="seeLabel">See Also:</span></dt>
360-
<dd><a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-640004.2.3">Vorbis
361-
spec/Comment header</a></dd>
362362
</dl>
363363
</li>
364364
</ul>
@@ -417,7 +417,10 @@ <h4>readVorbisModes</h4>
417417
throws <a href="../ParserException.html" title="class in com.google.android.exoplayer2">ParserException</a></pre>
418418
<div class="block">This method reads the modes which are located at the very end of the Vorbis setup header.
419419
That's why we need to partially decode or at least read the entire setup header to know where
420-
to start reading the modes.</div>
420+
to start reading the modes.
421+
422+
<p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-650004.2.4">Vorbis
423+
spec/Setup header</a></div>
421424
<dl>
422425
<dt><span class="paramLabel">Parameters:</span></dt>
423426
<dd><code>headerData</code> - a <a href="../util/ParsableByteArray.html" title="class in com.google.android.exoplayer2.util"><code>ParsableByteArray</code></a> containing setup header data.</dd>
@@ -426,9 +429,6 @@ <h4>readVorbisModes</h4>
426429
<dd>an array of <a href="VorbisUtil.Mode.html" title="class in com.google.android.exoplayer2.extractor"><code>VorbisUtil.Mode</code></a>s.</dd>
427430
<dt><span class="throwsLabel">Throws:</span></dt>
428431
<dd><code><a href="../ParserException.html" title="class in com.google.android.exoplayer2">ParserException</a></code> - thrown if bit stream is invalid.</dd>
429-
<dt><span class="seeLabel">See Also:</span></dt>
430-
<dd><a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-650004.2.4">Vorbis
431-
spec/Setup header</a></dd>
432432
</dl>
433433
</li>
434434
</ul>

0 commit comments

Comments
 (0)