Bibliotheek bestandsformaat

`library.json`

Een geëxporteerde Audio Forge bibliotheek is een ZIP-archief dat een library.json beschrijver en de bijbehorende audiobestanden bevat. Het huidige machine-leesbare schema is:

Audio Forge bibliotheek schema v1

JSON-getallen en decimale getallen zijn beide geldig voor velden met het number type. Bijvoorbeeld, "ambianceDuckingPercent": 0 en "ambianceDuckingPercent": 0.0 zijn equivalent.

De beschrijver bevat precies één hoofdeigenschap. De naam is de weergangsnaam van de bibliotheek. De bibliotheek kan Music, Ambiance, en de legacy Sound sectie bevatten. Elke sectie mapt categorienamen naar categorieobjecten.

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

Alleen name is vereist in een categorieobject. Omitted optionele velden gebruiken de standaardwaarden hieronder. Een veld dat nullable is, kan ook ingesteld worden op null.

Veld	JSON type	Standaardwaarde of betekenis
`name`	string	Vereiste weergangsnaam van de categorie
`packName`	string of null	Lege string
`packId`	string of null	Geen bijbehorend pakket
`icon`	integer of null	Materiaal map pictogram code punt
`iconFamily`	string of null	`MaterialIcons`
`iconPackage`	string of null	Geen pictogram pakket
`iconRef`	object of null	Registry referentie met `pack`, `name`, en optioneel integer `version`
`color`	integer of null	ARGB kleur integer; grijs wanneer weggelaten
`isDefault`	boolean of null	`false`
`singleLoop`	boolean of null	`false`
`oneShot`	boolean of null	`false`; gebruik `true` voor een Echo categorie
`singlePlayTransitionTo`	string of null	Lege string
`singlePlayTransitionMs`	integer of null	Timer duur in milliseconden
`singlePlayTransitionTrackCount`	integer of null	`1`
`singlePlayStopPlayback`	boolean of null	`false`
`timerEnabled`	boolean of null	`false`
`enabled`	boolean of null	`true`
`index`	integer of null	`-1`
`key`	string of null	Geen marketplace categorisleutel
`minPause`	integer of null	Minimale pauze in milliseconden; `0`
`maxPause`	integer of null	Maximale pauze in milliseconden; `0`
`crossfadeDuration`	number of null	Seconden; `0`. Negatieve waarden overlappen tracks
`transitionsEnabled`	boolean of null	`false`
`nameIntl`	object of null	Locale-naar-naam string map
`version`	integer of null	Categorie data versie
`initialVolume`	number of null	Initiële interne gain; geen override wanneer weggelaten
`targetVolume`	number of null	Doel interne gain; geen override wanneer weggelaten
`initialTransition`	integer of null	Initiële transitie in milliseconden
`initialPlaybackSpeed`	number of null	Afspeelsnelheidsmultiplier
`ambianceDuckingPercent`	number of null	Muziek dempingspercentage van `0` naar `100`
`iconType`	string of null	`fontIcon` of `customIcon`; standaard is `fontIcon`
`customIconPath`	string of null	Pad van het aangepaste pictogram in de bibliotheek

Categorie volume velden in library.json gebruiken Audio Forge’s interne gain range, waar 1.0 eenheid is en 2.0 de verhoogde maximum is. Dit verschilt van de Local API’s genormaliseerde 0.0 naar 1.0 weergave schaal.

Archief paden

Audiobestanden gebruiken de categorienamen uit library.json:

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

Aangepaste pictogrambestanden die door Audio Forge worden geëxporteerd, worden opgeslagen onder user_icons/. Optionele transitie metadata wordt opgeslagen in transitions/transitions.json, en optionele opgeslagen toestanden worden opgeslagen in saved_states.json.

Audio Forge valideert de volledige beschrijver voordat een bibliotheek wordt gewijzigd. Een ongeldig veld veroorzaakt een fout die de bibliotheek, sectie, categorie en veldpad bevat.