Add a documentation page on all available URL parameters.

This commit is contained in:
FireMasterK 2022-02-02 06:07:31 +00:00
parent 9f5da8a440
commit 1eafc53554
No known key found for this signature in database
GPG key ID: 49451E4482CC5BCD

View file

@ -0,0 +1,115 @@
---
title: "URL Parameters"
weight: 4
summary: A list of all parameters that can be used in the default frontend.
---
## URL Parameters
### instance
**Example**: instance=https://pipedapi.kavin.rocks
This parameter can be used to force the frontend to use a specific instance.
### watchHistory
**Example**: watchHistory=true
This parameter can be used to enable saving of watch history in the IndexedDB.
### hl
**Example**: hl=fr
This parameter can be used to set the language to be used by the frontend.
### region
**Example**: region=us
This parameter can be used to set the region to be used when fetching the trending videos.
### theme
**Example**: theme=light
This parameter can be used to set the theme to be used by the frontend.
### playerAutoPlay
**Example**: playerAutoPlay=true
This parameter can be used to control the autoplay of the player on a page's load.
### listen
**Example**: listen=true
This parameter can be used to enable audio-only mode on a particular video.
### quality
**Example**: quality=1080
This parameter can be used to set the quality of the video on a page.
### bufferGoal
**Example**: bufferGoal=120
This parameter sets the buffer goal of the video in seconds.
### minimizeDescription
**Example**: minimizeDescription=true
This parameter can be used to hide the description of a video by default.
### enabledCodecs
**Example**: av1,vp9,avc
This parameter can be used to set the enabled codecs for the the video player.
### disableLBRY
**Example**: disableLBRY=true
This parameter can be used to disable using LBRY's servers for streaming.
### proxyLBRY
**Example**: proxyLBRY=false
This parameter can be used to use LBRY's servers instead of Google's servers for streaming when available.
### sponsorblock
**Example**: sponsorblock=true
This parameter can be used to enable or disable SponsorBlock on a video.
### selectedSkip
**Example**: selectedSkip=sponsor,intro,outro,preview,interaction,selfpromo,music_offtopic,poi_highlight,filler
This parameter can be used to set the parameters to be used in SponsorBlock.
### volume
**Example**: volume=0.75
This parameter can be used to set the volume of the video player.
### rate
**Example**: rate=2
This parameter can be used to set the playback rate of the video player.
### autoplay
**Example**: autoplay=true
This parameter can be used to set the autoplay of the next video.