Bibliotheksdateiformat

<- zurück zur Dokumentwurzel

library.json

Eine exportierte Audio Forge-Bibliothek ist ein ZIP-Archiv, das einen library.json Deskriptor und seine Audiodateien enthält. Das aktuelle, für Maschinen lesbare Schema ist:

Audio Forge-Bibliotheksschema v1

JSON-Integer und -Dezimalzahlen sind für Felder vom Typ number gültig. Zum Beispiel "ambianceDuckingPercent": 0 und "ambianceDuckingPercent": 0.0 sind äquivalent.

Der Deskriptor enthält genau eine oberste Eigenschaft. Ihr Name ist der Anzeigename der Bibliothek. Die Bibliothek kann Music, Ambiance und den veralteten Sound-Abschnitt enthalten. Jeder Abschnitt ordnet Kategorienamen Kategorieobjekten zu.

{
  "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
      }
    }
  }
}

Nur name ist in einem Kategorieobjekt erforderlich. Fehlende optionale Felder verwenden die Standardwerte, die unten angezeigt werden. Ein Feld, das als nullable gekennzeichnet ist, kann auch auf null gesetzt werden.

FeldJSON-TypStandardwert oder Bedeutung
namestringErforderlicher Anzeigename der Kategorie
packNamestring oder nullLeerer String
packIdstring oder nullKein zugehöriges Paket
iconinteger oder nullMaterialordner-Symbol-Code-Punkt
iconFamilystring oder nullMaterialIcons
iconPackagestring oder nullKein Symbolpaket
iconRefobject oder nullRegistry-Referenz mit pack, name und optionalem Integer version
colorinteger oder nullARGB-Farb-Integer; grau, wenn er fehlt
isDefaultboolean oder nullfalse
singleLoopboolean oder nullfalse
oneShotboolean oder nullfalse; Verwenden Sie true für eine Echo-Kategorie
singlePlayTransitionTostring oder nullLeerer String
singlePlayTransitionMsinteger oder nullTimer-Dauer in Millisekunden
singlePlayTransitionTrackCountinteger oder null1
singlePlayStopPlaybackboolean oder nullfalse
timerEnabledboolean oder nullfalse
enabledboolean oder nulltrue
indexinteger oder null-1
keystring oder nullKein Marketplace-Kategorischlüssel
minPauseinteger oder nullMinimale Pause in Millisekunden; 0
maxPauseinteger oder nullMaximale Pause in Millisekunden; 0
crossfadeDurationnumber oder nullSekunden; 0. Negative Werte überlappen Tracks
transitionsEnabledboolean oder nullfalse
nameIntlobject oder nullLocale-zu-Name-String-Map
versioninteger oder nullKategorie-Datenversion
initialVolumenumber oder nullInitialer interner Gain; wird bei Auslassen nicht überschrieben
targetVolumenumber oder nullZiel-interner Gain; wird bei Auslassen nicht überschrieben
initialTransitioninteger oder nullInitialer Übergang in Millisekunden
initialPlaybackSpeednumber oder nullWiedergabegeschwindigkeit-Multiplikator
ambianceDuckingPercentnumber oder nullMusik-Ducking-Prozentsatz von 0 zu 100
iconTypestring oder nullfontIcon oder customIcon; standardmäßig fontIcon
customIconPathstring oder nullPfad des benutzerdefinierten Symbols innerhalb der Bibliothek

Kategorie-Lautstärke-Felder in library.json verwenden Audio Forge’s internen Gain-Bereich, wobei 1.0 die Einheit und 2.0 das maximale Boost ist. Dies unterscheidet sich von der Local API’s normalisierten 0.0 zu 1.0 Anzeige-Skala.

Archivpfade

Audiodateien verwenden die Kategorie-Namen aus library.json:

library.json
Music/Battle/battle-theme.ogg
Ambiance/Thunder/thunder.ogg

Benutzerdefinierte Symboldateien, die von Audio Forge exportiert werden, werden unter user_icons/ gespeichert. Optionale Übergangs-Metadaten werden in transitions/transitions.json gespeichert, und optionale gespeicherte Zustände werden in saved_states.json gespeichert.

Audio Forge validiert den gesamten Deskriptor, bevor eine Bibliothek geändert wird. Ein ungültiges Feld erzeugt einen Fehler, der seine Bibliothek, seinen Abschnitt, seine Kategorie und sein Feld enthält.