diff --git a/readme.md b/readme.md index fd5456f..6af2a0b 100644 --- a/readme.md +++ b/readme.md @@ -8,8 +8,8 @@ the media that is most similar to what you wish to add. ## Best Practices - Use an alpha-numeric id. Don't use dashes or hyphens; Uppercase characters *may* be used when appropriate. -- Declare metadata when available. If you do not know the original source, try to find it first. -- Metadata **must** be accurate and not an artists rendition of the actual metadata. +- Declare attribution info (track info) when available. If you do not know the original source, try to find it first. +- Attribution info **must** be accurate and not an artists rendition. - Items that aren't primarily music should be tagged with `misc`. - Use the `metadata-prefer-id` tag if the actual title would be too long, cubersome, or unrelated. i.e: - `slamtris`: Slamtris - Quad City DJs vs Hirokazu Tanaka *(cumbersome)* @@ -42,6 +42,19 @@ the media that is most similar to what you wish to add. - Avoid using `EDisplayType.LANDSCAPE` when possible. - `EDisplayType.SQUARE` previews **must** be exactly `1:1`; `EDisplayType.LANDSCAPE` previews *should* be exactly `16:9`, or **must** be a close equivalent +### `addTrackInfo` + +`setMetadata` will be deprecated in favor of `addTrackInfo` to allow additional attribution information to be stored. + +`addTrackInfo` is more verbose than `setMetadata`. Check the JSDoc blocks for `RadioMetadata.new` + +`RadioMetadata` methods beginning with `b` are auto-generated from `BMetadataType`. + +Avoid being *too autistic* with additional info, just note the main stuff. You don't have to add the Randy Marsh saying nigger clip +because it's used a single time in a ytpmv. + +Support for raw `href` values will remain, however an appropriate `createURI` function should be used instead. + ## Format The `songs.json` format **is only intended for use for Glowers Radio**, and is effectively a living standard as a result. **Live data may change drastically without warning** @@ -111,9 +124,8 @@ properties: title: { type: string } artist: { type: string } href: - description: 'A URL the original source can be found, if known. Link may be dead' - type: string - format: url + $ref: "#/$defs/GWRadioURI" + description: 'A URI where the original source can be found, if known. Link may be dead' _nigid: $seeAlso: '#/properties/songs/items/properties/tags/items/1' description: 'The original song id from nigge.rs.' @@ -146,3 +158,4 @@ properties: size: { type: string } ``` +