ChordDefinition Structure Reference

Database items

id
The ID of the chord
Declaration
Swift

var id: UUID
Show on GitHub
frets
The fret positions of the chord
Declaration
Swift

var frets: [Int]
Show on GitHub
fingers
The finger positions of the chord
Declaration
Swift

var fingers: [Int]
Show on GitHub
baseFret
The base fret of the chord
Declaration
Swift

var baseFret: Int
Show on GitHub
root
The root of the chord
Declaration
Swift

var root: Chord.Root
Show on GitHub
quality
The quality of the chord
Declaration
Swift

var quality: Chord.Quality
Show on GitHub

Other items

name
The name of the chord
Declaration
Swift

var name: String
Show on GitHub
barres
The fingers you have to bar for the chord

Note
A calculated value by the init
Declaration
Swift

var barres: [Chord.Barre]
Show on GitHub
instrument
The instrument of the chord
Declaration
Swift

var instrument: Instrument
Show on GitHub
bass
The base note of an optional ‘slash’ chord
Declaration
Swift

var bass: Chord.Root?
Show on GitHub
components
The components of the chord definition
Declaration
Swift

var components: [Chord.Component] = []
Show on GitHub
status
The status of the chord
Declaration
Swift

var status: Chord.Status
Show on GitHub

Coding keys

CodingKeys
The coding keys

Note
Only those items will be in the database
See more
Declaration
Swift

enum CodingKeys: CodingKey
Show on GitHub
encode(to:)
Custom encoder for the ChordDefinition
Declaration
Swift

func encode(to encoder: Encoder) throws
Show on GitHub
getName
Get the name of the chord for internal use
Declaration
Swift

var getName: String
Return Value

A string with the name of the chord

Show on GitHub
display
Format the name of the chord for display
Declaration
Swift

var display: String
Return Value

A formatted string with the name of the chord

Show on GitHub
displayFlatForSharp
Format the name of the chord with a flat version for display
Declaration
Swift

var displayFlatForSharp: String
Return Value

A formatted string with the flat name of the chord

Show on GitHub
validate
Try to validate a ChordDefinition
Declaration
Swift

var validate: Chord.Status
Show on GitHub
define
Convert a ChordDefinition into a ChordPro {define}
Declaration
Swift

var define: String
Show on GitHub


                    
                    
                    play(instrument:)

Play a ChordDefinition with MIDI

Declaration

Swift

func play(instrument: Midi.Instrument = .acousticNylonGuitar)

Parameters


                                instrument

The instrument to use

Show on GitHub


                    
                    
                    mirrorBarre(_:)

Mirror a Barre for a left-handed chord

Declaration

Swift

func mirrorBarre(_ barre: Chord.Barre) -> Chord.Barre

Parameters


                                barre

The original barre

Return Value

The left-handed barre

Show on GitHub

Init from the decoder

init(from:)
Init the ChordDefinition from the decoder
Declaration
Swift

init(from decoder: Decoder) throws
Show on GitHub

Init with all known values


                    
                    
                    init(id:name:frets:fingers:baseFret:root:quality:bass:instrument:status:)

Init the ChordDefinition with all known values

Declaration

Swift

init(
    id: UUID,
    name: String,
    frets: [Int],
    fingers: [Int],
    baseFret: Int,
    root: Chord.Root,
    quality: Chord.Quality,
    bass: Chord.Root?,
    instrument: Instrument,
    status: Chord.Status = .customChord
)

Show on GitHub

Init with a definition


                    
                    
                    init(definition:instrument:status:)

Init the ChordDefinition with a ChordPro definition

If the status is ‘unknown’, this function will try to find the chord in the database

Declaration

Swift

init(definition: String, instrument: Instrument, status: Chord.Status) throws

Parameters

`definition`	The ChordPro definition
`instrument`	The `Instrument`
`status`	The `Status`

Show on GitHub

Init with a name


                    
                    
                    init(name:instrument:)

Init the ChordDefinition with the name of a chord

Declaration

Swift

init?(name: String, instrument: Instrument)

Parameters

`name`	The name of the chord, e.g ‘Am7’
`instrument`	The `Instrument`

Show on GitHub

Init with a ChordPro JSON chord


                    
                    
                    init(chord:instrument:)

Init the ChordDefinition with the name of a chord

Declaration

Swift

init?(chord: ChordPro.Instrument.Chord, instrument: Instrument)

Parameters

`chord`	The ChordPro JSON chord
`instrument`	The `Instrument`

Show on GitHub

Init with an unknown name


                    
                    
                    init(unknown:instrument:)

Init the ChordDefinition with an unknown chord

Declaration

Swift

init(unknown: String, instrument: Instrument)

Parameters

`unknown`	The name of the unknown chord
`instrument`	The `Instrument`

Show on GitHub


                    
                    
                    transpose(transpose:scale:)

Transpose a ChordDefinition

Declaration

Swift

mutating func transpose(transpose: Int, scale: Chord.Root)

Parameters

`transpose`	The transpose value
`scale`	The scale of the chord

Show on GitHub