Download Torrent

This plug-in provided command downloads torrents (sourced from either torrent files or magnet links) from the Internet.

For information on using this command as a download hander for Web Media Blocks, please see the topic titled Hosting Web Media Blocks as Torrents.

Torrent file or Magnet URL

If downloading based on a torrent file, enter the full path to the file in this field. Variables are allowed.

If downloading based on a magnet link, enter the full link in this field. Variables are allowed.

Local file path and name

Enter the full path for the local copy of the file on the target system. If file already exists, it will be assumed to be a previously broken download and the Download Torrent command will resume the download from where it left off.

Download limit (Kb/s)

To limit the download rate of your file, enter the maximum download speed in this field, specified as kilobytes per second.

Enter 0 to download without any speed limit.

Upload limit (Kb/s)

The file being downloaded will be automatically uploaded while the download is still in progress. To limit the upload rate of your file, enter the maximum upload speed in this field, specified as kilobytes per second.

Enter 0 to upload without any speed limit.

Please note that not limiting the upload rate may saturate bandwidth, often more so than an uncapped download would.

Manage Firewall exception

Check this box to allow the command to automatically adjust the Windows Firewall to permit maximum speed downloads and uploads. The command will revert any changes it has made upon the completion or cancellation of its task. Please note that setup must be running with administrator privileges and full elevation for any attempted changes to succeed.

Return result in variable

If you wish to receive information on whether the file was successfully downloaded, enter the variable to hold success information here. Possible values are:

• SUCCESS: File was downloaded successfully.
• INVALID_PARAM: An invalid parameter was specified, as such the download was not started or completed.
• OUTPUT_PATH_INVALID: Invalid destination folder for download.
• OUTPUT_PATH_CREATE_ERROR: Failed to create requested download folder.
• CACHE_PATH_CREATE_ERROR: Unable to create cache path (used to facilitate resuming interrupted downloads).
• MAGNET_INVALID: An invalid magnet link was specified.
• TORRENT_INVALID: An invalid torrent file was specified.
• USER_ABORTED: End-user cancelled download.
• FIREWALL_EXCEPTION_FAILED: Unable to define firewall exceptions on target system, ensure setup is running elevated.
• FAILURE: General failure during download process.

If specified, this variable must have been previously defined in the setup script using the Set Variable command.

Use Proxy Server (optional)

If the target network requires proxy server configuration, check this box and supply the details below.

Proxy Server

If you wish to redirect the download through a proxy server, provide that information here.

Proxy Port

If the proxy server requires port information, enter that here.

 Notes

• Since downloads can take some amount of time, it is recommended you use the Display Dialog command to show a progress dialog while your download is taking place.
• This plug-in is a setup engine download provider and may be registered as such using the Use Download Engine command. This will enable you to host all your Web Media Blocks on peer to peer networks. For more information, please see the topic titled Hosting Web Media Blocks as Torrents.
• This plug-in does automatically resume broken downloads.