sjs/media
1
0
Fork 0
mirror of https://github.com/samsonjs/media.git synced 2026-03-26 09:35:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
media/docs/doc/reference/com/google/android/exoplayer2/offline/Download.html
andrewlewis 517e590967 Move docs to correct folder for GitHub Pages
2021-04-21 11:00:57 +01:00

772 lines
35 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head><!-- start favicons snippet, use https://realfavicongenerator.net/ --><link rel="apple-touch-icon" sizes="180x180" href="/assets/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png"><link rel="manifest" href="/assets/site.webmanifest"><link rel="mask-icon" href="/assets/safari-pinned-tab.svg" color="#fc4d50"><link rel="shortcut icon" href="/assets/favicon.ico"><meta name="msapplication-TileColor" content="#ffc40d"><meta name="msapplication-config" content="/assets/browserconfig.xml"><meta name="theme-color" content="#ffffff"><!-- end favicons snippet -->
<title>Download (ExoPlayer library)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-1.10.2.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Download (ExoPlayer library)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/google/android/exoplayer2/offline/DefaultDownloadIndex.html" title="class in com.google.android.exoplayer2.offline"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/google/android/exoplayer2/offline/Download.FailureReason.html" title="annotation in com.google.android.exoplayer2.offline"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/google/android/exoplayer2/offline/Download.html" target="_top">Frames</a></li>
<li><a href="Download.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="../../../../../com/google/android/exoplayer2/offline/package-summary.html">com.google.android.exoplayer2.offline</a></div>
<h2 title="Class Download" class="title">Class Download</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://developer.android.com/reference/java/lang/Object.html" title="class or interface in java.lang" class="externalLink" target="_top">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.google.android.exoplayer2.offline.Download</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public final class <span class="typeNameLabel">Download</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">Represents state of a download.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.FailureReason.html" title="annotation in com.google.android.exoplayer2.offline">Download.FailureReason</a></span></code></th>
<td class="colLast">
<div class="block">Failure reasons.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.State.html" title="annotation in com.google.android.exoplayer2.offline">Download.State</a></span></code></th>
<td class="colLast">
<div class="block">Download states.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#contentLength">contentLength</a></span></code></th>
<td class="colLast">
<div class="block">The total size of the content in bytes, or <a href="../../../../../com/google/android/exoplayer2/C.html#LENGTH_UNSET"><code>C.LENGTH_UNSET</code></a> if unknown.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#FAILURE_REASON_NONE">FAILURE_REASON_NONE</a></span></code></th>
<td class="colLast">
<div class="block">The download isn't failed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#FAILURE_REASON_UNKNOWN">FAILURE_REASON_UNKNOWN</a></span></code></th>
<td class="colLast">
<div class="block">The download is failed because of unknown reason.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#failureReason">failureReason</a></span></code></th>
<td class="colLast">
<div class="block">If <a href="../../../../../com/google/android/exoplayer2/offline/Download.html#state"><code>state</code></a> is <a href="../../../../../com/google/android/exoplayer2/offline/Download.html#STATE_FAILED"><code>STATE_FAILED</code></a> then this is the cause, otherwise <a href="../../../../../com/google/android/exoplayer2/offline/Download.html#FAILURE_REASON_NONE"><code>FAILURE_REASON_NONE</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../com/google/android/exoplayer2/offline/DownloadRequest.html" title="class in com.google.android.exoplayer2.offline">DownloadRequest</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#request">request</a></span></code></th>
<td class="colLast">
<div class="block">The download request.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#startTimeMs">startTimeMs</a></span></code></th>
<td class="colLast">
<div class="block">The first time when download entry is created.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#state">state</a></span></code></th>
<td class="colLast">
<div class="block">The state of the download.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#STATE_COMPLETED">STATE_COMPLETED</a></span></code></th>
<td class="colLast">
<div class="block">The download completed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#STATE_DOWNLOADING">STATE_DOWNLOADING</a></span></code></th>
<td class="colLast">
<div class="block">The download is currently started.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#STATE_FAILED">STATE_FAILED</a></span></code></th>
<td class="colLast">
<div class="block">The download failed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#STATE_QUEUED">STATE_QUEUED</a></span></code></th>
<td class="colLast">
<div class="block">The download is waiting to be started.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#STATE_REMOVING">STATE_REMOVING</a></span></code></th>
<td class="colLast">
<div class="block">The download is being removed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#STATE_RESTARTING">STATE_RESTARTING</a></span></code></th>
<td class="colLast">
<div class="block">The download will restart after all downloaded data is removed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#STATE_STOPPED">STATE_STOPPED</a></span></code></th>
<td class="colLast">
<div class="block">The download is stopped for a specified <a href="../../../../../com/google/android/exoplayer2/offline/Download.html#stopReason"><code>stopReason</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#STOP_REASON_NONE">STOP_REASON_NONE</a></span></code></th>
<td class="colLast">
<div class="block">The download isn't stopped.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#stopReason">stopReason</a></span></code></th>
<td class="colLast">
<div class="block">The reason the download is stopped, or <a href="../../../../../com/google/android/exoplayer2/offline/Download.html#STOP_REASON_NONE"><code>STOP_REASON_NONE</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#updateTimeMs">updateTimeMs</a></span></code></th>
<td class="colLast">
<div class="block">The last update time.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#Download-com.google.android.exoplayer2.offline.DownloadRequest-int-long-long-long-int-int-">Download</a></span>&#8203;(<a href="../../../../../com/google/android/exoplayer2/offline/DownloadRequest.html" title="class in com.google.android.exoplayer2.offline">DownloadRequest</a>&nbsp;request,
int&nbsp;state,
long&nbsp;startTimeMs,
long&nbsp;updateTimeMs,
long&nbsp;contentLength,
int&nbsp;stopReason,
int&nbsp;failureReason)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#Download-com.google.android.exoplayer2.offline.DownloadRequest-int-long-long-long-int-int-com.google.android.exoplayer2.offline.DownloadProgress-">Download</a></span>&#8203;(<a href="../../../../../com/google/android/exoplayer2/offline/DownloadRequest.html" title="class in com.google.android.exoplayer2.offline">DownloadRequest</a>&nbsp;request,
int&nbsp;state,
long&nbsp;startTimeMs,
long&nbsp;updateTimeMs,
long&nbsp;contentLength,
int&nbsp;stopReason,
int&nbsp;failureReason,
<a href="../../../../../com/google/android/exoplayer2/offline/DownloadProgress.html" title="class in com.google.android.exoplayer2.offline">DownloadProgress</a>&nbsp;progress)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#getBytesDownloaded--">getBytesDownloaded</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the total number of downloaded bytes.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#getPercentDownloaded--">getPercentDownloaded</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the estimated download percentage, or <a href="../../../../../com/google/android/exoplayer2/C.html#PERCENTAGE_UNSET"><code>C.PERCENTAGE_UNSET</code></a> if no estimate is
available.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../com/google/android/exoplayer2/offline/Download.html#isTerminalState--">isTerminalState</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether the download is completed or failed.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://developer.android.com/reference/java/lang/Object.html" title="class or interface in java.lang" class="externalLink" target="_top">Object</a></h3>
<code><a href="https://developer.android.com/reference/java/lang/Object.html#clone--" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang" class="externalLink" target="_top">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="STATE_QUEUED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STATE_QUEUED</h4>
<pre>public static final&nbsp;int STATE_QUEUED</pre>
<div class="block">The download is waiting to be started. A download may be queued because the <a href="../../../../../com/google/android/exoplayer2/offline/DownloadManager.html" title="class in com.google.android.exoplayer2.offline"><code>DownloadManager</code></a>
<ul>
<li>Is <a href="../../../../../com/google/android/exoplayer2/offline/DownloadManager.html#getDownloadsPaused--"><code>paused</code></a>
<li>Has <a href="../../../../../com/google/android/exoplayer2/offline/DownloadManager.html#getRequirements--"><code>Requirements</code></a> that are not met
<li>Has already started <a href="../../../../../com/google/android/exoplayer2/offline/DownloadManager.html#getMaxParallelDownloads--"><code>maxParallelDownloads</code></a>
</ul></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.offline.Download.STATE_QUEUED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="STATE_STOPPED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STATE_STOPPED</h4>
<pre>public static final&nbsp;int STATE_STOPPED</pre>
<div class="block">The download is stopped for a specified <a href="../../../../../com/google/android/exoplayer2/offline/Download.html#stopReason"><code>stopReason</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.offline.Download.STATE_STOPPED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="STATE_DOWNLOADING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STATE_DOWNLOADING</h4>
<pre>public static final&nbsp;int STATE_DOWNLOADING</pre>
<div class="block">The download is currently started.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.offline.Download.STATE_DOWNLOADING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="STATE_COMPLETED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STATE_COMPLETED</h4>
<pre>public static final&nbsp;int STATE_COMPLETED</pre>
<div class="block">The download completed.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.offline.Download.STATE_COMPLETED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="STATE_FAILED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STATE_FAILED</h4>
<pre>public static final&nbsp;int STATE_FAILED</pre>
<div class="block">The download failed.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.offline.Download.STATE_FAILED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="STATE_REMOVING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STATE_REMOVING</h4>
<pre>public static final&nbsp;int STATE_REMOVING</pre>
<div class="block">The download is being removed.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.offline.Download.STATE_REMOVING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="STATE_RESTARTING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STATE_RESTARTING</h4>
<pre>public static final&nbsp;int STATE_RESTARTING</pre>
<div class="block">The download will restart after all downloaded data is removed.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.offline.Download.STATE_RESTARTING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FAILURE_REASON_NONE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FAILURE_REASON_NONE</h4>
<pre>public static final&nbsp;int FAILURE_REASON_NONE</pre>
<div class="block">The download isn't failed.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.offline.Download.FAILURE_REASON_NONE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FAILURE_REASON_UNKNOWN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FAILURE_REASON_UNKNOWN</h4>
<pre>public static final&nbsp;int FAILURE_REASON_UNKNOWN</pre>
<div class="block">The download is failed because of unknown reason.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.offline.Download.FAILURE_REASON_UNKNOWN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="STOP_REASON_NONE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STOP_REASON_NONE</h4>
<pre>public static final&nbsp;int STOP_REASON_NONE</pre>
<div class="block">The download isn't stopped.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.google.android.exoplayer2.offline.Download.STOP_REASON_NONE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="request">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>request</h4>
<pre>public final&nbsp;<a href="../../../../../com/google/android/exoplayer2/offline/DownloadRequest.html" title="class in com.google.android.exoplayer2.offline">DownloadRequest</a> request</pre>
<div class="block">The download request.</div>
</li>
</ul>
<a name="state">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>state</h4>
<pre><a href="../../../../../com/google/android/exoplayer2/offline/Download.State.html" title="annotation in com.google.android.exoplayer2.offline">@State</a>
public final&nbsp;int state</pre>
<div class="block">The state of the download.</div>
</li>
</ul>
<a name="startTimeMs">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startTimeMs</h4>
<pre>public final&nbsp;long startTimeMs</pre>
<div class="block">The first time when download entry is created.</div>
</li>
</ul>
<a name="updateTimeMs">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateTimeMs</h4>
<pre>public final&nbsp;long updateTimeMs</pre>
<div class="block">The last update time.</div>
</li>
</ul>
<a name="contentLength">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contentLength</h4>
<pre>public final&nbsp;long contentLength</pre>
<div class="block">The total size of the content in bytes, or <a href="../../../../../com/google/android/exoplayer2/C.html#LENGTH_UNSET"><code>C.LENGTH_UNSET</code></a> if unknown.</div>
</li>
</ul>
<a name="stopReason">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopReason</h4>
<pre>public final&nbsp;int stopReason</pre>
<div class="block">The reason the download is stopped, or <a href="../../../../../com/google/android/exoplayer2/offline/Download.html#STOP_REASON_NONE"><code>STOP_REASON_NONE</code></a>.</div>
</li>
</ul>
<a name="failureReason">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>failureReason</h4>
<pre><a href="../../../../../com/google/android/exoplayer2/offline/Download.FailureReason.html" title="annotation in com.google.android.exoplayer2.offline">@FailureReason</a>
public final&nbsp;int failureReason</pre>
<div class="block">If <a href="../../../../../com/google/android/exoplayer2/offline/Download.html#state"><code>state</code></a> is <a href="../../../../../com/google/android/exoplayer2/offline/Download.html#STATE_FAILED"><code>STATE_FAILED</code></a> then this is the cause, otherwise <a href="../../../../../com/google/android/exoplayer2/offline/Download.html#FAILURE_REASON_NONE"><code>FAILURE_REASON_NONE</code></a>.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Download-com.google.android.exoplayer2.offline.DownloadRequest-int-long-long-long-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Download</h4>
<pre>public&nbsp;Download&#8203;(<a href="../../../../../com/google/android/exoplayer2/offline/DownloadRequest.html" title="class in com.google.android.exoplayer2.offline">DownloadRequest</a>&nbsp;request,
<a href="../../../../../com/google/android/exoplayer2/offline/Download.State.html" title="annotation in com.google.android.exoplayer2.offline">@State</a>
int&nbsp;state,
long&nbsp;startTimeMs,
long&nbsp;updateTimeMs,
long&nbsp;contentLength,
int&nbsp;stopReason,
<a href="../../../../../com/google/android/exoplayer2/offline/Download.FailureReason.html" title="annotation in com.google.android.exoplayer2.offline">@FailureReason</a>
int&nbsp;failureReason)</pre>
</li>
</ul>
<a name="Download-com.google.android.exoplayer2.offline.DownloadRequest-int-long-long-long-int-int-com.google.android.exoplayer2.offline.DownloadProgress-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Download</h4>
<pre>public&nbsp;Download&#8203;(<a href="../../../../../com/google/android/exoplayer2/offline/DownloadRequest.html" title="class in com.google.android.exoplayer2.offline">DownloadRequest</a>&nbsp;request,
<a href="../../../../../com/google/android/exoplayer2/offline/Download.State.html" title="annotation in com.google.android.exoplayer2.offline">@State</a>
int&nbsp;state,
long&nbsp;startTimeMs,
long&nbsp;updateTimeMs,
long&nbsp;contentLength,
int&nbsp;stopReason,
<a href="../../../../../com/google/android/exoplayer2/offline/Download.FailureReason.html" title="annotation in com.google.android.exoplayer2.offline">@FailureReason</a>
int&nbsp;failureReason,
<a href="../../../../../com/google/android/exoplayer2/offline/DownloadProgress.html" title="class in com.google.android.exoplayer2.offline">DownloadProgress</a>&nbsp;progress)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isTerminalState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTerminalState</h4>
<pre>public&nbsp;boolean&nbsp;isTerminalState()</pre>
<div class="block">Returns whether the download is completed or failed. These are terminal states.</div>
</li>
</ul>
<a name="getBytesDownloaded--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBytesDownloaded</h4>
<pre>public&nbsp;long&nbsp;getBytesDownloaded()</pre>
<div class="block">Returns the total number of downloaded bytes.</div>
</li>
</ul>
<a name="getPercentDownloaded--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPercentDownloaded</h4>
<pre>public&nbsp;float&nbsp;getPercentDownloaded()</pre>
<div class="block">Returns the estimated download percentage, or <a href="../../../../../com/google/android/exoplayer2/C.html#PERCENTAGE_UNSET"><code>C.PERCENTAGE_UNSET</code></a> if no estimate is
available.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/google/android/exoplayer2/offline/DefaultDownloadIndex.html" title="class in com.google.android.exoplayer2.offline"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/google/android/exoplayer2/offline/Download.FailureReason.html" title="annotation in com.google.android.exoplayer2.offline"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/google/android/exoplayer2/offline/Download.html" target="_top">Frames</a></li>
<li><a href="Download.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in a new issue View git blame Copy permalink