Peertube
/
kodi.plugin.video.peertube
mirror of https://framagit.org/StCyr/plugin.video.peertube
1
0
Fork 0
Code Issues Releases Wiki Activity
kodi.plugin.video.peertube/README.md

61 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

Release 1.0.0 Update the major version because the external API to play videos received non-backward compatible changes.
2021-04-09 00:05:12 +02:00
A Kodi add-on for watching content hosted on [PeerTube](http://joinpeertube.org/).
Added README.md file
2018-07-27 11:05:13 +02:00
Release 1.0.0 Update the major version because the external API to play videos received non-backward compatible changes.
2021-04-09 00:05:12 +02:00
This code is under development but some basic features work, and you're welcome
to improve it.
[[_TOC_]]
Added README.md file
2018-07-27 11:05:13 +02:00
Release 0.3.2
2021-04-08 23:04:46 +02:00
# Features
Documented addon functionalities in README.md file
2018-07-31 11:43:38 +02:00
* Browse all videos on a PeerTube instance
Release 0.3.2
2021-04-08 23:04:46 +02:00
* Search for videos on a PeerTube instance
Release 1.0.0 Update the major version because the external API to play videos received non-backward compatible changes.
2021-04-09 00:05:12 +02:00
* Select PeerTube instance to use (**doesn't work yet**)
Allow playing videos only with the video ID Now the "play_video" action can be called with the ID of the video (and optionally the URL of the instance hosting the video) as parameter instead of the full URL: it will allow other add-ons to call the add-on to play videos since the full URL contains the resolution which is not known. It led to some refactoring and changes in the code: * Only the instance and the id of a video is retrieved when browsing and listing videos which improves the performance a lot (the video URL and the resolution are defined only when the video is played) * the "https://" prefix is now automatically added to the instances URL because the instance-related REST APIs use URLs without this prefix. It also simplifies the external API because the user does not have to provide this prefix. Consequently the prefix was removed from the default value of the selected instance in the settings: it simplifies the code but it generates a non-backward compatible change. The impact is limited because it can be easily fixed by resetting the settings to the default value and there are very few users currently. Other changes: - manage errors when retrieving the information of a video - fix some PEP 8 errors
2021-03-31 23:58:10 +02:00
* Select the preferred video resolution: the plugin will try to play the select
video resolution.
If it's not available, it will play the lower resolution that is the closest
from your preference.
If not available, it will play the higher resolution that is the closest from
your preference.
Documented addon functionalities in README.md file
2018-07-31 11:43:38 +02:00
# User settings
Updated README.md to match latest development.
2018-09-19 09:22:30 +02:00
* Preferred PeerTube instance
* Preferred video resolution
Bumped to version 0.3.0
2018-07-31 16:52:45 +02:00
* Number of videos to display per page
Release 0.3.2
2021-04-08 23:04:46 +02:00
* Sort method to be used when listing videos (Currently, only 'views' and
'likes')
* Select the filter to use when browsing the videos on an instance:
* local will only display the videos which are local to the selected instance
* all-local will only display the videos which are local to the selected
instance plus the private and unlisted videos **(requires admin privileges)**
Documented addon functionalities in README.md file
2018-07-31 11:43:38 +02:00
Allow playing videos only with the video ID Now the "play_video" action can be called with the ID of the video (and optionally the URL of the instance hosting the video) as parameter instead of the full URL: it will allow other add-ons to call the add-on to play videos since the full URL contains the resolution which is not known. It led to some refactoring and changes in the code: * Only the instance and the id of a video is retrieved when browsing and listing videos which improves the performance a lot (the video URL and the resolution are defined only when the video is played) * the "https://" prefix is now automatically added to the instances URL because the instance-related REST APIs use URLs without this prefix. It also simplifies the external API because the user does not have to provide this prefix. Consequently the prefix was removed from the default value of the selected instance in the settings: it simplifies the code but it generates a non-backward compatible change. The impact is limited because it can be easily fixed by resetting the settings to the default value and there are very few users currently. Other changes: - manage errors when retrieving the information of a video - fix some PEP 8 errors
2021-03-31 23:58:10 +02:00
# API
This add-on can be called from other add-ons in Kodi to play videos thanks to
the following API:
`plugin://plugin.video.peertube/?action=play_video&instance=<instance>&id=<id>`
where:
* `<instance>` is the base URL of the instance hosting the video
* `<id>` is the ID or the UUID of the video on the instance server
For instance to play the video behind the URL
`https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d` call
the add-on with:
`plugin://plugin.video.peertube/?action=play_video&instance=framatube.org&id=9c9de5e8-0a1e-484a-b099-e80766180a6d`
Added a "Limitations" chapter in the README.md file to talk about the fact that webtorrent isn't supported yet.
2018-07-31 12:40:56 +02:00
# Limitations
Allow playing videos only with the video ID Now the "play_video" action can be called with the ID of the video (and optionally the URL of the instance hosting the video) as parameter instead of the full URL: it will allow other add-ons to call the add-on to play videos since the full URL contains the resolution which is not known. It led to some refactoring and changes in the code: * Only the instance and the id of a video is retrieved when browsing and listing videos which improves the performance a lot (the video URL and the resolution are defined only when the video is played) * the "https://" prefix is now automatically added to the instances URL because the instance-related REST APIs use URLs without this prefix. It also simplifies the external API because the user does not have to provide this prefix. Consequently the prefix was removed from the default value of the selected instance in the settings: it simplifies the code but it generates a non-backward compatible change. The impact is limited because it can be easily fixed by resetting the settings to the default value and there are very few users currently. Other changes: - manage errors when retrieving the information of a video - fix some PEP 8 errors
2021-03-31 23:58:10 +02:00
* This add-on doesn't support Webtorrent yet. So, it cannot download/share
Release 1.0.0 Update the major version because the external API to play videos received non-backward compatible changes.
2021-04-09 00:05:12 +02:00
from/to regular PeerTube clients.
Allow playing videos only with the video ID Now the "play_video" action can be called with the ID of the video (and optionally the URL of the instance hosting the video) as parameter instead of the full URL: it will allow other add-ons to call the add-on to play videos since the full URL contains the resolution which is not known. It led to some refactoring and changes in the code: * Only the instance and the id of a video is retrieved when browsing and listing videos which improves the performance a lot (the video URL and the resolution are defined only when the video is played) * the "https://" prefix is now automatically added to the instances URL because the instance-related REST APIs use URLs without this prefix. It also simplifies the external API because the user does not have to provide this prefix. Consequently the prefix was removed from the default value of the selected instance in the settings: it simplifies the code but it generates a non-backward compatible change. The impact is limited because it can be easily fixed by resetting the settings to the default value and there are very few users currently. Other changes: - manage errors when retrieving the information of a video - fix some PEP 8 errors
2021-03-31 23:58:10 +02:00
* The add-on doesn't delete the downloaded files at the moment. So, it may fill
up your disk.
Added a "Limitations" chapter in the README.md file to talk about the fact that webtorrent isn't supported yet.
2018-07-31 12:40:56 +02:00
Release 1.0.0 Update the major version because the external API to play videos received non-backward compatible changes.
2021-04-09 00:05:12 +02:00
# Installation and requirements
Added README.md file
2018-07-27 11:05:13 +02:00
Release 1.0.0 Update the major version because the external API to play videos received non-backward compatible changes.
2021-04-09 00:05:12 +02:00
Please read the
[wiki](https://framagit.org/StCyr/plugin.video.peertube/-/wikis/home)
for more information.