Skip to content

Commit

Permalink
Update Javadoc for 2.18.4
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 513516267
(cherry picked from commit 658b503)
  • Loading branch information
tonihei committed Mar 2, 2023
1 parent c641307 commit 05ac6ab
Show file tree
Hide file tree
Showing 28 changed files with 65,333 additions and 175 deletions.
4 changes: 2 additions & 2 deletions docs/doc/reference/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3657,7 +3657,7 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
<tr id="i580" class="altColor">
<td class="colFirst"><a href="com/google/android/exoplayer2/ForwardingPlayer.html" title="class in com.google.android.exoplayer2">ForwardingPlayer</a></td>
<th class="colLast" scope="row">
<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>
<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>
</th>
</tr>
<tr id="i581" class="rowColor">
Expand Down Expand Up @@ -7767,7 +7767,7 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
<tr id="i1256" class="altColor">
<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>
<th class="colLast" scope="row">
<div class="block">Style object of a Css style block in a Webvtt file.</div>
<div class="block">Style object of a CSS style block in a WebVTT file.</div>
</th>
</tr>
<tr id="i1257" class="rowColor">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ <h2 title="Annotation Type C.SpatializationBehavior" class="title">Annotation Ty
<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>)
<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>)
public static @interface <span class="memberNameLabel">C.SpatializationBehavior</span></pre>
<div class="block">Represents the behavior affecting whether spatialization will be used.</div>
<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>
</li>
</ul>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h2 title="Class ForwardingPlayer" class="title">Class ForwardingPlayer</h2>
<pre>public class <span class="typeNameLabel">ForwardingPlayer</span>
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>
implements <a href="Player.html" title="interface in com.google.android.exoplayer2">Player</a></pre>
<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
<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
class to suppress or modify specific operations, by overriding the respective methods.</div>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,18 +131,20 @@ <h2 title="Class FlacStreamMetadata" class="title">Class FlacStreamMetadata</h2>
<hr>
<pre>public final class <span class="typeNameLabel">FlacStreamMetadata</span>
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>
<div class="block">Holder for FLAC metadata.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://xiph.org/flac/format.html#metadata_block_streaminfo">FLAC format
METADATA_BLOCK_STREAMINFO</a>,
<a href="https://xiph.org/flac/format.html#metadata_block_seektable">FLAC format
METADATA_BLOCK_SEEKTABLE</a>,
<a href="https://xiph.org/flac/format.html#metadata_block_vorbis_comment">FLAC format
METADATA_BLOCK_VORBIS_COMMENT</a>,
<a href="https://xiph.org/flac/format.html#metadata_block_picture">FLAC format
METADATA_BLOCK_PICTURE</a></dd>
</dl>
<div class="block">Holder for FLAC metadata.

<p>See the following spec references:

<ul>
<li><a href="https://xiph.org/flac/format.html#metadata_block_streaminfo">FLAC format
METADATA_BLOCK_STREAMINFO</a>
<li><a href="https://xiph.org/flac/format.html#metadata_block_seektable">FLAC format
METADATA_BLOCK_SEEKTABLE</a>
<li><a href="https://xiph.org/flac/format.html#metadata_block_vorbis_comment">FLAC format
METADATA_BLOCK_VORBIS_COMMENT</a>
<li><a href="https://xiph.org/flac/format.html#metadata_block_picture">FLAC format
METADATA_BLOCK_PICTURE</a>
</ul></div>
</li>
</ul>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,12 +131,10 @@ <h2 title="Class VorbisBitArray" class="title">Class VorbisBitArray</h2>
<hr>
<pre>public final class <span class="typeNameLabel">VorbisBitArray</span>
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>
<div class="block">Wraps a byte array, providing methods that allow it to be read as a Vorbis bitstream.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-360002">Vorbis bitpacking
specification</a></dd>
</dl>
<div class="block">Wraps a byte array, providing methods that allow it to be read as a Vorbis bitstream.

<p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-360002">Vorbis
bitpacking specification</a></div>
</li>
</ul>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,12 +129,10 @@ <h2 title="Class VorbisUtil.VorbisIdHeader" class="title">Class VorbisUtil.Vorbi
<hr>
<pre>public static final class <span class="typeNameLabel">VorbisUtil.VorbisIdHeader</span>
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>
<div class="block">Vorbis identification header.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-630004.2.2">Vorbis
spec/Identification header</a></dd>
</dl>
<div class="block">Vorbis identification header.

<p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-630004.2.2">Vorbis
spec/Identification header</a></div>
</li>
</ul>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -277,15 +277,15 @@ <h3>Method Detail</h3>
<li class="blockList">
<h4>iLog</h4>
<pre class="methodSignature">public static&nbsp;int&nbsp;iLog&#8203;(int&nbsp;x)</pre>
<div class="block">Returns ilog(x), which is the index of the highest set bit in <code>x</code>.</div>
<div class="block">Returns ilog(x), which is the index of the highest set bit in <code>x</code>.

<p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-1190009.2.1">Vorbis
spec</a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>x</code> - the value of which the ilog should be calculated.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ilog(x)</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-1190009.2.1">Vorbis
spec</a></dd>
</dl>
</li>
</ul>
Expand All @@ -297,17 +297,17 @@ <h4>iLog</h4>
<h4>readVorbisIdentificationHeader</h4>
<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)
throws <a href="../ParserException.html" title="class in com.google.android.exoplayer2">ParserException</a></pre>
<div class="block">Reads a Vorbis identification header from <code>headerData</code>.</div>
<div class="block">Reads a Vorbis identification header from <code>headerData</code>.

<p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-630004.2.2">Vorbis
spec/Identification header</a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="VorbisUtil.VorbisIdHeader.html" title="class in com.google.android.exoplayer2.extractor"><code>VorbisUtil.VorbisIdHeader</code></a> with meta data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../ParserException.html" title="class in com.google.android.exoplayer2">ParserException</a></code> - thrown if invalid capture pattern is detected.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-630004.2.2">Vorbis
spec/Identification header</a></dd>
</dl>
</li>
</ul>
Expand All @@ -319,17 +319,17 @@ <h4>readVorbisIdentificationHeader</h4>
<h4>readVorbisCommentHeader</h4>
<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)
throws <a href="../ParserException.html" title="class in com.google.android.exoplayer2">ParserException</a></pre>
<div class="block">Reads a Vorbis comment header.</div>
<div class="block">Reads a Vorbis comment header.

<p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-640004.2.3">Vorbis
spec/Comment header</a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<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>
<dt><span class="returnLabel">Returns:</span></dt>
<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>
<dt><span class="throwsLabel">Throws:</span></dt>
<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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-640004.2.3">Vorbis
spec/Comment header</a></dd>
</dl>
</li>
</ul>
Expand All @@ -345,7 +345,10 @@ <h4>readVorbisCommentHeader</h4>
throws <a href="../ParserException.html" title="class in com.google.android.exoplayer2">ParserException</a></pre>
<div class="block">Reads a Vorbis comment header.

<p>The data provided may not contain the Vorbis metadata common header and the framing bit.</div>
<p>The data provided may not contain the Vorbis metadata common header and the framing bit.

<p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-640004.2.3">Vorbis
spec/Comment header</a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<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>
Expand All @@ -356,9 +359,6 @@ <h4>readVorbisCommentHeader</h4>
<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>
<dt><span class="throwsLabel">Throws:</span></dt>
<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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-640004.2.3">Vorbis
spec/Comment header</a></dd>
</dl>
</li>
</ul>
Expand Down Expand Up @@ -417,7 +417,10 @@ <h4>readVorbisModes</h4>
throws <a href="../ParserException.html" title="class in com.google.android.exoplayer2">ParserException</a></pre>
<div class="block">This method reads the modes which are located at the very end of the Vorbis setup header.
That's why we need to partially decode or at least read the entire setup header to know where
to start reading the modes.</div>
to start reading the modes.

<p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-650004.2.4">Vorbis
spec/Setup header</a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<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>
Expand All @@ -426,9 +429,6 @@ <h4>readVorbisModes</h4>
<dd>an array of <a href="VorbisUtil.Mode.html" title="class in com.google.android.exoplayer2.extractor"><code>VorbisUtil.Mode</code></a>s.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../ParserException.html" title="class in com.google.android.exoplayer2">ParserException</a></code> - thrown if bit stream is invalid.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-650004.2.4">Vorbis
spec/Setup header</a></dd>
</dl>
</li>
</ul>
Expand Down
Loading

0 comments on commit 05ac6ab

Please sign in to comment.