2018-09-11 18:21:55 +00:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< 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 > Implement a service - NewPipe 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" / >
<!-- 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 = "Implement a service";
var mkdocs_page_input_path = "03_Implement_a_service.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-nav-search" >
< a href = ".." class = "icon icon-home" > NewPipe 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" title = "Type search term here" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< ul class = "current" >
< li class = "toctree-l1" >
2018-09-21 20:40:35 +00:00
< a class = "" href = ".." > Welcome to the NewPipe Documentation.< / a >
2018-09-11 18:21:55 +00:00
< / li >
< li class = "toctree-l1" >
< a class = "" href = "../00_Prepare_everything/" > Prepare everything< / a >
< / li >
< li class = "toctree-l1" >
< a class = "" href = "../01_Concept_of_the_extractor/" > Concept of the Extractor< / a >
< / li >
< li class = "toctree-l1" >
< a class = "" href = "../02_Concept_of_LinkHandler/" > Concept of LinkHandler< / a >
< / li >
< li class = "toctree-l1 current" >
< a class = "current" href = "./" > Implement a service< / a >
< ul class = "subnav" >
< li class = "toctree-l2" > < a href = "#implement-a-service" > Implement a service< / a > < / li >
< ul >
2018-11-03 12:07:03 +00:00
< li > < a class = "toctree-l3" href = "#required-and-optional-parts" > Required and optional parts< / a > < / li >
2018-09-21 20:40:35 +00:00
< li > < a class = "toctree-l3" href = "#allowed-libraries" > Allowed Libraries< / a > < / li >
< li > < a class = "toctree-l3" href = "#head-of-service" > Head of Service< / a > < / li >
< li > < a class = "toctree-l3" href = "#stream" > Stream< / a > < / li >
< li > < a class = "toctree-l3" href = "#search" > Search< / a > < / li >
< li > < a class = "toctree-l3" href = "#playlist" > Playlist< / a > < / li >
2018-11-03 12:07:03 +00:00
< li > < a class = "toctree-l3" href = "#channel" > Channel< / a > < / li >
2018-09-21 20:40:35 +00:00
< li > < a class = "toctree-l3" href = "#kiosk" > Kiosk< / a > < / li >
2018-09-11 18:21:55 +00:00
< / ul >
< / ul >
< / li >
< li class = "toctree-l1" >
< a class = "" href = "../04_Run_changes_in_App/" > Run the changes in the App< / a >
< / li >
< / ul >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" role = "navigation" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = ".." > NewPipe 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 = ".." > Docs< / a > » < / li >
< li > Implement a service< / li >
< li class = "wy-breadcrumbs-aside" >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" >
< div class = "section" >
< h1 id = "implement-a-service" > Implement a service< / h1 >
< p > Services or better service connectors are the parts of NewPipe which communicative with an actual service like YouTube.
2018-11-03 12:07:03 +00:00
This Page will describe how you can implement and add your own to the extractor. Please make sure you read and understand the
2018-09-11 18:21:55 +00:00
< a href = "https://teamnewpipe.github.io/documentation/01_Concept_of_the_extractor/" > Concept of Extractors< / a >
and the < a href = "https://teamnewpipe.github.io/documentation/02_Concept_of_LinkHandler/" > Concept of LinkHandler< / a >
2018-11-03 12:07:03 +00:00
before doing this.< / p >
< h3 id = "required-and-optional-parts" > Required and optional parts< / h3 >
< p > Please be aware that your extractor has to implement certain parts, but does not have to implement all.
This is because not all services support every feature other services support. For example, it might be that a certain
service does not support channels. If so, you can leve out the implementation of channels, and make the corresponding
factory methode of the your < strong > StreamingService< / strong > implementation return < strong > null< / strong > . The forntend will then automatically
leave out these parts.< / p >
< p > However if you start to implement one of the optional parts of the list below, you have to implement all parts/classes
of it. NewPipe will crash if you only implement the extractor for the list item of a channel, but not the channel extractor itself.< / p >
2018-09-15 18:59:36 +00:00
< p > < strong > The parts of a service:< / strong > < / p >
2018-09-11 18:21:55 +00:00
< ul >
2018-09-21 20:40:35 +00:00
< li > < a href = "#head-of-service" > Head of Service< / a > < / li >
2018-09-15 18:59:36 +00:00
< li > < a href = "#stream" > Stream< / a > < / li >
< li > < a href = "#search" > Search< / a > < / li >
< li > < a href = "#playlist" > Playlist< / a > < em > (optional)< / em > < / li >
2018-11-03 12:07:03 +00:00
< li > < a href = "#channel" > Channel< / a > < em > (optional)< / em > < / li >
2018-09-15 18:59:36 +00:00
< li > < a href = "#kiosk" > Kiosk< / a > < em > (optional)< / em > < / li >
2018-09-11 18:21:55 +00:00
< / ul >
2018-09-21 20:40:35 +00:00
< h3 id = "allowed-libraries" > Allowed Libraries< / h3 >
2018-11-03 12:07:03 +00:00
< p > The NewPipe Extractor already comes along with a lot of usable tools and external libraries that should make extracting easy.
2018-09-21 20:40:35 +00:00
For some specific (tiny) tasks regex is allowed. Here you can take a look at the
< a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/utils/Parser.html" > Parser< / a > ,
which will give you a little help with that. < strong > Use Regex with care!!!< / strong > Avoid it as often as possible. It's better to
ask us to introduce a new library than start using regex to often.< / p >
< ul >
< li > Html/XML Parsing: < a href = "https://jsoup.org/apidocs/overview-summary.html" > jsoup< / a > < / li >
< li > JSON Parsiong: < a href = "https://github.com/mmastrac/nanojson#parser-example" > nanojson< / a > < / li >
< li > JavaScript Parsing/Execution: < a href = "https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Rhino/Documentation" > Mozilla Rhino< / a > < / li >
< li > Link dectection in strings: < a href = "https://github.com/robinst/autolink-java" > AutoLink< / a > < / li >
< / ul >
< p > If you need to introduce new libraries please tell us before you do it.< / p >
< h3 id = "head-of-service" > Head of Service< / h3 >
< p > First of all if you want to create a new service you should create a new package below < code > org.schabi.newpipe.services< / code >
, with the name of your service as package name. Here you must put an implementation of these two classes:< / p >
< ul >
< li > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/StreamingService.html" > StreamingService< / a > < / li >
< li > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/StreamingService.ServiceInfo.html" > ServiceInfo< / a > < / li >
< / ul >
< p > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/StreamingService.html" > StreamingService< / a >
is a factory class that will return objects of all important parts of your service.
2018-11-03 12:07:03 +00:00
Every extractor, handler, and info type you add, and which should be part of your implementation, must be instantiated using an
instance of this class. You can see it as a factory for all objects of your implementation.< / p >
2018-09-21 20:40:35 +00:00
< p > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/StreamingService.ServiceInfo.html" > ServiceInfo< / a >
will return some meta information about your service. Such as the name, the capabilities, and your name as well as your
email address for further notice and maintenance issues. Remember, after extending this class you need to return an
instance of it by through your implementation of
< a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/StreamingService.html#getServiceInfo--" > < code > StreamingService.getServiceInfo()< / code > < / a > .< / p >
2018-11-03 12:07:03 +00:00
< p > When these two classes are extended by you, you need to add your < code > StreamingService< / code > to the
2018-09-21 20:40:35 +00:00
< a href = "https://github.com/TeamNewPipe/NewPipeExtractor/blob/49c2eb51859a58e4bb5ead2d9d0771408f7d59d6/extractor/src/main/java/org/schabi/newpipe/extractor/ServiceList.java#L23" > ServiceList< / a >
2018-11-03 12:07:03 +00:00
of NewPipe. This way your service will become an official part of the NewPipe Extractor.
Every service has an ID, which will be set when this list gets created. You need to set this ID by entering it in the constructor.
2018-09-21 20:40:35 +00:00
So when adding your service just give it the ID of the previously last service in the list incremented by one.< / p >
2018-09-11 18:21:55 +00:00
< h3 id = "stream" > Stream< / h3 >
2018-11-03 12:07:03 +00:00
< p > Streams are considered single entities of video or audio, the come along with metainformation like a title, a description,
next/related videos, thumbnail and commends. For getting the url to the actual stream data as well as this metainformation
StreamExtractor is used. The LinkHandlerFactory will represent a link to such a stream. StreamInfoItemExtractor will
extract one item in a list of items representing such Streams, like a search result or a playlist.
Since every Streaming service (obviously) provides streams this is required to implement. Otherwise your service was
pretty useless :)< / p >
2018-09-11 18:21:55 +00:00
< ul >
< li > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/stream/StreamExtractor.html" > StreamExtractor< / a > < / li >
< li > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/stream/StreamInfoItemExtractor.html" > StreamInfoItemExtractor< / a > < / li >
< li > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/LinkHandlerFactory.html" > LinkHandlerFactory< / a > < / li >
< / ul >
2018-09-15 18:59:36 +00:00
< h3 id = "search" > Search< / h3 >
2018-11-03 12:07:03 +00:00
< p > The SearchExtractor is also required to be implemented. It will take a search query represented as < a href = "link here" > SearchQueryHandler< / a > ,
and return a list of search results. Since many services support a suggestion popup while you type you will also want to implement
a < strong > SuggestionExtractor< / strong > . This will make it possible for the frontend to as well display a suggestion while typing.< / p >
2018-09-15 18:59:36 +00:00
< ul >
< li > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/search/SearchExtractor.html" > SearchExtractor< / a > < / li >
< li > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/SearchQueryHandlerFactory.html" > SearchQueryHandlerFactory< / a > < / li >
< li > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/SuggestionExtractor.html" > SuggestionExtractor< / a > < em > (optional)< / em > < / li >
< / ul >
2018-09-11 18:21:55 +00:00
< h3 id = "playlist" > Playlist< / h3 >
2018-11-03 12:07:03 +00:00
< p > Playlists are lists of streams provided by the service (you may not have to take care about locally saved playlists. This will be handled by the frontend).
A playlist may only contains < strong > StreamItems< / strong > , but no other < strong > InfoItem< / strong > types.< / p >
2018-09-11 18:21:55 +00:00
< ul >
< li > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/playlist/PlaylistExtractor.html" > PlaylistExtractor< / a > < / li >
< li > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/playlist/PlaylistExtractor.html" > PlayListInfoItemExtractor< / a > < / li >
< li > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/ListLinkHandlerFactory.html" > ListLinkHandlerFactory< / a > < / li >
2018-11-03 12:07:03 +00:00
< / ul >
< h3 id = "channel" > Channel< / h3 >
< p > A Channel is mostly a < a href = "#playlist" > Playlist< / a > , the only diferens is that it does not represent a simple list of streams, but a
user, a channel, or any entity that could be represented as a user. This is why the metadata supported by the channel extractor
differs form the one of a playlist.< / p >
< ul >
< li > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/channel/ChannelExtractor.html" > ChannelExtractor< / a > < / li >
< li > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/channel/ChannelExtractor.html" > ChannelInfoItemExtractor< / a > < / li >
< li > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/ListLinkHandlerFactory.html" > ListLinkHandlerFactory< / a > < / li >
2018-09-11 18:21:55 +00:00
< / ul >
< h3 id = "kiosk" > Kiosk< / h3 >
< ul >
< li > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/kiosk/KioskList.KioskExtractorFactory.html" > KioskExtractorFactory< / a > < / li >
< li > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/kiosk/KioskExtractor.html" > KioskExtractor< / a > < / li >
< li > < a href = "https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/ListLinkHandlerFactory.html" > ListLinkHandlerFactory< / a > < / li >
< / ul >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
< a href = "../04_Run_changes_in_App/" class = "btn btn-neutral float-right" title = "Run the changes in the App" > Next < span class = "icon icon-circle-arrow-right" > < / span > < / a >
< a href = "../02_Concept_of_LinkHandler/" class = "btn btn-neutral" title = "Concept of LinkHandler" > < span class = "icon icon-circle-arrow-left" > < / span > Previous< / a >
< / div >
< hr / >
< div role = "contentinfo" >
<!-- Copyright etc -->
< / div >
Built with < a href = "http://www.mkdocs.org" > MkDocs< / a > using a < a href = "https://github.com/snide/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" style = "cursor: pointer" >
< span class = "rst-current-version" data-toggle = "rst-current-version" >
< span > < a href = "../02_Concept_of_LinkHandler/" style = "color: #fcfcfc;" > « Previous< / a > < / span >
< span style = "margin-left: 15px" > < a href = "../04_Run_changes_in_App/" style = "color: #fcfcfc" > Next » < / a > < / span >
< / span >
< / div >
< script > var base _url = '..' ; < / script >
< script src = "../js/theme.js" defer > < / script >
< script src = "../search/main.js" defer > < / script >
< / body >
< / html >
