lyrics

Documentation

Index

• func Read(file string, opts ...Option) (output string, err error)
• type Json
  • func (t *Json) EndOfTrack(p reader.Position)
  • func (t *Json) Instrument(p reader.Position, name string)
  • func (t *Json) Lyric(p reader.Position, text string)
  • func (t *Json) Program(p reader.Position, name string)
  • func (t *Json) Text(p reader.Position, text string)
  • func (t *Json) Track(p reader.Position, name string)
• type Option
  • func OptionIncludeText() Option
  • func OptionJSONOutput() Option
  • func OptionTrackNo(no uint16) Option
• type Track

Functions

func Read

func Read(file string, opts ...Option) (output string, err error)

Types

type Json

type Json struct {
	File string `json:"file"`

	Tracks []*Track `json:"tracks,omitempty"`
	// contains filtered or unexported fields
}

func (*Json) EndOfTrack

func (t *Json) EndOfTrack(p reader.Position)

func (*Json) Instrument

func (t *Json) Instrument(p reader.Position, name string)

func (*Json) Lyric

func (t *Json) Lyric(p reader.Position, text string)

func (*Json) Program

func (t *Json) Program(p reader.Position, name string)

func (*Json) Text

func (t *Json) Text(p reader.Position, text string)

func (*Json) Track

func (t *Json) Track(p reader.Position, name string)

type Option

type Option func(*config)

func OptionIncludeText

func OptionIncludeText() Option

func OptionJSONOutput

func OptionJSONOutput() Option

func OptionTrackNo

func OptionTrackNo(no uint16) Option

type Track

type Track struct {
	Program    string   `json:"program,omitempty"`
	Name       string   `json:"name,omitempty"`
	Instrument string   `json:"instrument,omitempty"`
	Texts      []string `json:"texts,omitempty"`
	Lyrics     []string `json:"lyrics,omitempty"`
	No         int      `json:"no"`
}