Skip to content

Commit

Permalink
Update Javadoc for 2.18.5
Browse files Browse the repository at this point in the history
#minor-release

PiperOrigin-RevId: 516550914
(cherry picked from commit cebe01e)
  • Loading branch information
tonihei committed Mar 14, 2023
1 parent 63aa310 commit 1bfde98
Show file tree
Hide file tree
Showing 39 changed files with 90 additions and 27 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -626,6 +626,8 @@ <h4>createForRenderer</h4>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cause</code> - The cause of the failure.</dd>
<dd><code>rendererName</code> - The <a href="Renderer.html#getName()">name</a> of the renderer in which the
failure occurred.</dd>
<dd><code>rendererIndex</code> - The index of the renderer in which the failure occurred.</dd>
<dd><code>rendererFormat</code> - The <a href="Format.html" title="class in com.google.android.exoplayer2"><code>Format</code></a> the renderer was using at the time of the exception,
or null if the renderer wasn't using a <a href="Format.html" title="class in com.google.android.exoplayer2"><code>Format</code></a>.</dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -906,6 +906,7 @@ <h4>getAdState</h4>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>adGroupIndex</code> - The ad group index.</dd>
<dd><code>adIndexInAdGroup</code> - The index of the ad in the ad group.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The state of the ad, or <a href="source/ads/AdPlaybackState.html#AD_STATE_UNAVAILABLE"><code>AdPlaybackState.AD_STATE_UNAVAILABLE</code></a> if not yet
known.</dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -454,6 +454,7 @@ <h4>isTypeSupported</h4>
<div class="block">Returns true if at least one track of type <code>trackType</code> is <a href="Tracks.Group.html#isTrackSupported(int,boolean)"><code>supported</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>trackType</code> - The track type to query support for.</dd>
<dd><code>allowExceedsCapabilities</code> - Whether to consider the track as supported if it has a
supported <a href="Format.html#sampleMimeType"><code>MIME type</code></a>, but otherwise exceeds the advertised
capabilities of the device. For example, a video track for which there's a corresponding
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,7 @@ <h4>newWidevineInstance</h4>
their own license URL.</dd>
<dd><code>forceDefaultLicenseUrl</code> - Whether to use <code>defaultLicenseUrl</code> for key requests that
include their own license URL.</dd>
<dd><code>dataSourceFactory</code> - A factory from which to obtain <a href="../upstream/DataSource.html" title="interface in com.google.android.exoplayer2.upstream"><code>DataSource</code></a> instances.</dd>
<dd><code>optionalKeyRequestParameters</code> - An optional map of parameters to pass as the last argument
to <a href="https://developer.android.com/reference/android/media/MediaDrm.html#getKeyRequest(byte%5B%5D,byte%5B%5D,java.lang.String,int,java.util.HashMap)" title="class or interface in android.media" class="externalLink" target="_top"><code>MediaDrm.getKeyRequest(byte[], byte[], java.lang.String, int, java.util.HashMap&lt;java.lang.String, java.lang.String&gt;)</code></a>. May be null.</dd>
<dd><code>eventDispatcher</code> - A <a href="DrmSessionEventListener.EventDispatcher.html" title="class in com.google.android.exoplayer2.drm"><code>DrmSessionEventListener.EventDispatcher</code></a> used to distribute
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -574,6 +574,8 @@ <h4>canReuseDecoder</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../video/DecoderVideoRenderer.html#canReuseDecoder(java.lang.String,com.google.android.exoplayer2.Format,com.google.android.exoplayer2.Format)">canReuseDecoder</a></code>&nbsp;in class&nbsp;<code><a href="../../video/DecoderVideoRenderer.html" title="class in com.google.android.exoplayer2.video">DecoderVideoRenderer</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>decoderName</code> - The name of the decoder.</dd>
<dd><code>oldFormat</code> - The previous format.</dd>
<dd><code>newFormat</code> - The new format.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -554,6 +554,8 @@ <h4>canReuseDecoder</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../video/DecoderVideoRenderer.html#canReuseDecoder(java.lang.String,com.google.android.exoplayer2.Format,com.google.android.exoplayer2.Format)">canReuseDecoder</a></code>&nbsp;in class&nbsp;<code><a href="../../video/DecoderVideoRenderer.html" title="class in com.google.android.exoplayer2.video">DecoderVideoRenderer</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>decoderName</code> - The name of the decoder.</dd>
<dd><code>oldFormat</code> - The previous format.</dd>
<dd><code>newFormat</code> - The new format.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,7 @@ <h4>getFirstSampleNumber</h4>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - Input stream to get the sample number from (starting from the read position).</dd>
<dd><code>flacStreamMetadata</code> - The FLAC metadata of the stream.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The frame first sample number.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -763,6 +763,7 @@ <h4>MediaCodecRenderer</h4>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>trackType</code> - The <a href="../C.TrackType.html" title="annotation in com.google.android.exoplayer2"><code>track type</code></a> that the renderer handles.</dd>
<dd><code>codecAdapterFactory</code> - A factory for <a href="MediaCodecAdapter.html" title="interface in com.google.android.exoplayer2.mediacodec"><code>MediaCodecAdapter</code></a> instances.</dd>
<dd><code>mediaCodecSelector</code> - A decoder selector.</dd>
<dd><code>enableDecoderFallback</code> - Whether to enable fallback to lower-priority decoders if decoder
initialization fails. This may result in using a decoder that is less efficient or slower
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -489,6 +489,7 @@ <h4>getManifest</h4>
<div class="block">Loads and parses a manifest.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dataSource</code> - The source to use when loading the manifest.</dd>
<dd><code>dataSpec</code> - The manifest <a href="../upstream/DataSpec.html" title="class in com.google.android.exoplayer2.upstream"><code>DataSpec</code></a>.</dd>
<dd><code>removing</code> - Whether the manifest is being loaded as part of the download being removed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,8 @@ <h4>createDashChunkSource</h4>
if unknown.</dd>
<dd><code>enableEventMessageTrack</code> - Whether to output an event message track.</dd>
<dd><code>closedCaptionFormats</code> - The <a href="../../Format.html" title="class in com.google.android.exoplayer2"><code>Formats</code></a> of closed caption tracks to be output.</dd>
<dd><code>playerEmsgHandler</code> - The track output to write emsg messages to, or null if emsgs
shouldn't be written.</dd>
<dd><code>transferListener</code> - The transfer listener which should be informed of any data transfers.
May be null if no listener is available.</dd>
<dd><code>playerId</code> - The <a href="../../analytics/PlayerId.html" title="class in com.google.android.exoplayer2.analytics"><code>PlayerId</code></a> of the player using this chunk source.</dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ <h3>Method Summary</h3>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateManifest(com.google.android.exoplayer2.source.dash.manifest.DashManifest,int)">updateManifest</a></span>&#8203;(<a href="manifest/DashManifest.html" title="class in com.google.android.exoplayer2.source.dash.manifest">DashManifest</a>&nbsp;newManifest,
int&nbsp;periodIndex)</code></th>
int&nbsp;newPeriodIndex)</code></th>
<td class="colLast">
<div class="block">Updates the manifest.</div>
</td>
Expand Down Expand Up @@ -223,11 +223,12 @@ <h3>Method Detail</h3>
<li class="blockList">
<h4>updateManifest</h4>
<pre class="methodSignature">void&nbsp;updateManifest&#8203;(<a href="manifest/DashManifest.html" title="class in com.google.android.exoplayer2.source.dash.manifest">DashManifest</a>&nbsp;newManifest,
int&nbsp;periodIndex)</pre>
int&nbsp;newPeriodIndex)</pre>
<div class="block">Updates the manifest.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newManifest</code> - The new manifest.</dd>
<dd><code>newPeriodIndex</code> - The index of the period covered by <code>newManifest</code>.</dd>
</dl>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,8 @@ <h4>createDashChunkSource</h4>
if unknown.</dd>
<dd><code>enableEventMessageTrack</code> - Whether to output an event message track.</dd>
<dd><code>closedCaptionFormats</code> - The <a href="../../Format.html" title="class in com.google.android.exoplayer2"><code>Formats</code></a> of closed caption tracks to be output.</dd>
<dd><code>playerEmsgHandler</code> - The track output to write emsg messages to, or null if emsgs
shouldn't be written.</dd>
<dd><code>transferListener</code> - The transfer listener which should be informed of any data transfers.
May be null if no listener is available.</dd>
<dd><code>playerId</code> - The <a href="../../analytics/PlayerId.html" title="class in com.google.android.exoplayer2.analytics"><code>PlayerId</code></a> of the player using this chunk source.</dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -499,6 +499,7 @@ <h4>updateManifest</h4>
<dd><code><a href="DashChunkSource.html#updateManifest(com.google.android.exoplayer2.source.dash.manifest.DashManifest,int)">updateManifest</a></code>&nbsp;in interface&nbsp;<code><a href="DashChunkSource.html" title="interface in com.google.android.exoplayer2.source.dash">DashChunkSource</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newManifest</code> - The new manifest.</dd>
<dd><code>newPeriodIndex</code> - The index of the period covered by <code>newManifest</code>.</dd>
</dl>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -393,12 +393,16 @@ <h4>HlsMediaPeriod</h4>
<dd><code>mediaTransferListener</code> - The transfer listener to inform of any media data transfers. May
be null if no listener is available.</dd>
<dd><code>drmSessionManager</code> - The <a href="../../drm/DrmSessionManager.html" title="interface in com.google.android.exoplayer2.drm"><code>DrmSessionManager</code></a> to acquire <a href="../../drm/DrmSession.html" title="interface in com.google.android.exoplayer2.drm"><code>DrmSessions</code></a> with.</dd>
<dd><code>drmEventDispatcher</code> - A <a href="../../drm/DrmSessionEventListener.EventDispatcher.html" title="class in com.google.android.exoplayer2.drm"><code>DrmSessionEventListener.EventDispatcher</code></a> used to distribute
DRM-related events.</dd>
<dd><code>loadErrorHandlingPolicy</code> - A <a href="../../upstream/LoadErrorHandlingPolicy.html" title="interface in com.google.android.exoplayer2.upstream"><code>LoadErrorHandlingPolicy</code></a>.</dd>
<dd><code>eventDispatcher</code> - A dispatcher to notify of events.</dd>
<dd><code>allocator</code> - An <a href="../../upstream/Allocator.html" title="interface in com.google.android.exoplayer2.upstream"><code>Allocator</code></a> from which to obtain media buffer allocations.</dd>
<dd><code>compositeSequenceableLoaderFactory</code> - A factory to create composite <a href="../SequenceableLoader.html" title="interface in com.google.android.exoplayer2.source"><code>SequenceableLoader</code></a>s for when this media source loads data from multiple streams.</dd>
<dd><code>allowChunklessPreparation</code> - Whether chunkless preparation is allowed.</dd>
<dd><code>metadataType</code> - The type of metadata to extract from the period.</dd>
<dd><code>useSessionKeys</code> - Whether to use #EXT-X-SESSION-KEY tags.</dd>
<dd><code>playerId</code> - The ID of the current player.</dd>
</dl>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,9 @@ <h3>Constructor Summary</h3>
<a href="https://developer.android.com/reference/java/util/List.html" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="HlsMediaPlaylist.Part.html" title="class in com.google.android.exoplayer2.source.hls.playlist" target="_top">HlsMediaPlaylist.Part</a>&gt;&nbsp;trailingParts,
<a href="HlsMediaPlaylist.ServerControl.html" title="class in com.google.android.exoplayer2.source.hls.playlist">HlsMediaPlaylist.ServerControl</a>&nbsp;serverControl,
<a href="https://developer.android.com/reference/java/util/Map.html" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://developer.android.com/reference/android/net/Uri.html?is-external=true" title="class or interface in android.net" class="externalLink">Uri</a>,&#8203;<a href="HlsMediaPlaylist.RenditionReport.html" title="class in com.google.android.exoplayer2.source.hls.playlist" target="_top">HlsMediaPlaylist.RenditionReport</a>&gt;&nbsp;renditionReports)</code></th>
<td class="colLast">&nbsp;</td>
<td class="colLast">
<div class="block">Constructs an instance.</div>
</td>
</tr>
</table>
</li>
Expand Down Expand Up @@ -776,18 +778,21 @@ <h4>HlsMediaPlaylist</h4>
<a href="https://developer.android.com/reference/java/util/List.html" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="HlsMediaPlaylist.Part.html" title="class in com.google.android.exoplayer2.source.hls.playlist" target="_top">HlsMediaPlaylist.Part</a>&gt;&nbsp;trailingParts,
<a href="HlsMediaPlaylist.ServerControl.html" title="class in com.google.android.exoplayer2.source.hls.playlist">HlsMediaPlaylist.ServerControl</a>&nbsp;serverControl,
<a href="https://developer.android.com/reference/java/util/Map.html" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://developer.android.com/reference/android/net/Uri.html?is-external=true" title="class or interface in android.net" class="externalLink">Uri</a>,&#8203;<a href="HlsMediaPlaylist.RenditionReport.html" title="class in com.google.android.exoplayer2.source.hls.playlist" target="_top">HlsMediaPlaylist.RenditionReport</a>&gt;&nbsp;renditionReports)</pre>
<div class="block">Constructs an instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>playlistType</code> - See <a href="#playlistType"><code>playlistType</code></a>.</dd>
<dd><code>baseUri</code> - See <a href="HlsPlaylist.html#baseUri"><code>HlsPlaylist.baseUri</code></a>.</dd>
<dd><code>tags</code> - See <a href="HlsPlaylist.html#tags"><code>HlsPlaylist.tags</code></a>.</dd>
<dd><code>startOffsetUs</code> - See <a href="#startOffsetUs"><code>startOffsetUs</code></a>.</dd>
<dd><code>preciseStart</code> - See <a href="#preciseStart"><code>preciseStart</code></a>.</dd>
<dd><code>startTimeUs</code> - See <a href="#startTimeUs"><code>startTimeUs</code></a>.</dd>
<dd><code>hasDiscontinuitySequence</code> - See <a href="#hasDiscontinuitySequence"><code>hasDiscontinuitySequence</code></a>.</dd>
<dd><code>discontinuitySequence</code> - See <a href="#discontinuitySequence"><code>discontinuitySequence</code></a>.</dd>
<dd><code>mediaSequence</code> - See <a href="#mediaSequence"><code>mediaSequence</code></a>.</dd>
<dd><code>version</code> - See <a href="#version"><code>version</code></a>.</dd>
<dd><code>targetDurationUs</code> - See <a href="#targetDurationUs"><code>targetDurationUs</code></a>.</dd>
<dd><code>partTargetDurationUs</code> - See <a href="#partTargetDurationUs"><code>partTargetDurationUs</code></a>.</dd>
<dd><code>hasIndependentSegments</code> - See <a href="HlsPlaylist.html#hasIndependentSegments"><code>HlsPlaylist.hasIndependentSegments</code></a>.</dd>
<dd><code>hasEndTag</code> - See <a href="#hasEndTag"><code>hasEndTag</code></a>.</dd>
<dd><code>hasProgramDateTime</code> - See <a href="#hasProgramDateTime"><code>hasProgramDateTime</code></a>.</dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,9 @@ <h3>Constructor Summary</h3>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.Runnable)">ExecuteRunnable</a></span>&#8203;(<a href="https://developer.android.com/reference/java/lang/String.html" title="class or interface in java.lang" class="externalLink" target="_top">String</a>&nbsp;tag,
<a href="https://developer.android.com/reference/java/lang/Runnable.html" title="class or interface in java.lang" class="externalLink" target="_top">Runnable</a>&nbsp;runnable)</code></th>
<td class="colLast">&nbsp;</td>
<td class="colLast">
<div class="block">Constructs an instance.</div>
</td>
</tr>
</table>
</li>
Expand Down Expand Up @@ -243,9 +245,11 @@ <h4>ExecuteRunnable</h4>
<pre>public&nbsp;ExecuteRunnable&#8203;(@Size(max=23L)
<a href="https://developer.android.com/reference/java/lang/String.html" title="class or interface in java.lang" class="externalLink" target="_top">String</a>&nbsp;tag,
<a href="https://developer.android.com/reference/java/lang/Runnable.html" title="class or interface in java.lang" class="externalLink" target="_top">Runnable</a>&nbsp;runnable)</pre>
<div class="block">Constructs an instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tag</code> - A tag to use for logging.</dd>
<dd><code>runnable</code> - The runnable to run.</dd>
</dl>
</li>
</ul>
Expand Down
Loading

0 comments on commit 1bfde98

Please sign in to comment.