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

85 lines
3.0 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
Create a CI job to release the add-on The CI job will take care of all the steps to create a new release in GitLab: * creation of the tag * create of the release object with the release notes All the required information will be extracted from the addon.xml file. A "pre-release" job is also added to validate the changes in addon.xml before the actual release is done. All these steps are explained in the contribution guidelines. Finally the files TESTME.md and createaddon.sh are removed since the installation steps are explained in the wiki and the archive of the add-on is created automatically by GitLab in the release. See merge request StCyr/plugin.video.peertube!12 for more information
2021-04-11 22:40:44 +02:00
This add-on is under development so only basic features work, and you're
welcome to improve it.
Support live streams Now the type of a video is defined when trying to play a video so that live streams (.m3u8) are directly played by Kodi (no download required). We are able to know if a video is live from the response of the "list" REST API but it was decided to ignore this information in order to have a single action to play video (whether it is live or not). The goal was to keep the API of the add-on as simple as possible so that externel users only have to call the add-on's API with the ID of a video, without having to add the type of the video. The information about the type of the video will anyway be available in the response used to get the URL of a video so this solution does not impact the performance.
2021-04-24 16:55:31 +02:00
If you want to contribute, please start with the
[contribution guidelines](contributing.md) and the
[pending issues](https://framagit.org/StCyr/plugin.video.peertube/-/issues).
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
Localize and translate into French the add-on * Localize all the strings so that the whole add-on can be translated (menus, notifications, etc.) * Translate all the strings into French * Add advice for future translators in the contribution guidelines * List the supported languages in the README and a link to the translation guidelines * Rearrange the parts of the README to have the most used information at the top
2021-04-29 22:38:14 +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
[[_TOC_]]
Added README.md file
2018-07-27 11:05:13 +02:00
Localize and translate into French the add-on * Localize all the strings so that the whole add-on can be translated (menus, notifications, etc.) * Translate all the strings into French * Add advice for future translators in the contribution guidelines * List the supported languages in the README and a link to the translation guidelines * Rearrange the parts of the README to have the most used information at the top
2021-04-29 22:38:14 +02:00
# Installation and prerequisites
Please read the
[wiki](https://framagit.org/StCyr/plugin.video.peertube/-/wikis/home)
for more information.
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
Support live streams Now the type of a video is defined when trying to play a video so that live streams (.m3u8) are directly played by Kodi (no download required). We are able to know if a video is live from the response of the "list" REST API but it was decided to ignore this information in order to have a single action to play video (whether it is live or not). The goal was to keep the API of the add-on as simple as possible so that externel users only have to call the add-on's API with the ID of a video, without having to add the type of the video. The information about the type of the video will anyway be available in the response used to get the URL of a video so this solution does not impact the performance.
2021-04-24 16:55:31 +02:00
* Play videos (including live videos)
* Browse the videos on a PeerTube instance
Release 0.3.2
2021-04-08 23:04:46 +02:00
* Search for videos on a PeerTube instance
Fix the selection of instances When a new instance was selected from the list of instances, it had no effect because the new instance URL was saved in an attribute that was reset at the next call of the add-on. Now when the user selects a new instance, the associated setting is updated so that this value can be reused the next time the add-on is called or started. Also took this opportunity to refactor the access to the add-on's settings: there are now wrapper methods in kodi_utils.py which encapsulates the call to Kodi APIs to make the code simpler. See merge request StCyr/plugin.video.peertube!10 for more information
2021-04-11 10:44:18 +02:00
* Select the PeerTube instance to use
Support live streams Now the type of a video is defined when trying to play a video so that live streams (.m3u8) are directly played by Kodi (no download required). We are able to know if a video is live from the response of the "list" REST API but it was decided to ignore this information in order to have a single action to play video (whether it is live or not). The goal was to keep the API of the add-on as simple as possible so that externel users only have to call the add-on's API with the ID of a video, without having to add the type of the video. The information about the type of the video will anyway be available in the response used to get the URL of a video so this solution does not impact the performance.
2021-04-24 16:55:31 +02:00
* Select the preferred video resolution: the plugin will try to play the
preferred video resolution.
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
If it's not available, it will play the lower resolution that is the closest
Support live streams Now the type of a video is defined when trying to play a video so that live streams (.m3u8) are directly played by Kodi (no download required). We are able to know if a video is live from the response of the "list" REST API but it was decided to ignore this information in order to have a single action to play video (whether it is live or not). The goal was to keep the API of the add-on as simple as possible so that externel users only have to call the add-on's API with the ID of a video, without having to add the type of the video. The information about the type of the video will anyway be available in the response used to get the URL of a video so this solution does not impact the performance.
2021-04-24 16:55:31 +02:00
to your preference.
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
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
Add German to the list of languages in the README
2021-05-14 13:13:17 +02:00
The following languages are available:
* English
* French
* German
Localize and translate into French the add-on * Localize all the strings so that the whole add-on can be translated (menus, notifications, etc.) * Translate all the strings into French * Add advice for future translators in the contribution guidelines * List the supported languages in the README and a link to the translation guidelines * Rearrange the parts of the README to have the most used information at the top
2021-04-29 22:38:14 +02:00
If you want to help translating the add-on in your language, check
[here](contributing.md#translation).
# Limitations
* This add-on doesn't support Webtorrent yet. So, it cannot download/share
from/to regular PeerTube clients.
* The add-on doesn't delete the downloaded files at the moment so it may fill
up your disk. You may delete manually the downloaded files in the folder
`<kodi_home>/temp/plugin.video.peertube/` (more information about
`<kodi_home>` [here](https://kodi.wiki/view/Kodi_data_folder#Location)).
Documented addon functionalities in README.md file
2018-07-31 11:43:38 +02:00
# User settings
Notify the user when the service started Display a notification when the PeerTube service started so that the user is aware that the add-on can be used. This notification will be useful especially on slow devices. The notification can be disabled in the settings.
2021-04-28 23:02:24 +02:00
* Preferred PeerTube instance
* Display (or not) a notification when the service starts: the notification
lets the user know that the videos can be played which may be useful on slow
devices (when the service takes some time to start)
Improve the settings layout and translation * Turn the name of the main category of the settings into a localized string * Add separators to group settings per theme * Make some settings name more explicit * Translate the possible values of the settings video_filter and video_sort_method See merge request StCyr/plugin.video.peertube!20 for more information
2021-04-27 22:24:24 +02:00
* Browsing/Searching:
* Number of items to show per page (max 100)
* Field used to sort items when listing/searching videos:
* `views`: sort by number of views (ascending only)
* `likes`: sort by number of likes (ascending only)
* Select the filter to use when browsing and searching 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)**
* Video playback:
* Preferred video resolution
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`