X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=documentation_fr.md;h=ff3cfe81cd4139dbbdca0bb5a86c201a5c355a26;hb=7df12958bed6544b36bc946cdbb185ff2011733c;hp=a55ae73de4873ff80174c157bca7d2e9a811b39f;hpb=faed2fa84ff988067532ae880df1ca00efb6a993;p=perso%2FImmae%2FProjets%2FPython%2FMusicSampler.git diff --git a/documentation_fr.md b/documentation_fr.md index a55ae73..ff3cfe8 100644 --- a/documentation_fr.md +++ b/documentation_fr.md @@ -103,7 +103,9 @@ gardées d'une fois sur l'autre. ### Options disponibles au lancement Toutes les options au lancement sont facultatives ; la plupart du temps lancer -le programme dans le bon dossier suffit. +le programme dans le bon dossier suffit. La plupart d'entre elles peuvent être +définies également dans le fichier de config (à part `--config` bien sûr). Les +arguments en ligne de commande ont toujours la priorité. * `-h, --help` : affiche une liste des options disponibles. * `-c CONFIG, --config CONFIG` : précise le fichier de configuration à charger @@ -111,20 +113,21 @@ le programme dans le bon dossier suffit. music_sampler). * `-p MUSIC_PATH, --music-path MUSIC_PATH` : précise le chemin des musiques (par défaut, le dossier courant). - * `-d, --debug` : Affiche les informations de déboggage (désactivé par défaut) + * `--no-debug, --debug` : Affiche les informations de déboggage (désactivé par + défaut) * `-V, --version` : affiche la version courante et quitte (utilisable uniquement pour la version compilée). * `-L, --language` : change la langue de l'application. Actuellement: fr, en (par défaut 'fr') - * `--no-focus-warning`: Ne pas afficher d'avertissement lorsque l'application - perd le focus. + * `--focus-warning, --no-focus-warning`: Afficher / Ne pas afficher + d'avertissement lorsque l'application perd le focus (activé par défaut). Les options suivantes sont plutôt réservées à un usage avancé de music_sampler, ou en cas de problème avec la configuration standard : - * `-m, --builtin-mixing` Effectue en interne le mixage des sons. Par défaut, - music_sampler confie le mixage au système : n'activer cette option que si le - système n'y parvient pas. + * `--no-builtin-mixing, --builtin-mixing` Effectue en interne le mixage des + sons. Par défaut, music_sampler confie le mixage au système : n'activer + cette option que si le système n'y parvient pas. * `-l LATENCY, --latency LATENCY` : latence. Préciser "low", "high" ou un nombre de secondes (par défaut, "high") * `-b BLOCKSIZE, --blocksize BLOCKSIZE` : taille des blocs. Nombre de frames @@ -158,6 +161,9 @@ ne se lance pas du tout. Le fichier contient plusieurs sections : :::yaml + config: + ... + aliases: ... @@ -171,6 +177,15 @@ Le fichier contient plusieurs sections : ... +### `config` + +La section config permet d'enregistrer les paramètres habituellement donnés en +ligne de commande. Les '-' dans le nom du paramètre long doivent être remplacés +par des '_' (par exemple '--music-path' -> 'music_path'). Pour les switches +(`debug`, `focus_warning`, `builtin_mixing`), utilisez la version sans le 'no-' +et spécifiez `true` / `false` en valeur. Notez que les arguments donnés en ligne +de commande sont toujours prioritaires sur les valeurs du fichier. + ### `music_properties` : propriétés des musiques Cette section sert à définir des propriétés globales des musiques. @@ -233,6 +248,11 @@ secondes d'intervalle, le second appui est ignoré. successifs sur la touche. La touche est désactivée (grisée et barrée) pendant toute la durée des actions puis le délai de x secondes. +### Propriété `common` + +Une entrée spéciale `common` s'applique à toutes les touches. Les propriétés +définies dans cette entrée peuvent être modifiées individuellement. + ### `keys` : actions sur les touches Cette section sert à décrire, pour chaque touche, la liste des actions @@ -412,10 +432,9 @@ successivement mais sans attendre (donc presque simultanément) : ne pas hésite suite de celle-ci puisqu'elles seront systématiquement interrompues. - `interrupt_wait`: interrompt l'attente (de `wait` ou fin d'un fondu avec attente) et passe directement à l'action suivante. Paramètre : - * `wait_id: name` : précise l'identifiant du `wait` à stopper (défini par - `set_wait_id`, voir les actions `wait` et `stop`). Pour interrompre - plusieurs `wait` d'un seul coup, il faut mettre plusieurs - `interrupt_wait`. + * `wait_id: name` (facultatif) précise l'identifiant du `wait` à stopper + (défini par `set_wait_id`, voir les actions `wait` et `stop`). Si absent, + interrompt toutes les attentes. - `run_command` : lance une commande. Paramètres : * `command: my_command` : précise la commande à lancer. * `wait: true/false` (facultatif, défaut : false) : si `wait` est true,