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.

ChampType JSONValeur par défaut ou signification
namestringNom d’affichage de la catégorie requis
packNamestring ou nullChaîne vide
packIdstring ou nullAucun paquet associé
iconinteger ou nullCode point de l’icône du dossier de la ressource
iconFamilystring ou nullMaterialIcons
iconPackagestring ou nullAucun paquet d’icônes
iconRefobject ou nullRéférence au registre avec pack, name, et un entier facultatif version
colorinteger ou nullEntier ARGB de la couleur ; gris lorsqu’il est omis
isDefaultboolean ou nullfalse
singleLoopboolean ou nullfalse
oneShotboolean ou nullfalse ; utilisez true pour une catégorie Echo
singlePlayTransitionTostring ou nullChaîne vide
singlePlayTransitionMsinteger ou nullDurée du minuteur en millisecondes
singlePlayTransitionTrackCountinteger ou null1
singlePlayStopPlaybackboolean ou nullfalse
timerEnabledboolean ou nullfalse
enabledboolean ou nulltrue
indexinteger ou null-1
keystring ou nullClé de catégorie de la marketplace inexistante
minPauseinteger ou nullPause minimale en millisecondes ; 0
maxPauseinteger ou nullPause maximale en millisecondes ; 0
crossfadeDurationnumber ou nullSecondes ; 0. Les valeurs négatives chevauchent les pistes
transitionsEnabledboolean ou nullfalse
nameIntlobject ou nullCarte chaîne-nom spécifique à la locale
versioninteger ou nullVersion des données de catégorie
initialVolumenumber ou nullGain interne initial ; non remplacé lorsqu’il est omis
targetVolumenumber ou nullGain interne cible ; non remplacé lorsqu’il est omis
initialTransitioninteger ou nullTransition initiale en millisecondes
initialPlaybackSpeednumber ou nullMultiplicateur de vitesse de lecture
ambianceDuckingPercentnumber ou nullPourcentage de réduction du volume musical de 0 à 100
iconTypestring ou nullfontIcon ou customIcon ; par défaut fontIcon
customIconPathstring ou nullChemin 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.