NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/Image.html
2024-11-24 16:16:50 +00:00

567 lines
20 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Image (NewPipeExtractor v0.24.3)</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.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.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-3.7.1.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Image (NewPipeExtractor v0.24.3)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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 = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.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 id="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>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.schabi.newpipe.extractor</a></div>
<h2 title="Class Image" class="title">Class Image</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.schabi.newpipe.extractor.Image</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code></dd>
</dl>
<hr>
<pre>public final class <span class="typeNameLabel">Image</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">Class representing images in the extractor.
<p>
An image has four properties: its URL, its height, its width and its estimated quality level.
</p>
<p>
Depending of the services, the height, the width or both properties may be not known.
Implementations <b>must use</b> the relevant unknown constants in this case
(<a href="#HEIGHT_UNKNOWN"><code>HEIGHT_UNKNOWN</code></a> and <a href="#WIDTH_UNKNOWN"><code>WIDTH_UNKNOWN</code></a>), to ensure properly the lack of knowledge
of one or both of these properties to extractor clients.
</p>
<p>
They should also respect the ranges defined in the estimated image resolution levels as much as
possible, to ensure consistency to extractor clients.
</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.schabi.newpipe.extractor.Image">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<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 class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Image.ResolutionLevel.html" title="enum in org.schabi.newpipe.extractor">Image.ResolutionLevel</a></span></code></th>
<td class="colLast">
<div class="block">The estimated resolution level of an <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<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>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HEIGHT_UNKNOWN">HEIGHT_UNKNOWN</a></span></code></th>
<td class="colLast">
<div class="block">Constant representing that the height of an <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a> is 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="#WIDTH_UNKNOWN">WIDTH_UNKNOWN</a></span></code></th>
<td class="colLast">
<div class="block">Constant representing that the width of an <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a> is unknown.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<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="#%3Cinit%3E(java.lang.String,int,int,org.schabi.newpipe.extractor.Image.ResolutionLevel)">Image</a></span>&#8203;(java.lang.String&nbsp;url,
int&nbsp;height,
int&nbsp;width,
<a href="Image.ResolutionLevel.html" title="enum in org.schabi.newpipe.extractor">Image.ResolutionLevel</a>&nbsp;estimatedResolutionLevel)</code></th>
<td class="colLast">
<div class="block">Construct an <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a> instance.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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><a href="Image.ResolutionLevel.html" title="enum in org.schabi.newpipe.extractor">Image.ResolutionLevel</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEstimatedResolutionLevel()">getEstimatedResolutionLevel</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the estimated resolution level of this image.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeight()">getHeight</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the height of this <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUrl()">getUrl</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the URL of this <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWidth()">getWidth</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the width of this <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">
<div class="block">Get a string representation of this <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a> instance.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="HEIGHT_UNKNOWN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HEIGHT_UNKNOWN</h4>
<pre>public static final&nbsp;int HEIGHT_UNKNOWN</pre>
<div class="block">Constant representing that the height of an <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a> is unknown.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.schabi.newpipe.extractor.Image.HEIGHT_UNKNOWN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="WIDTH_UNKNOWN">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WIDTH_UNKNOWN</h4>
<pre>public static final&nbsp;int WIDTH_UNKNOWN</pre>
<div class="block">Constant representing that the width of an <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a> is unknown.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.schabi.newpipe.extractor.Image.WIDTH_UNKNOWN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.lang.String,int,int,org.schabi.newpipe.extractor.Image.ResolutionLevel)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Image</h4>
<pre>public&nbsp;Image&#8203;(@Nonnull
java.lang.String&nbsp;url,
int&nbsp;height,
int&nbsp;width,
@Nonnull
<a href="Image.ResolutionLevel.html" title="enum in org.schabi.newpipe.extractor">Image.ResolutionLevel</a>&nbsp;estimatedResolutionLevel)
throws java.lang.NullPointerException</pre>
<div class="block">Construct an <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a> instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - the URL to the image, which should be not null or empty</dd>
<dd><code>height</code> - the image's height</dd>
<dd><code>width</code> - the image's width</dd>
<dd><code>estimatedResolutionLevel</code> - the image's estimated resolution level, which must not be
null</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if <code>estimatedResolutionLevel</code> is null</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getUrl()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUrl</h4>
<pre class="methodSignature">@Nonnull
public&nbsp;java.lang.String&nbsp;getUrl()</pre>
<div class="block">Get the URL of this <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a>'s URL.</dd>
</dl>
</li>
</ul>
<a id="getHeight()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeight</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getHeight()</pre>
<div class="block">Get the height of this <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a>.
<p>
If it is unknown, <a href="#HEIGHT_UNKNOWN"><code>HEIGHT_UNKNOWN</code></a> is returned instead.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a>'s height or <a href="#HEIGHT_UNKNOWN"><code>HEIGHT_UNKNOWN</code></a></dd>
</dl>
</li>
</ul>
<a id="getWidth()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWidth</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getWidth()</pre>
<div class="block">Get the width of this <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a>.
<p>
If it is unknown, <a href="#WIDTH_UNKNOWN"><code>WIDTH_UNKNOWN</code></a> is returned instead.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a>'s width or <a href="#WIDTH_UNKNOWN"><code>WIDTH_UNKNOWN</code></a></dd>
</dl>
</li>
</ul>
<a id="getEstimatedResolutionLevel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEstimatedResolutionLevel</h4>
<pre class="methodSignature">@Nonnull
public&nbsp;<a href="Image.ResolutionLevel.html" title="enum in org.schabi.newpipe.extractor">Image.ResolutionLevel</a>&nbsp;getEstimatedResolutionLevel()</pre>
<div class="block">Get the estimated resolution level of this image.
<p>
If it is unknown, <a href="Image.ResolutionLevel.html#UNKNOWN"><code>Image.ResolutionLevel.UNKNOWN</code></a> is returned instead.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the estimated resolution level, which is never <code>null</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Image.ResolutionLevel.html" title="enum in org.schabi.newpipe.extractor"><code>Image.ResolutionLevel</code></a></dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">@Nonnull
public&nbsp;java.lang.String&nbsp;toString()</pre>
<div class="block">Get a string representation of this <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a> instance.
<p>
The representation will be in the following format, where <code>url</code>, <code>height</code>,
<code>width</code> and <code>estimatedResolutionLevel</code> represent the corresponding properties:
<br>
<br>
<code>Image {url=url, height='height, width=width,
estimatedResolutionLevel=estimatedResolutionLevel}'</code>
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string representation of this <a href="Image.html" title="class in org.schabi.newpipe.extractor"><code>Image</code></a> instance</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>