Difference between revisions of "Development/Release Editor Seeding"

From MusicBrainz Wiki
m
Line 1: Line 1:
This page documents a lit of parameters you can post the release editor to "seed" it.
+
This page documents a lit of parameters you can post the release editor to "seed" it. All values are optional unless otherwise stated.
 
 
  
 
== Release data ==
 
== Release data ==
 
The following parameters specify data about releases
 
  
 
; name
 
; name
: The name of the release. Must be a non-empty string.
+
: The name of the release. Non-empty string. Required
 
; comment
 
; comment
: A disambiguation comment for the release. Optional, non empty string
+
: A disambiguation comment for the release. Non-empty string
 
; annotation
 
; annotation
: Optional text to place in the releases annotation
+
: Text to place in the releases annotation
 
; barcode
 
; barcode
: The barcode of the release. Optional, valid barcode without whitespace
+
: The barcode of the release. May be any valid barcode without whitespace
 
; date.year
 
; date.year
 
; date.month
 
; date.month
 
; date.day
 
; date.day
: The date of the release. Each field is an optional integer
+
: The date of the release. Each field is an integer
 
; country
 
; country
: The country the release was released in. Optional, may be any valid country ISO code (for example, GB, US, FR)
+
: The country the release was released in. May be any valid country ISO code (for example, GB, US, FR)
 
; language
 
; language
: The language of the release. Optional, may be any valid ISO 639-2T code
+
: The language of the release. May be any valid ISO 639-2/T code (for example, eng, deu, jpn)
 
; script
 
; script
: The script of the text on the release. Optional, may be any valid ISO 15924 code (for example, Latn, Brai);
+
: The script of the text on the release. May be any valid ISO 15924 code (for example, Latn, Cyrl)
 
; status
 
; status
: The status of the release, as defined by MusicBrainz. Optional, may be any of: official, promotion, bootleg, pseudo
+
: The status of the release, as defined by MusicBrainz. Possible values: official, promotion, bootleg, pseudo
 
; type
 
; type
: The type of the release group, if a release group will be created. Optional, may be any of: album, single, ep, compilation, soundtrack, spokenword, interview, audiobook, live, remix, other
+
: The type of the release group, if a release group will be created. Possible values: album, single, ep, compilation, soundtrack, spokenword, interview, audiobook, live, remix, other
 
; packaging
 
; packaging
: The type of packaging of the release. Optional, may be any of: jewel-case, slim-jewel-case, digipak, paper-sleeve, other
+
: The type of packaging of the release. Possible values: jewel-case, slim-jewel-case, digipak, paper-sleeve, other
  
 
=== Labels and catalog numbers ===
 
=== Labels and catalog numbers ===
  
Releases may be associated with multiple labels and catalog numbers, so the fields for specifying these is a little different. You must specify a positive integer for the ''n'' part of the field name to specify which label/catalog number pair you are referring to. For example: label.0.mbid and label.0.catalogue_number
+
Releases may be associated with multiple labels and catalog numbers, so the fields for specifying these is a little different. You must specify a positive integer for the ''n'' part of the field name to specify which label/catalog number pair you are referring to. For example: label.0.mbid and label.0.catalog_number
  
 
; label.''n''.mbid
 
; label.''n''.mbid
Line 46: Line 43:
  
 
; medium.''n''.format
 
; medium.''n''.format
: Any valid medium format name: may be anyone of '''auto generate me'''
+
: Any valid medium format name: may be any one of '''auto generate me'''
 
; medium.''n''.position
 
; medium.''n''.position
: The position of this medium in the list of mediums. If ommited, it will be inferred from the order of all mediums passed in (which is normally what you want).
+
: The position of this medium in the list of mediums. If omitted, it will be inferred from the order of all mediums passed in (which is normally what you want).
 
; medium.''n''.name
 
; medium.''n''.name
 
: The name of medium ''n'' (for example "Live & Unreleased")
 
: The name of medium ''n'' (for example "Live & Unreleased")

Revision as of 18:25, 10 December 2010

This page documents a lit of parameters you can post the release editor to "seed" it. All values are optional unless otherwise stated.

Release data

name
The name of the release. Non-empty string. Required
comment
A disambiguation comment for the release. Non-empty string
annotation
Text to place in the releases annotation
barcode
The barcode of the release. May be any valid barcode without whitespace
date.year
date.month
date.day
The date of the release. Each field is an integer
country
The country the release was released in. May be any valid country ISO code (for example, GB, US, FR)
language
The language of the release. May be any valid ISO 639-2/T code (for example, eng, deu, jpn)
script
The script of the text on the release. May be any valid ISO 15924 code (for example, Latn, Cyrl)
status
The status of the release, as defined by MusicBrainz. Possible values: official, promotion, bootleg, pseudo
type
The type of the release group, if a release group will be created. Possible values: album, single, ep, compilation, soundtrack, spokenword, interview, audiobook, live, remix, other
packaging
The type of packaging of the release. Possible values: jewel-case, slim-jewel-case, digipak, paper-sleeve, other

Labels and catalog numbers

Releases may be associated with multiple labels and catalog numbers, so the fields for specifying these is a little different. You must specify a positive integer for the n part of the field name to specify which label/catalog number pair you are referring to. For example: label.0.mbid and label.0.catalog_number

label.n.mbid
The MBID of the label.
label.n.catalog_number
The catalog number of this release, for label n.


Tracklists and Mediums

As with labels above, their may be multiple mediums and tracklists may contain multiple tracks, so again you will need to fill in the n and m parameters accordingly.

medium.n.format
Any valid medium format name: may be any one of auto generate me
medium.n.position
The position of this medium in the list of mediums. If omitted, it will be inferred from the order of all mediums passed in (which is normally what you want).
medium.n.name
The name of medium n (for example "Live & Unreleased")
medium.n.track.m.name
The name of track n on medium m
medium.n.track.m.duration
The duration of track n on medium m in MM:SS form. You may also pass a single integer, which will be interpreted as seconds (milliseconds?)