mirror of
https://github.com/TeamPiped/documentation.git
synced 2024-08-14 23:50:09 +00:00
845e2fc312
This parmeter is actually processed by piped but it was not included in documentation for some reason. Add description for that since not having it here may be a little misleading.
127 lines
2.7 KiB
Markdown
127 lines
2.7 KiB
Markdown
---
|
|
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.
|
|
|
|
### minimizeComments
|
|
|
|
**Example**: minimizeComments=true
|
|
|
|
This parameter can be used to hide the list of comments on the bottom, by default.
|
|
|
|
### minimizeRecommendations
|
|
|
|
**Example**: minimizeRecommendations=true
|
|
|
|
This parameter can be used to hide the list of recommendations on the right, 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.
|