242 lines
13 KiB
HTML
242 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Concept of the LinkHandler - NewPipe Development Documentation</title>
|
|
<!-- local fonts -->
|
|
<link rel="stylesheet" href="../css/local_fonts.css" type="text/css" />
|
|
|
|
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_child.css" type="text/css" />
|
|
<!-- local code syntax highlighting -->
|
|
<link rel="stylesheet" href="../css/github.min.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/highlight.css" type="text/css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Concept of the LinkHandler";
|
|
var mkdocs_page_input_path = "02_Concept_of_LinkHandler.md";
|
|
var mkdocs_page_url = null;
|
|
</script>
|
|
|
|
<script src="../js/jquery-2.1.1.min.js" defer></script>
|
|
<script src="../js/modernizr-2.8.3.min.js" defer></script>
|
|
<script src="../js/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> NewPipe Development Documentation
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to the NewPipe Development Docs</a>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../00_Prepare_everything/">Before You Start</a>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Concept of the LinkHandler</a>
|
|
<ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="#important-notes-about-linkhandler">Important notes about LinkHandler</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#usage">Usage</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#implementation">Implementation</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#listlinkhandler-and-searchqueryhandler">ListLinkHandler and SearchQueryHandler</a>
|
|
<ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#searchqueryhandler">SearchQueryHandler</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../03_Implement_a_service/">Implementing a Service</a>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../05_Mock_tests/">Mock Tests</a>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../06_releasing/">Releasing a New NewPipe Version</a>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../07_release_instructions/">Release instructions for normal releases</a>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../08_documentation/">About This Documentation</a>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../09_maintainers_view/">Maintainers' Section</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">NewPipe Development Documentation</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".." class="icon icon-home" aria-label="Docs"></a> »</li>
|
|
<li class="breadcrumb-item active">Concept of the LinkHandler</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<h1 id="concept-of-the-linkhandler">Concept of the LinkHandler</h1>
|
|
<p>The <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/LinkHandler.html">LinkHandler</a>
|
|
represent links to resources like videos, search requests, channels, etc.
|
|
The idea is that a video can have multiple links pointing to it, but it has
|
|
one unique ID that represents it, like this example:</p>
|
|
<p><a href="https://www.youtube.com/watch?v=oHg5SJYRHA0">oHg5SJYRHA0</a> can be represented as:</p>
|
|
<ul>
|
|
<li><a href="https://www.youtube.com/watch?v=oHg5SJYRHA0">https://www.youtube.com/watch?v=oHg5SJYRHA0</a> (the default URL for YouTube)</li>
|
|
<li><a href="https://youtu.be/oHg5SJYRHA0">https://youtu.be/oHg5SJYRHA0</a> (the shortened link)</li>
|
|
<li><a href="https://m.youtube.com/watch?v=oHg5SJYRHA0">https://m.youtube.com/watch?v=oHg5SJYRHA0</a> (the link for mobile devices)</li>
|
|
</ul>
|
|
<h3 id="important-notes-about-linkhandler">Important notes about LinkHandler</h3>
|
|
<ul>
|
|
<li>A simple <code>LinkHandler</code> will contain the default URL, the ID, and the original URL.</li>
|
|
<li><code>LinkHandler</code>s are read only.</li>
|
|
<li><code>LinkHandler</code>s are also used to determine which part of the extractor can handle a certain link.</li>
|
|
<li>In order to get one you must either call
|
|
<a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/LinkHandlerFactory.html#fromUrl-java.lang.String-">fromUrl()</a> or <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/LinkHandlerFactory.html#fromId-java.lang.String-">fromId()</a> of the the corresponding <code>LinkHandlerFactory</code>.</li>
|
|
<li>Every type of resource has its own <code>LinkHandlerFactory</code>. Eg. YoutubeStreamLinkHandler, YoutubeChannelLinkHandler, etc.</li>
|
|
</ul>
|
|
<h3 id="usage">Usage</h3>
|
|
<p>The typical usage for obtaining a LinkHandler would look like this:</p>
|
|
<pre><code class="language-java">LinkHandlerFactory myLinkHandlerFactory = new MyStreamLinkHandlerFactory();
|
|
LinkHandler myVideo = myLinkHandlerFactory.fromUrl("https://my.service.com/the_video");
|
|
</code></pre>
|
|
<h3 id="implementation">Implementation</h3>
|
|
<p>In order to use LinkHandler for your service, you must override the appropriate LinkHandlerFactory. eg:</p>
|
|
<pre><code class="language-java">class MyStreamLinkHandlerFactory extends LinkHandlerFactory {
|
|
|
|
@Override
|
|
public String getId(String url) throws ParsingException {
|
|
// Return the ID based on the URL.
|
|
}
|
|
|
|
@Override
|
|
public String getUrl(String id) throws ParsingException {
|
|
// Return the URL based on the ID given.
|
|
}
|
|
|
|
@Override
|
|
public boolean onAcceptUrl(String url) throws ParsingException {
|
|
// Return true if this LinkHandlerFactory can handle this type of link.
|
|
}
|
|
}
|
|
</code></pre>
|
|
<h3 id="listlinkhandler-and-searchqueryhandler">ListLinkHandler and SearchQueryHandler</h3>
|
|
<p>List based resources, like channels and playlists, can be sorted and filtered.
|
|
Therefore these type of resources don't just use a LinkHandler, but a class called
|
|
<a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/ListLinkHandler.html">ListLinkHandler</a>,
|
|
which inherits from LinkHandler and adds the field <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/ListLinkHandler.html#contentFilters">ContentFilter</a>,
|
|
which is used to filter by resource type, like stream or playlist, and
|
|
<a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/ListLinkHandler.html#sortFilter">SortFilter</a>,
|
|
which is used to sort by name, date, or view count.</p>
|
|
<p><strong>!!ATTENTION!!</strong> Be careful when you implement a content filter: No selected filter equals all filters selected. If your get an empty content filter list in your extractor, make sure you return everything. By all means, use "if"
|
|
statements like <code>contentFilter.contains("video") || contentFilter.isEmpty()</code>.</p>
|
|
<p>ListLinkHandler are also created by overriding the <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/ListLinkHandlerFactory.html">ListLinkHandlerFactory</a>
|
|
additionally to the abstract methods this factory inherits from the LinkHandlerFactory you can override
|
|
<a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/ListLinkHandlerFactory.html#getAvailableContentFilter--">getAvailableContentFilter()</a>
|
|
and <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/ListLinkHandlerFactory.html#getAvailableSortFilter--">getAvailableSortFilter()</a>.
|
|
Through these you can tell the front end which kind of filter your service supports.</p>
|
|
<h4 id="searchqueryhandler">SearchQueryHandler</h4>
|
|
<p>You cannot point to a search request with an ID like you point to a playlist or a channel, simply because one and the
|
|
same search request might have a different outcome depending on the country or the time you send the request. This is
|
|
why the idea of an "ID" is replaced by a "SearchString" in the <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/SearchQueryHandler.html">SearchQueryHandler</a>.
|
|
These work like regular ListLinkHandler, except that you don't have to implement the methods <code>onAcceptUrl()</code>
|
|
and <code>getId()</code> when overriding <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/SearchQueryHandlerFactory.html">SearchQueryHandlerFactory</a>.</p>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../01_Concept_of_the_extractor/" class="btn btn-neutral float-left" title="Concept of the Extractor"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../03_Implement_a_service/" class="btn btn-neutral float-right" title="Implementing a Service">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
|
|
<span><a href="../01_Concept_of_the_extractor/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../03_Implement_a_service/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script src="../js/jquery-3.6.0.min.js"></script>
|
|
<script>var base_url = "..";</script>
|
|
<script src="../js/theme_extra.js"></script>
|
|
<script src="../js/theme.js"></script>
|
|
<script src="../search/main.js"></script>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|