Resonite MetaDisc
 | This specification is under heavy construction, and may be missing important information. |
Res-MD is a music disc format for Resonite. It offers flexibility, metadata support, and advanced features like shuffle playback and mixtape creation. In short, Res-MD delivers the functionality that today's netizens expect of their media, in a convenient virtual package.
Res-MD is also an open specification. You can create your own Res-MD players, editors, and even custom discs, as long as they conform to this specification.
Song Orbs
Song Orbs represent individual music tracks and their associated metadata. A Res-MD disc is, at its core, just a collection of these, and every disc can be modified simply by adding, removing, or rearranging the Song Orbs within.
Structure
 | This section requires cleanup to conform to specification writing style (e.g. RFC:2119). |
The root slot of a Song Orb needs to have a few things:
- An reso:Component:ObjectRoot
- A reso:Component:DynamicVariableSpace named
SongOrb - A reso:Component:Snapper with the keyword
SongOrb - A child slot named
Metadata- This is where the dynamic variables corresponding to the song's metadata attributes are stored.
Dynamic variables
The following dynamic variables MUST be present:
_RESMD(string): Magic version identifier. Currently0.1;SongOrbAudioClip(IAssetProvider<AudioClip>): Holds a reference to the audio clip for the track._SMFIELDS(string): Semicolon-separated list of metadata attributes present.
_RESMD and AudioClip SHOULD be stored directly on the object root, while _SMFIELDS SHOULD be placed in the Metadata slot.
Additionally, the reference Song Orb implementation defines the following variables, which are used by the integrated player, and may be used:
IsPlaying(bool): Controls the orb's playback animation.IsPausing(bool): Alters the playback animation to indicate a paused state.
If your Song Orb implementation uses string-type dynamic variables not defined here, their names MUST be prefixed with an underscore to prevent collisions with track metadata.
Metadata
Res-MD track metadata is stored as dynamic variables under the Metadata slot. These variables are always string-type, and are named exactly the same as the metadata attribute.
Metadata attribute names MUST be PascalCase, and MUST NOT contain underscores, spaces, or hyphens (periods are allowed). Also, the name of every attribute in use MUST be stored in _SMFIELDS as a semicolon-delimited list: for example, if the song has Title and Artist attributes, _SMFIELDS should be Title;Artist.
Some attributes might contain multiple values; in this case, each value should be separated by a semicolon.
Standard attributes
| Name | Type | Multi-value | Description |
|---|---|---|---|
| Title | text | No | Name of the track |
| Artist | text | Yes | Artist(s) of the track |
| Album | text | No | Name of the album this track belongs to |
Integrated player
The Song Orb's integrated player exists solely for the end user. Implementors of Res-MD systems MUST NOT interface with it or assume it exists; reference the AudioClip instead.
Song Orb implementations SHOULD include their own integrated player, but are not strictly required to.
