Chords
enum Chords
Utilities to get ChordDefinition arrays
-
Get all the guitar chords in a
ChordDefinitionarrayDeclaration
Swift
static let guitar = Chords.importInstrument(.guitar) -
Get all the guitalele chords in a
ChordDefinitionarrayDeclaration
Swift
static let guitalele = Chords.importInstrument(.guitalele) -
Get all the ukulele chords in a
ChordDefinitionarrayDeclaration
Swift
static let ukulele = Chords.importInstrument(.ukulele) -
Get all chord definitions for an instrument
Declaration
Swift
static func getAllChordsForInstrument(instrument: Instrument) -> [ChordDefinition]Parameters
instrumentThe
InstrumentReturn Value
An
ChordDefinitionarray -
Import a definition database from a JSON database file
Declaration
Swift
private static func importInstrument( _ instrument: Instrument) -> [ChordDefinition] -
Import a database with chord definitions
Declaration
Swift
static func importDatabase(database: ChordPro.Instrument, instrument: Instrument) -> [ChordDefinition]Parameters
databaseThe
Instrumentto importinstrumentThe
Instrumentto useReturn Value
An array of
ChordDefinition -
Export the definitions to a JSON string
Declaration
Swift
static func exportToJSON(definitions: [ChordDefinition], uniqueNames: Bool) throws -> StringParameters
definitionsThe chord definitions
uniqueNamesBool if the chord name should be unique, so one chord for each name
Return Value
A JSON string with chord definitions in ChordPro format
View on GitHub