Latest revision as of 04:23, 17 October 2021

Simple Downloader for xbmc plugins

See this add-on on the kodi.tv showcase
Author:	TheCollective
Type:	Services
Repo:
Summary:	Simple downloader for xbmc plugins.

Add-ons

Simple Downloader for xbmc plugins

Installing

This add-on is installed from the Add-on browser located in Kodi as follows:

Settings
Add-ons
Install from repository
Services
Simple Downloader for xbmc plugins
Install

Introduction

This is a downloader developed and used with the YouTube and BlipTV addons.

Features

One queue across all plugins
Requeing an existing item moves it to the front of the queue.
RTMP downloading if the rtmpdump binary is installed.
RTSP/mms downloading if the vlc or mplayer binary is installed.(And any other stream they accept)

Testing/Status

Integration and unittests are run continously by Jenkins

http://tc.tobiasussing.dk/jenkins/view/Simple%20Downloader/

Developers

This is a unified cross plugin http/rtmp downloader.

It is currently not possible to distribute the rtmpdump binary with this addon.

The user must make sure rtmpdump is installed in a system PATH for rtmp downloading to work.

Development and support thread: http://forum.kodi.tv/showthread.php?t=116500

Setup

To use the downloader edit your addon.xml like this.

 <requires>
   <import addon="xbmc.python" version="2.0"/>
   <import addon="script.module.simple.downloader" version="1.9.5"/> # Add this
 </requires>

And add the following to your py file.

 import SimpleDownloader as downloader
 downloader = downloader.SimpleDownloader()

You can now access the downloader through the "downloader" variable.

Debugging

To enable debugging set the following values in your default.py

dbg = True # Default

Or you can change it after import with.

downloader.dbg = True # Default

Whenever you debug your own code you should also debug in the cache. Otherwise you should remember to DISABLE it.

download(self, filename, dict = {})

Takes filename(string) and dictionary list with url and download_path.

The filename must be unique.

Input dictinary variables:

url(string): URL to download
Title(string): Title to give download. Use filename if not set.
download_path(string): Path to store file in
live(bool): Set to True when streaming rtmp live.
duration(int): Duration in minutes to download(For live streams).

Returns None

A simple http download

 params = { "url": "http://server.com/video.mp4", "download_path": "/tmp" }
 downloader.download("myvideo.mp4", params)

A simple http download with a custom title.

 params = { "url": "http://server.com/video.mp4", "download_path": "/tmp", "Title": "my video" }
 downloader.download("myvideo.mp4", params)

A simple RTMP download

 params = {"url": "rtmp://edge01.fms.dutchview.nl/botr/bunny", "download_path": "/tmp", "Title": "bunny"}
 downloader.download("bunny.mp4", params)

A simple RTMP Live download

 video = {"url": "rtmp://aljazeeraflashlivefs.fplive.net:1935/aljazeeraflashlive-live/aljazeera_english_1", "download_path": "/tmp", "Title": "Live Download", "live": "true", "duration": "10"}
 downloader.download("aljazeera-10minutes.mp4", params)

isRTMPInstalled()

Returns True if rtmpdump is installed

isVLCInstalled()

Returns True if vlc is installed

isMPlayerInstalled()

Returns True if mplayer is installed

@@ Line 1: / Line 1: @@
 {{Addon
-|Name=Simple downloader for xbmc plugins.
+|Name=Simple Downloader for xbmc plugins
 |provider-name=TheCollective
 |ID=script.module.simple.downloader
-|latest-version=0.9.0
+|latest-version=1.9.5
-|extension point=xbmc.python.module
+|extension point=xbmc.service
 |provides=
 |Summary=Simple downloader for xbmc plugins.
 |Description=
 |Platform=all
-|Repo=
+|Language=
-|icon url=}}
+|License=
+|Forum=
-= Testing/Status =
+|Website=
-Integration and unittests are run continously by Jenkins
+|Source=
+|Email=
-http://tc.tobiasussing.dk/jenkins/view/Simple%20Downloader/
+|broken=
+|icon url=http://mirrors.kodi.tv/addons/leia/script.module.simple.downloader/icon.png}}
 = Introduction =
@@ Line 24: / Line 25: @@
 * Requeing an existing item moves it to the front of the queue.
 * RTMP downloading if the rtmpdump binary is installed.
+* RTSP/mms downloading if the vlc or mplayer binary is installed.(And any other stream they accept)
+[[File:Simple_downloader.png|900px| Simple Downloader]]
+= Testing/Status =
+Integration and unittests are run continously by Jenkins
+http://tc.tobiasussing.dk/jenkins/view/Simple%20Downloader/
 = Developers =
@@ Line 31: / Line 40: @@
 The user must make sure rtmpdump is installed in a system PATH for rtmp downloading to work.
+Development and support thread: http://forum.kodi.tv/showthread.php?t=116500
 == Setup ==
@@ Line 37: / Line 48: @@
    <requires>
      <import addon="xbmc.python" version="2.0"/>
-     <import addon="script.module.simple.downloader.beta" version="0.9.0"/> # Add this
+     <import addon="script.module.simple.downloader" version="1.9.5"/> # Add this
    </requires>
 And add the following to your py file.
-  import xbmc, xbmcvfs, xbmcaddon
-  settings = xbmcaddon.Addon(id='your.plugin.id') # The same as in addon.xml
    import SimpleDownloader as downloader
    downloader = downloader.SimpleDownloader()
 You can now access the downloader through the "downloader" variable.
-=== Settings ===
-In your resources/settings.xml you need the following.
-    <setting id="downloadPath" type="folder" label="Download Location" default="" />
-    <setting id="hideDuringPlayback" type="bool" label="Hide during playback" default="true" />
-    <setting id="notification_length" type="enum" label="Notification length in seconds" values="1|2|3|4|5|6|7|8|9|10" default="2" />
 == Debugging ==
-To enable debugging set the following values in default.py
+To enable debugging set the following values in your default.py
   dbg = True # Default
@@ Line 64: / Line 65: @@
 Or you can change it after import with.
-  common.dbg = True # Default
+  downloader.dbg = True # Default
 Whenever you debug your own code you should also debug in the cache. Otherwise you should remember to DISABLE it.
-== downloadVideo(self, params = {}) ==
+== download(self, filename, dict = {}) ==
-Takes dictionary list with video name and url.
+Takes filename(string) and dictionary list with url and download_path.
-For http and normal RTMP streams you need to specify a video_url, a videoid and a Title.
+The filename must be unique.
-* video_url: "http://server.com/video.mp4" # Url to download
-* videoid: "0" # Video id. Must be unique. Preferably just use the videoid provided from your site(if applicable).
-For live RMTP streams you also need to specify live and max_size:
+Input dictinary variables:
-* live: True # Tell the downloader it is getting a live stream
+* url(string): URL to download
-* max_size: 10000000 # The maximum size(in bytes) of the download stream. Defaults to "10000000" if nothing is specified.
+* Title(string): Title to give download. Use filename if not set.
+* download_path(string): Path to store file in
+* live(bool): Set to True when streaming rtmp live.
+* duration(int): Duration in minutes to download(For live streams).
 Returns None
 A simple http download
-   params = { "videoid": "0", "video_url": "http://server.com/video.mp4", "Title": "my video" }
+   params = { "url": "http://server.com/video.mp4", "download_path": "/tmp" }
-   downloader.downloadVideo(params)
+  downloader.download("myvideo.mp4", params)
+A simple http download with a custom title.
+  params = { "url": "http://server.com/video.mp4", "download_path": "/tmp", "Title": "my video" }
+   downloader.download("myvideo.mp4", params)
 A simple RTMP download
-   params = {"videoid": "1", "video_url": "rtmp://edge01.fms.dutchview.nl/botr/bunny", "Title": "bunny"}
+   params = {"url": "rtmp://edge01.fms.dutchview.nl/botr/bunny", "download_path": "/tmp", "Title": "bunny"}
-   downloader.downloadVideo(params)
+   downloader.download("bunny.mp4", params)
 A simple RTMP Live download
-   video = {"videoid": "2", "video_url": "rtmp://aljazeeraflashlivefs.fplive.net:1935/aljazeeraflashlive-live/aljazeera_english_1", "Title": "mock", "live": "true", "max_size": "3000000"}
+   video = {"url": "rtmp://aljazeeraflashlivefs.fplive.net:1935/aljazeeraflashlive-live/aljazeera_english_1", "download_path": "/tmp", "Title": "Live Download", "live": "true", "duration": "10"}
-   downloader.downloadVideo(params)
+   downloader.download("aljazeera-10minutes.mp4", params)
+== isRTMPInstalled() ==
+Returns True if rtmpdump is installed
+== isVLCInstalled() ==
+Returns True if vlc is installed
+== isMPlayerInstalled() ==
+Returns True if mplayer is installed
-[[Category:Repo: Eden-pre]]
+[[Category:All add-ons]]
-[[Category:Pre-Eden add-on repository]]
+[[Category:Service add-ons]]
+[[Category:Gotham add-on repository]]
+[[Category:Helix add-on repository]]
+[[Category:Isengard add-on repository]]
+[[Category:Jarvis add-on repository]]
+[[Category:Krypton add-on repository]]
+[[Category:Leia add-on repository]]

Add-on:Simple Downloader for xbmc plugins: Difference between revisions

Latest revision as of 04:23, 17 October 2021

Contents

Installing

Introduction

Features

Testing/Status

Developers

Setup

Debugging

download(self, filename, dict = {})

isRTMPInstalled()

isVLCInstalled()

isMPlayerInstalled()

Navigation menu

Add-on:Simple Downloader for xbmc plugins: Difference between revisions

Latest revision as of 04:23, 17 October 2021

Installing

Introduction

Features

Testing/Status

Developers

Setup

Debugging

download(self, filename, dict = {})

isRTMPInstalled()

isVLCInstalled()

isMPlayerInstalled()

Navigation menu

Search