fm.freemix.group.samples

lex-publisher.freemix.fm

Documentation

A samples group: a structural grouping of samples uploaded and presented as a unit, independent of any release (FM-824; mirrors fm.freemix.group.stems, FM-549 s38). A sample PACK is this same record with a price — one record type, pricing optional. Points DOWN at its member samples, which carry an optional parentGroup back-ref (the only upward ref); members[] is authoritative for membership and order. RELATIONSHIP TO fm.freemix.release: a release is a separate 'put-out work' wrapper that MAY include this record as one of its members; this record is the structural group itself, not the release. Selling sample packs is NOT implemented — priceCents/currency reserve the shape only.

main record

A samples group: a structural grouping of samples uploaded and presented as a unit, independent of any release (FM-824; mirrors fm.freemix.group.stems, FM-549 s38). A sample PACK is this same record with a price — one record type, pricing optional. Points DOWN at its member samples, which carry an optional parentGroup back-ref (the only upward ref); members[] is authoritative for membership and order. RELATIONSHIP TO fm.freemix.release: a release is a separate 'put-out work' wrapper that MAY include this record as one of its members; this record is the structural group itself, not the release. Selling sample packs is NOT implemented — priceCents/currency reserve the shape only.

Record Key tid Timestamp-based ID

Properties

coverArtUrl string uri Optional

URL to cover art image.

maxLength: 3000 bytes
createdAt string datetime Required

Record creation timestamp.

maxLength: 100 bytes
currency string Optional

ISO-4217 currency code. Phase 1 = USD only. INLINE sellability shape — keep in sync across sellable types.

maxLength: 3 bytes
Known values: USD
description string Optional

Samples-group description.

maxLength: 5000 bytes
members array of object Optional

Ordered member samples (container points DOWN at members). AT-URI refs to fm.freemix.sample records. Samples also carry an optional parentGroup back-ref (the only upward ref).

maxLength: 200 items
priceCents integer Optional

On-network price in integer cents (FM-549: price on-network; offer public, sale private). 0 or absent = free; a priced group is a sample pack. The bundle price: one price covers the whole samples group (no per-sample pricing). Hard price floor enforced in app. INLINE sellability shape — authored identically in fm.freemix.release and fm.freemix.group.stems; keep in sync (s41). RESERVED: selling sample packs is not implemented.

minimum: 0
seller string did Required

parties.seller (s39): the single account DID that owns and sells this samples group. Charge/entitlement read THIS field. INLINE — keep in sync.

title string Required

The samples-group name, and the sold-product name buyers see when it is priced (e.g. 'Midnight Drive — Drum Hits').

maxLength: 300 bytes
View raw schema
{
  "description": "A samples group: a structural grouping of samples uploaded and presented as a unit, independent of any release (FM-824; mirrors fm.freemix.group.stems, FM-549 s38). A sample PACK is this same record with a price — one record type, pricing optional. Points DOWN at its member samples, which carry an optional parentGroup back-ref (the only upward ref); members[] is authoritative for membership and order. RELATIONSHIP TO fm.freemix.release: a release is a separate 'put-out work' wrapper that MAY include this record as one of its members; this record is the structural group itself, not the release. Selling sample packs is NOT implemented — priceCents/currency reserve the shape only.",
  "key": "tid",
  "record": {
    "properties": {
      "coverArtUrl": {
        "description": "URL to cover art image.",
        "format": "uri",
        "maxLength": 3000,
        "type": "string"
      },
      "createdAt": {
        "description": "Record creation timestamp.",
        "format": "datetime",
        "maxLength": 100,
        "type": "string"
      },
      "currency": {
        "description": "ISO-4217 currency code. Phase 1 = USD only. INLINE sellability shape — keep in sync across sellable types.",
        "knownValues": [
          "USD"
        ],
        "maxLength": 3,
        "type": "string"
      },
      "description": {
        "description": "Samples-group description.",
        "maxLength": 5000,
        "type": "string"
      },
      "members": {
        "description": "Ordered member samples (container points DOWN at members). AT-URI refs to fm.freemix.sample records. Samples also carry an optional parentGroup back-ref (the only upward ref).",
        "items": {
          "properties": {
            "cid": {
              "description": "CID of the member sample (pins to exact version). Optional.",
              "format": "cid",
              "maxLength": 200,
              "type": "string"
            },
            "position": {
              "description": "Display order within the group (0-indexed).",
              "minimum": 0,
              "type": "integer"
            },
            "uri": {
              "description": "AT URI of the member sample record.",
              "format": "at-uri",
              "maxLength": 3000,
              "type": "string"
            }
          },
          "required": [
            "uri"
          ],
          "type": "object"
        },
        "maxLength": 200,
        "type": "array"
      },
      "priceCents": {
        "description": "On-network price in integer cents (FM-549: price on-network; offer public, sale private). 0 or absent = free; a priced group is a sample pack. The bundle price: one price covers the whole samples group (no per-sample pricing). Hard price floor enforced in app. INLINE sellability shape — authored identically in fm.freemix.release and fm.freemix.group.stems; keep in sync (s41). RESERVED: selling sample packs is not implemented.",
        "minimum": 0,
        "type": "integer"
      },
      "seller": {
        "description": "parties.seller (s39): the single account DID that owns and sells this samples group. Charge/entitlement read THIS field. INLINE — keep in sync.",
        "format": "did",
        "type": "string"
      },
      "title": {
        "description": "The samples-group name, and the sold-product name buyers see when it is priced (e.g. 'Midnight Drive — Drum Hits').",
        "maxLength": 300,
        "type": "string"
      }
    },
    "required": [
      "title",
      "seller",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}

Lexicon Garden

@