FreeTubeApp / FreeTube

An Open Source YouTube app for privacy
https://freetubeapp.io/
GNU Affero General Public License v3.0
13.37k stars 825 forks source link

[Feature Request]: Document and extend the freetube:// protocol #5591

Closed pakoito closed 2 months ago

pakoito commented 2 months ago

Guidelines

Problem Description

I would like to build interactions with the Freetube app from the browser. For that I need to understand how the freetube:// protocol works, and have some capabilities available such as "open request in a new window".

Proposed Solution

Add a section in the documentation with the protocol and API parameters allowed, i.e. youtube searches become regular searches within the app, and youtube urls open the video directly. Extend those parameters.

Alternatives Considered

I have read the code and there is no documentation available.

Issue Labels

support for external software

Additional Information

This is my use case: https://github.com/pakoito/freetube-forwarder/

absidue commented 2 months ago

The freetube:// protocol takes full YouTube URLs, just append freetube:// to the start of a YouTube URL (freetube://https://youtube.com/@YouTube and it will open that URL. So for searches just format the URL the same as YouTube does when you do a search (make sure to url encode the query parameters so that it is actually a valid URL).

If you want to see how to use it, you could always look at the code of all of the existing browser extensions that redirect to FreeTube, like the ones mentioned in the README.

absidue commented 2 months ago

and have some capabilities available such as "open request in a new window".

Things like that should be in-app settings, not something that is handled via the URL scheme and is already requested here: #1501

absidue commented 2 months ago

As this feature request now only covers documenting the URL scheme, please open an issue on the docs repo for it.