Utils Enumeration Reference


                    
                    
                    noteToValue(note:)

Get index value of a note

Declaration

Swift

static func noteToValue(note: Chord.Root) -> Int

Show on GitHub


                    
                    
                    valueToNote(value:scale:)

Return note by index in a scale

Declaration

Swift

static func valueToNote(value: Int, scale: Chord.Root) -> Chord.Root

Show on GitHub


                    
                    
                    transposeNote(note:transpose:scale:)

Transpose the chord

Declaration

Swift

static func transposeNote(note: Chord.Root, transpose: Int, scale: Chord.Root = .c) -> Chord.Root

Parameters

`transpose`	Transpose key
`note`	The root note
`scale`	Key scale

Show on GitHub


                    
                    
                    fretsToComponents(root:frets:baseFret:instrument:)

Calculate the chord components

Declaration

Swift

static func fretsToComponents(
    root: Chord.Root,
    frets: [Int],
    baseFret: Int,
    instrument: Instrument
) -> [Chord.Component]

Show on GitHub


                    
                    
                    fingersToBarres(frets:fingers:)

Check if fingers should be barred

Declaration

Swift

static func fingersToBarres(
    frets: [Int],
    fingers: [Int]
) -> [Chord.Barre]

Parameters

`frets`	The frets of the chord
`fingers`	The fingers of the chord

Return Value

An array with fingers that should be barred

Show on GitHub


                    
                    
                    getChordComponents(chord:addBase:)

Get all possible chord notes for a ChordDefinition

Declaration

Swift

static func getChordComponents(chord: ChordDefinition, addBase: Bool = true) -> [[Chord.Root]]

Parameters

`chord`	The `ChordDefinition`
`addBase`	Bool to add the optional bass to the notes

Return Value

An array with Root arrays

Show on GitHub


                    
                    
                    define(from:instrument:)

Create a ChordDefinition struct from a string which defines a Chord with a ChordPro define directive

For more information about the layout, have a look at https://www.chordpro.org/chordpro/directives-define/

Declaration

Swift

static func define(from define: String, instrument: Instrument) throws -> ChordDefinition

Parameters

`define`	ChordPro string definition of the chord
`instrument`	The `Instrument` to use

Return Value

A ChordDefinition struct, if found, else an Error

Show on GitHub


                    
                    
                    define(from:instrument:)

Create a ChordDefinition structure from a ChordPro JSON chord

For more information about the layout, have a look at https://www.chordpro.org/chordpro/directives-define/

Declaration

Swift

static func define(from chord: ChordPro.Instrument.Chord, instrument: Instrument) throws -> ChordDefinition

Parameters

`chord`	A ChordPro JSON chord
`instrument`	The `Instrument` to use

Return Value

A ChordDefinition struct, if found, else an Error

Show on GitHub