Skip to content

/ webtorrent

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs #694

Closed
wants to merge 10 commits into from
+39 −18
Closed

Improve docs #694

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8c6810a
Change magnetURI to torrentId
FluorescentHallucinogen Mar 25, 2016
59a2ecf
Use complete magnet URI
FluorescentHallucinogen Mar 25, 2016
9c9bfc9
Add port variable
FluorescentHallucinogen Mar 25, 2016
418b667
Change magnetURI to torrentId
FluorescentHallucinogen Mar 25, 2016
19cd49b
Use real magnet URI
FluorescentHallucinogen Mar 25, 2016
caf2ce4
Remove concrete ways of install and use modules
FluorescentHallucinogen Mar 25, 2016
5f90276
Change magnetURI to torrentId
FluorescentHallucinogen Mar 25, 2016
8a3cde6
Use real magnet URI
FluorescentHallucinogen Mar 25, 2016
8ce5dd0
Remove concrete ways of install and use modules
FluorescentHallucinogen Mar 25, 2016
155ca7b
Fix broken link and add ways to specify a torrent
FluorescentHallucinogen Mar 25, 2016
File filter...
Filter file types
Clear filters
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

Prev Next

Use real magnet URI 

Use real magnet URI to keep example working.
  • Loading branch information
@FluorescentHallucinogen
FluorescentHallucinogen committed Mar 25, 2016
commit 8a3cde64194f6ec37977ac015455dd6b389b249d
2 README.md
View file
Open in desktop
@@ -145,7 +145,7 @@ standards (no plugins, just HTML5 and WebRTC)! It's easy to get started!
var WebTorrent = require('webtorrent')
var client = new WebTorrent()
var torrentId = '...'
var torrentId = 'magnet:?xt=urn:btih:6a9759bffd5c0af65319979fb7832189f4f3c35d&dn=sintel.mp4&tr=wss%3A%2F%2Ftracker.btorrent.xyz&tr=wss%3A%2F%2Ftracker.fastcast.nz&tr=wss%3A%2F%2Ftracker.openwebtorrent.com&tr=wss%3A%2F%2Ftracker.webtorrent.io&ws=https%3A%2F%2Fwebtorrent.io%2Ftorrents%2Fsintel-1024-surround.mp4'

This comment has been minimized.

Sign in to view
Copy link
@rom1504

rom1504 Mar 25, 2016

Member

That's a magnet uri. What is a torrent id ?

This comment has been minimized.

Sign in to view
Copy link
@FluorescentHallucinogen

FluorescentHallucinogen Mar 25, 2016

Author Contributor

@rom1504

Please look at client.add API: client.add(torrentId, [opts], [function ontorrent (torrent) {}])

Every magnet URI is torrent id. But not every torrent id is magnet URI.

torrentId can be one of:

  • magnet uri (string)
  • torrent file (buffer)
  • info hash (hex string or buffer)
  • parsed torrent (from parse-torrent)
  • http/https url to a torrent file (string)
  • filesystem path to a torrent file (string)

E.g. you can change
var magnetURI = 'magnet:?xt=urn:btih:6a9759bffd5c0af65319979fb7832189f4f3c35d'
to
var magnetURI = 'https://webtorrent.io/torrents/sintel.torrent'
in this example and the resulting code will still work, bacause torrentId argument of client.add is not limited only to magnet URIs, but in this case using magnetURI as a name of variable is not a good idea, because actually it is not a magnet URI, it is URL to *.torrent file.
client.add(torrentId, function (torrent) {
// Got torrent metadata!
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.