Skip to content

Commit 4b088e8

Browse files
authored
docs(guide): add detailed page for player settings (#11)
1 parent 2c543f3 commit 4b088e8

File tree

4 files changed

+229
-4
lines changed

4 files changed

+229
-4
lines changed

docs/.vitepress/en.mts

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export const en = defineConfig({
1414
sidebar: {
1515
"/user-guide/": [
1616
{
17-
text: "User Guide",
17+
text: "Getting Started",
1818
items: [
1919
{
2020
text: "Introduction",
@@ -24,6 +24,11 @@ export const en = defineConfig({
2424
text: "Installation",
2525
link: "/user-guide/installation",
2626
},
27+
],
28+
},
29+
{
30+
text: "Core Concepts",
31+
items: [
2732
{
2833
text: "Core Features",
2934
link: "/user-guide/core-features",
@@ -38,6 +43,15 @@ export const en = defineConfig({
3843
},
3944
],
4045
},
46+
{
47+
text: "Settings",
48+
items: [
49+
{
50+
text: "Player Settings",
51+
link: "/user-guide/settings-player",
52+
},
53+
],
54+
},
4155
],
4256
"/developer-guide/": [
4357
{

docs/.vitepress/fr.mts

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export const fr = defineConfig({
1818
sidebar: {
1919
"/fr/user-guide/": [
2020
{
21-
text: "Guide de l'Utilisateur",
21+
text: "Pour Commencer",
2222
items: [
2323
{
2424
text: "Introduction",
@@ -28,6 +28,11 @@ export const fr = defineConfig({
2828
text: "Installation",
2929
link: "/fr/user-guide/installation",
3030
},
31+
],
32+
},
33+
{
34+
text: "Concepts Clés",
35+
items: [
3136
{
3237
text: "Fonctionnalités Clés",
3338
link: "/fr/user-guide/core-features",
@@ -42,6 +47,15 @@ export const fr = defineConfig({
4247
},
4348
],
4449
},
50+
{
51+
text: "Paramètres",
52+
items: [
53+
{
54+
text: "Paramètres du Lecteur",
55+
link: "/fr/user-guide/settings-player",
56+
},
57+
],
58+
},
4559
],
4660
"/fr/developer-guide/": [
4761
{
@@ -57,7 +71,6 @@ export const fr = defineConfig({
5771
},
5872

5973
search: {
60-
provider: "local",
6174
options: {
6275
translations: {
6376
button: {
@@ -88,7 +101,7 @@ export const fr = defineConfig({
88101

89102
footer: {
90103
message: "Publié sous la licence GNU AGPL v3.",
91-
copyright: "Copyright © 2025-present PipePipe",
104+
copyright: "Copyright © 2025-present Priveetee",
92105
},
93106

94107
editLink: {
Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# Paramètres du Lecteur
2+
3+
Cette section couvre tous les paramètres liés au lecteur vidéo et audio.
4+
5+
## Résolution par défaut
6+
7+
Définit la qualité vidéo préférée pour toutes les vidéos lues dans le lecteur principal.
8+
9+
- **Options :** Meilleure résolution, 1080p60, 1080p, 720p60, 720p, 480p, 360p, 240p, 144p.
10+
- **Défaut :** 1080p60
11+
12+
::: tip
13+
Choisir une résolution plus basse comme 720p peut aider à économiser des données mobiles et à réduire le temps de chargement sur des connexions lentes.
14+
:::
15+
16+
## Résolution popup par défaut
17+
18+
Définit la qualité vidéo préférée pour les vidéos lues dans le lecteur popup.
19+
20+
- **Options :** Identiques à la résolution par défaut.
21+
- **Défaut :** 480p
22+
23+
::: info
24+
Une résolution plus basse est souvent suffisante pour la petite fenêtre du popup et consomme moins de ressources.
25+
:::
26+
27+
## Activer les formats avancés
28+
29+
Permet au lecteur d'utiliser des codecs vidéo et audio modernes si votre appareil les prend en charge.
30+
31+
- **Options :** VP9, AV1, HEVC, EC-3.
32+
33+
::: warning
34+
Activer un format que votre appareil ne supporte pas peut entraîner un écran noir ou des plantages. WEBM ou AV1 sont nécessaires pour la lecture en 2k/4k sur YouTube.
35+
:::
36+
37+
## Limiter la résolution lors de l'utilisation des données mobiles
38+
39+
Bascule automatiquement vers une résolution inférieure lorsque vous n'êtes pas connecté au Wi-Fi pour économiser des données.
40+
41+
- **Options :** Aucune limite, 1080p60, 1080p, 720p60, 720p, 480p, 360p, 240p, 144p.
42+
- **Défaut :** 480p
43+
44+
## Nécessiter l'accent audio
45+
46+
S'assure que PipePipe est la seule application à jouer du son. Lorsque cette option est activée, les autres applications (comme les lecteurs de musique) se mettront en pause au démarrage d'une vidéo PipePipe.
47+
48+
- **Défaut :** Activé
49+
50+
## Reprendre la lecture
51+
52+
Reprend automatiquement la lecture après une interruption, comme un appel téléphonique.
53+
54+
- **Défaut :** Activé
55+
56+
## Toujours commencer la lecture depuis le début
57+
58+
Désactive la fonction de reprise de lecture pour les vidéos que vous avez déjà commencées. Chaque vidéo commencera à 00:00.
59+
60+
- **Défaut :** Désactivé
61+
62+
## Mémoriser les propriétés du popup
63+
64+
L'application se souviendra de la taille et de la position du lecteur popup de votre dernière session.
65+
66+
- **Défaut :** Activé
67+
68+
## Durée d'avance rapide/retour rapide
69+
70+
Définit la durée de saut en avant ou en arrière lorsque vous double-tapez sur les côtés du lecteur.
71+
72+
- **Options :** 5, 10, 15, 20, 25, 30 secondes.
73+
- **Défaut :** 10 secondes
74+
75+
## Appuyer longuement pour accélérer la lecture
76+
77+
Vous permet d'accélérer temporairement la vidéo en maintenant un appui long sur le lecteur.
78+
79+
- **Options :** 0.1x à 5x, Désactiver.
80+
- **Défaut :** 5x
81+
82+
## Minuterie de mise en veille
83+
84+
Arrête automatiquement la lecture après une durée définie.
85+
86+
- **Options :** 5, 10, 15, 20, 30 minutes, 1 heure.
87+
- **Défaut :** 1 heure
88+
89+
## Paramètres des gestes
90+
91+
Ouvre un sous-menu pour configurer les gestes de balayage du lecteur.
92+
93+
## Paramètres des commentaires défilants
94+
95+
Ouvre un sous-menu pour configurer les commentaires du chat en direct de style "danmaku" (défilants).
96+
97+
## Sous-titres
98+
99+
Ouvre un sous-menu pour configurer l'apparence des sous-titres.

docs/user-guide/settings-player.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# Player Settings
2+
3+
This section covers all settings related to the video and audio player.
4+
5+
## Default resolution
6+
7+
Sets the preferred video quality for all videos played in the main player.
8+
9+
- **Options:** Best resolution, 1080p60, 1080p, 720p60, 720p, 480p, 360p, 240p, 144p.
10+
- **Default:** 1080p60
11+
12+
::: tip
13+
Choosing a lower resolution like 720p can help save mobile data and reduce buffering on slow connections.
14+
:::
15+
16+
## Default popup resolution
17+
18+
Sets the preferred video quality for videos played in the popup player.
19+
20+
- **Options:** Same as default resolution.
21+
- **Default:** 480p
22+
23+
::: info
24+
A lower resolution is often sufficient for the small popup window and consumes fewer resources.
25+
:::
26+
27+
## Enable advanced formats
28+
29+
Allows the player to use modern video and audio codecs if your device supports them.
30+
31+
- **Options:** VP9, AV1, HEVC, EC-3.
32+
33+
::: warning
34+
Enabling a format that your device does not support can lead to a black screen or crashes. WEBM or AV1 are required for 2k/4k playback on YouTube.
35+
:::
36+
37+
## Limit resolution on mobile data
38+
39+
Automatically switches to a lower resolution when you are not connected to Wi-Fi to save data.
40+
41+
- **Options:** No limit, 1080p60, 1080p, 720p60, 720p, 480p, 360p, 240p, 144p.
42+
- **Default:** 480p
43+
44+
## Request audio focus
45+
46+
Ensures that PipePipe is the only app playing audio. When enabled, other apps (like music players) will pause when a PipePipe video starts.
47+
48+
- **Default:** Enabled
49+
50+
## Resume playback
51+
52+
Automatically resumes playback after an interruption, such as a phone call.
53+
54+
- **Default:** Enabled
55+
56+
## Always start from the beginning
57+
58+
Disables the "resume playback" feature for videos you've already started watching. Every video will start from 00:00.
59+
60+
- **Default:** Disabled
61+
62+
## Remember popup properties
63+
64+
The app will remember the size and position of the popup player from your last session.
65+
66+
- **Default:** Enabled
67+
68+
## Fast forward/rewind duration
69+
70+
Sets the amount of time to skip forward or backward when you double-tap the sides of the player.
71+
72+
- **Options:** 5, 10, 15, 20, 25, 30 seconds.
73+
- **Default:** 10 seconds
74+
75+
## Long press to speed up playback
76+
77+
Allows you to temporarily speed up the video by long-pressing on the player.
78+
79+
- **Options:** 0.1x to 5x, Disable.
80+
- **Default:** 5x
81+
82+
## Sleep timer
83+
84+
Automatically stops playback after a set amount of time.
85+
86+
- **Options:** 5, 10, 15, 20, 30 minutes, 1 hour.
87+
- **Default:** 1 hour
88+
89+
## Gesture settings
90+
91+
Opens a sub-menu to configure the player's swipe gestures.
92+
93+
## Scrolling comment settings
94+
95+
Opens a sub-menu to configure the danmaku-style (scrolling) live chat comments.
96+
97+
## Subtitles
98+
99+
Opens a sub-menu to configure the appearance of subtitles.

0 commit comments

Comments
 (0)