Skip to content

Commit

Permalink
Merge pull request #276 from mhdzumair/patch-1
Browse files Browse the repository at this point in the history
stream: Update doc about sources attribute support
  • Loading branch information
jaruba authored Apr 19, 2024
2 parents 3155a6a + 4d713a5 commit 3f8ba7c
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/api/responses/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ Used as a response for [`defineStreamHandler`](../requests/defineStreamHandler.m

- ``subtitles`` - _optional_ - array of [``Subtitle objects``](./subtitles.md) representing subtitles for this stream

- ``sources`` - _optional_ - array of strings, represents a list of torrent tracker URLs and DHT network nodes. This attribute can be used to provide additional peer discovery options when `infoHash` is also specified, but it is not required. If used, each element can be a tracker URL (`tracker:<protocol>://<host>:<port>`) where `<protocol>` can be either `http` or `udp`. UDP trackers typically offer faster response times compared to HTTP trackers. A DHT node (`dht:<node_id/info_hash>`) can also be included.
> **WARNING**: Use of DHT may be prohibited by some private trackers as it exposes torrent activity to a broader network, potentially finding more peers.
- `behaviorHints` (all are optional)
- `countryWhitelist`: which hints it's restricted to particular countries - array of ISO 3166-1 alpha-3 country codes **in lowercase** in which the stream is accessible
- `notWebReady`: applies if the protocol of the url is http(s); needs to be set to `true` if the URL does not support https or is not an MP4 file
Expand Down

0 comments on commit 3f8ba7c

Please sign in to comment.