Chord Provider (99% documented)

GitHub View on GitHub

Chord Provider Song structure Song Structure Reference

Song

struct Song: Equatable, Codable

The structure of a song as shown in Chord Provider

Show on GitHub

id
The ID of the song
Declaration
Swift

var id: UUID
Show on GitHub
lines
The total lines of the song
Declaration
Swift

var lines: Int = 0
Show on GitHub

Display options

settings
The settings for the Song in the Document
Declaration
Swift

var settings = AppSettings.Song()
Show on GitHub

Metadata directives

metadata
The metadata about the Song
Declaration
Swift

var metadata = Metadata()
Show on GitHub

Meta data directives that are defined

definedMetaData
An array of defined directives that only should be set once

Note
Used in the directive menus to disable once only directives
Declaration
Swift

var definedMetaData: [ChordPro.Directive] = []
Show on GitHub

All the sections in the song

sections
The sections of the song
Declaration
Swift

var sections = [Song.Section]()
Show on GitHub

All the chords in the song

chords
The chords of the song
Declaration
Swift

var chords: [ChordDefinition] = []
Show on GitHub

The structure for metadata about the song

Metadata
Structure for metadata about the song
See more
Declaration
Swift

struct Metadata: Equatable, Codable
Show on GitHub

The structure for a section in the `Song`

Section
A section in the Song
See more
Declaration
Swift

struct Section: Identifiable, Equatable, Codable
Show on GitHub