Singer Description Schema

Type: object
No Additional Properties

root $version
Type: const

Format version

Specific value: "1.0"

root avatar
Type: object

Path to the singer avatar image

root avatar oneOf item 0
Type: string

Default display text
root avatar oneOf item 1
Type: object

root avatar oneOf item 1 _
Type: string

Default display text

Each additional property must conform to the following schema

root avatar oneOf item 1 additionalProperties
Type: string

Localized display text for a specific locale

root background
Type: object

Path to the singer background image

root background oneOf item 0
Type: string

Default display text
root background oneOf item 1
Type: object

root background oneOf item 1 _
Type: string

Default display text

Each additional property must conform to the following schema

root background oneOf item 1 additionalProperties
Type: string

Localized display text for a specific locale

root class
Type: string

Singer class name

root configuration
Type: object

Singer-specific configuration. The schema for this field is defined by the singer class.

root demoAudio

root demoAudio oneOf multilingualText
Type: object

Path to a single demo audio file. Equivalent to an array with one object containing the name field of an empty string and the path field of the specified value.

root demoAudio oneOf item 0 oneOf item 0
Type: string

Default display text
root demoAudio oneOf item 0 oneOf item 1
Type: object

root demoAudio oneOf item 0 oneOf item 1 _
Type: string

Default display text

Each additional property must conform to the following schema

root demoAudio oneOf item 0 oneOf item 1 additionalProperties
Type: string

Localized display text for a specific locale
root demoAudio oneOf item 1
Type: array of object
No Additional Items

Each item of this array must be:

root demoAudio oneOf item 1 item 1 items
Type: object

Multiple demo audio files

 No Additional Properties

root demoAudio oneOf item 1 item 1 items name
Type: object

Demo audio name

root demoAudio oneOf item 1 item 1 items name oneOf item 0
Type: string

Default display text
root demoAudio oneOf item 1 item 1 items name oneOf item 1
Type: object

root demoAudio oneOf item 1 item 1 items name oneOf item 1 _
Type: string

Default display text

Each additional property must conform to the following schema

root demoAudio oneOf item 1 item 1 items name oneOf item 1 additionalProperties
Type: string

Localized display text for a specific locale

root demoAudio oneOf item 1 item 1 items path
Type: object

Path to the demo audio file. The path is relative to the singer description file.

root demoAudio oneOf item 1 item 1 items path oneOf item 0
Type: string

Default display text
root demoAudio oneOf item 1 item 1 items path oneOf item 1
Type: object

root demoAudio oneOf item 1 item 1 items path oneOf item 1 _
Type: string

Default display text

Each additional property must conform to the following schema

root demoAudio oneOf item 1 item 1 items path oneOf item 1 additionalProperties
Type: string

Localized display text for a specific locale

root id
Type: string

Singer identifier. Must be unique within the package.

 Must match regular expression: ^[A-Za-z0-9_-]+$

root imports
Type: array
No Additional Items

Each item of this array must be:

root imports imports items

root imports imports items oneOf genericIdentifier
Type: string

Identifier of an inference from the same package. Equivalent to an object with only the id field specified and default values for other fields.

 Must match regular expression: ^[A-Za-z0-9_-]+$
root imports imports items oneOf item 1
Type: object
No Additional Properties

root imports imports items oneOf item 1 id
Type: string

Identifier of the package to import the inference from. Default to current package ID.

 Must match regular expression: ^[A-Za-z0-9_-]+(?:/[A-Za-z0-9_-]+)*$

root imports imports items oneOf item 1 inferenceId
Type: string

Identifier of the inference within the imported package

 Must match regular expression: ^[A-Za-z0-9_-]+$

root imports imports items oneOf item 1 options
Type: object

Options of the imported inference. The schema for this field is defined by the inference class.

root imports imports items oneOf item 1 version
Type: string

Version of the package to import the inference from. If package is not specified, default to current package version, otherwise default to the latest version of the package required by the dependency field in the package description.

 Must match regular expression: ^(0|[1-9][0-9]*)(?:\.(0|[1-9][0-9]*)){0,3}$

root level
Type: integer

Singer API level

root name
Type: object

Singer name. Default to the singer identifier if not provided.

root name oneOf item 0
Type: string

Default display text
root name oneOf item 1
Type: object

root name oneOf item 1 _
Type: string

Default display text

Each additional property must conform to the following schema

root name oneOf item 1 additionalProperties
Type: string

Localized display text for a specific locale