Format de fichier de bibliothèque
<- retour à la racine du document
library.json
Une bibliothèque Audio Forge exportée est une archive ZIP contenant un descripteur library.json et ses fichiers audio. Le schéma lisible par machine actuel est :
Schéma de bibliothèque Audio Forge v1
Les entiers et les nombres à virgule flottante JSON sont tous deux valides pour les champs de type number.
Par exemple, "ambianceDuckingPercent": 0 et
"ambianceDuckingPercent": 0.0 sont équivalents.
Le descripteur contient exactement une propriété de niveau supérieur. Son nom est le
nom d’affichage de la bibliothèque. La bibliothèque peut contenir Music, Ambiance, et la
section héritée Sound. Chaque section mappe les noms de catégorie aux objets de catégorie.
{
"My Library": {
"Music": {
"Battle": {
"name": "Battle",
"packName": "user",
"enabled": true,
"oneShot": false,
"iconType": "fontIcon",
"targetVolume": 1.0
}
},
"Ambiance": {
"Thunder": {
"name": "Thunder",
"packName": "user",
"enabled": true,
"oneShot": true,
"ambianceDuckingPercent": 0
}
}
}
}
Seul name est requis dans un objet de catégorie. Les champs facultatifs omis utilisent les
valeurs par défaut indiquées ci-dessous. Un champ marqué comme nullable peut également être défini sur null.
| Champ | Type JSON | Valeur par défaut ou signification |
|---|---|---|
name | string | Nom d’affichage de la catégorie requis |
packName | string ou null | Chaîne vide |
packId | string ou null | Aucun paquet associé |
icon | integer ou null | Code point de l’icône du dossier de la ressource |
iconFamily | string ou null | MaterialIcons |
iconPackage | string ou null | Aucun paquet d’icônes |
iconRef | object ou null | Référence au registre avec pack, name, et un entier facultatif version |
color | integer ou null | Entier ARGB de la couleur ; gris lorsqu’il est omis |
isDefault | boolean ou null | false |
singleLoop | boolean ou null | false |
oneShot | boolean ou null | false ; utilisez true pour une catégorie Echo |
singlePlayTransitionTo | string ou null | Chaîne vide |
singlePlayTransitionMs | integer ou null | Durée du minuteur en millisecondes |
singlePlayTransitionTrackCount | integer ou null | 1 |
singlePlayStopPlayback | boolean ou null | false |
timerEnabled | boolean ou null | false |
enabled | boolean ou null | true |
index | integer ou null | -1 |
key | string ou null | Clé de catégorie de la marketplace inexistante |
minPause | integer ou null | Pause minimale en millisecondes ; 0 |
maxPause | integer ou null | Pause maximale en millisecondes ; 0 |
crossfadeDuration | number ou null | Secondes ; 0. Les valeurs négatives chevauchent les pistes |
transitionsEnabled | boolean ou null | false |
nameIntl | object ou null | Carte chaîne-nom spécifique à la locale |
version | integer ou null | Version des données de catégorie |
initialVolume | number ou null | Gain interne initial ; non remplacé lorsqu’il est omis |
targetVolume | number ou null | Gain interne cible ; non remplacé lorsqu’il est omis |
initialTransition | integer ou null | Transition initiale en millisecondes |
initialPlaybackSpeed | number ou null | Multiplicateur de vitesse de lecture |
ambianceDuckingPercent | number ou null | Pourcentage de réduction du volume musical de 0 à 100 |
iconType | string ou null | fontIcon ou customIcon ; par défaut fontIcon |
customIconPath | string ou null | Chemin d’accès à l’icône personnalisée dans la bibliothèque |
Les champs de volume de catégorie dans library.json utilisent la plage de gain interne d’Audio Forge,
où 1.0 est l’unité et 2.0 est le maximum boosté. Cela diffère de l'
échelle 0.0 à 1.0 normalisée de l’API Locale.
Chemins d’accès aux archives
Les fichiers audio utilisent les noms de catégorie de library.json :
library.json
Music/Battle/battle-theme.ogg
Ambiance/Thunder/thunder.ogg
Les fichiers d’icônes personnalisés exportés par Audio Forge sont stockés sous user_icons/.
Les métadonnées de transition facultatives sont stockées dans transitions/transitions.json, et
les états enregistrés facultatifs sont stockés dans saved_states.json.
Audio Forge valide le descripteur complet avant de modifier une bibliothèque. Un champ non valide produit une erreur contenant son chemin d’accès à la bibliothèque, à la section, à la catégorie et au champ.