@ssh/audiosalad-xml - v1.0.1
    Preparing search index...

    Class Release

    The release root element.

    Hierarchy

    • ReleaseBase
      • Release
    Index
    action: string

    Maps to action. Required.

    advisory?: "none" | "clean" | "explicit" | "None" | "Clean" | "Explicit"

    Maps to advisory.

    assets?: AssetInput[]

    Maps to asset — images, music videos, documentation.

    attr?: AttrInput[]

    Maps to attr.

    audioLanguage?: string

    Maps to audio_language. A capitalized language name.

    catalogID?: string

    Maps to catalog_id.

    cInfo?: string

    Maps to c_info.

    compilation?: boolean

    Maps to compilation. false is emitted; omit the key for absence.

    cYear?: number

    Maps to c_year.

    displayArtist: string

    Maps to display_artist. Required.

    distributorName?: string

    Maps to distributor_name, usually the vendor name.

    exportID?: string

    Maps to export_id. Informational only.

    exportTime?: DateLike

    Maps to export_time. A Date is formatted in UTC.

    genres?: GenreInput[]

    Maps to genre.

    globalReleaseDate?: DateLike

    Maps to global_release_date — a timed global release, in UTC.

    globalReleaseID?: string

    Maps to global_release_id — the AudioSalad identifier.

    label?: LabelInput

    Maps to label.

    metadataLanguage?: string

    Maps to metadata_language. A capitalized language name.

    notes?: string

    Maps to notes — shown only inside AudioSalad.

    originalReleaseDate?: DateLike

    Maps to original_release_date. Accepts YYYY, YYYY-MM, or YYYY-MM-DD.

    participants?: ParticipantInput[]

    Maps to participant.

    permissions?: PermissionInput[]

    Maps to permission.

    pInfo?: string

    Maps to p_info.

    priceTiers?: PriceTierInput[]

    Maps to price_tier.

    pYear?: number

    Maps to p_year.

    recordingLocation?: string

    Maps to recording_location — a 2-character ISO country code.

    releaseDate?: DateLike

    Maps to release_date. A Date is formatted in UTC.

    releaseFormat?: string

    Maps to release_format.

    rightsHolders?: string

    Maps to rights_holders.

    series?: string

    Maps to series.

    tags?: string[]

    Maps to tag.

    territories?: TerritoryInput[]

    Maps to territory.

    texts?: TextInput[]

    Maps to text — descriptions, reviews, liner notes.

    title: string

    Maps to title, minus any title version. Required.

    titleVersion?: string

    Maps to title_version, e.g. Remixes.

    tracks: TrackInput[]

    Maps to track. At least one required.

    upc?: string

    Maps to upc_ean. A string, to preserve leading zeros. 12–14 digits.

    url?: string

    Maps to url.

    vendorReleaseID?: string

    Maps to vendor_release_id. Informational only.

    • Generates AudioSalad XML.

      Returns string

      when the object is invalid.