ChordDefinition

public struct ChordDefinition : Equatable, Codable, Identifiable, Hashable, Sendable

The structure of a chord definition

Database items

id
The ID of the chord
Declaration
Swift

public var id: UUID
frets
The fret positions of the chord
Declaration
Swift

public var frets: [Int]
fingers
The finger positions of the chord
Declaration
Swift

public var fingers: [Int]
baseFret
The base fret of the chord
Declaration
Swift

public var baseFret: Int
root
The root of the chord
Declaration
Swift

public var root: Chord.Root
quality
The quality of the chord
Declaration
Swift

public var quality: Chord.Quality

Other items

name
The name of the chord
Declaration
Swift

public var name: String
barres
The fingers you have to bar for the chord

Note
A calculated value by the init
Declaration
Swift

public var barres: [Chord.Barre]
instrument
The instrument of the chord
Declaration
Swift

public var instrument: Instrument
appended
The appended notes on the chord
Declaration
Swift

var appended: [String]
bass
The base note of an optional ‘slash’ chord
Declaration
Swift

public var bass: Chord.Root?
components
The components of the chord definition
Declaration
Swift

public var components: [Chord.Component]
status
The status of the chord
Declaration
Swift

public var status: Chord.Status

Coding keys

CodingKeys
The coding keys

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

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

public func encode(to encoder: Encoder) throws
DisplayOptions
The structure for display options passed to the ChordDefinitionView
See more
Declaration
Swift

public struct DisplayOptions : Codable, Equatable, Sendable


                    
                    
                    displayName(options:)

Format the name of the chord for display

Declaration

Swift

func displayName(options: DisplayOptions) -> String

Parameters


                                options

The DisplayOptions

Return Value

A formatted string with the name of the chord

validate
Try to validate a ChordDefinition
Declaration
Swift

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

var define: String { get }


                    
                    
                    play(instrument:)

Play a ChordDefinition with MIDI

Declaration

Swift

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

Parameters


                                instrument

The instrument to use


                    
                    
                    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

Init from the decoder

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

init(from decoder: Decoder) throws


                    
                    
                    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
)

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`

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`

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`


                    
                    
                    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