addons/webinterface.default/lang/en/addons.html

   1 <h1 id="add-on-support">Add-on Support</h1>
   2 <p>Chorus supports add-ons, but at a generic level. As each add-on does things differently, not all functionality will be
   3 available. The <a href="#addons/all">Add-Ons</a> page lists add-ons that are executable (eg. Global Search) or add-ons that provide
   4 a list of audio/video content (eg. YouTube). Add-ons that provide lists can also be accessed via the <a href="#browser">browser</a>.</p>
   5 <h2 id="custom-add-on-search">Custom Add-on Search</h2>
   6 <p>Out of the box, Chorus includes search functionality for some of the more popular add-ons, this allows you to search
   7 content provided by that add-on via the search page. For example you could type in &quot;crazy cat videos&quot; in the search box
   8 and then on the search page, click &quot;YouTube&quot; to get a list of videos provided by YouTube on that subject.</p>
   9 <p>If you wish to search content provided by an add-on that isn&#39;t included with Chorus, you can add your own
  10 <a href="#settings/search">custom add-on search</a> which tells Chorus how it can search for the content provided by that add-on.</p>
  11 <p>To add a custom search, you need to know what url the add-on is using internally to provide the search results. This
  12 isn&#39;t always easy or obvious to find out and may involve looking through the add-on code or kodi logs to determine the
  13 correct url to use. Chorus will substitute the token <code>[QUERY]</code> with the search term.</p>
  14 <h3 id="examples-of-add-on-search-urls">Examples of add-on search urls</h3>
  15 <ul>
  16 <li>YouTube: <code>plugin://plugin.video.youtube/search/?q=[QUERY]</code></li>
  17 <li>SoundCloud: <code>plugin://plugin.audio.soundcloud/search/query/?q=[QUERY]</code></li>
  18 <li>Radio: <code>plugin://plugin.audio.radio_de/stations/search/[QUERY]</code></li>
  19 <li>MixCloud: <code>plugin://plugin.audio.mixcloud/?mode=30&amp;key=cloudcast&amp;offset=0&amp;query=[QUERY]</code></li>
  20 </ul>
  21 <h3 id="contributing">Contributing</h3>
  22 <p>If you find a good custom add-on search that should be included in Chorus out of the box then you should consider
  23 submitting a <a href="https://github.com/xbmc/chorus2/pulls">pull request</a> for it. Look at the <a href="https://github.com/xbmc/chorus2/blob/master/src/js/apps/addon/soundcloud/addon_soundcloud_app.js.coffee">SoundCloud module</a>
  24 as an example of the code structure. NOTE: Only add-ons that are in the official repository will accepted.</p>
  25 <h2 id="enabling-and-disabling-add-ons">Enabling and disabling Add-ons</h2>
  26 <p>Chorus provides a <a href="#settings/addons">settings page</a> for enabling and disabling add-ons, be aware that disabling certain
  27 add-ons may have adverse effects so use with care.</p>
  28 <h2 id="known-issues-and-limitations">Known issues and limitations</h2>
  29 <p>A few things that have been observed with using add-ons in Chorus</p>
  30 <ul>
  31 <li>You cannot download add-on content.</li>
  32 <li>You can only play add-on content via Kodi, it cannot be streamed to the web browser.</li>
  33 <li>Adding a single add-on media to the playlist often results in the playlist entry having a weird title or missing a
  34 title altogether. Adding an add-on folder seems to populate it correctly. This appears to be an issue with the Kodi API.</li>
  35 <li>Some add-ons won&#39;t work at all, this should be raised up with the add-on author.</li>
  36 </ul>