audiofile

package module

v0.1.1 Latest Latest Go to latest Published: Jan 9, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cloudcloud/audiofile

Links

Open Source Insights

README ¶

audiofile

background

Do you have a music collection that you would like to browse and organise with a nice UI? Audiofile attempts to provide such an interface, allowing for directory locations to be specified and then trawled for audio files with their ID3 information retrieved. To provide further benefit, Audiofile attempts to then help with organising your local filesystem layout, along with ensuring the quality and validaty of all metadata.

installation

See the releases for available pre-built binaries of Audiofile.

development

See the Makefile for details of running components of Audiofile.

credit

A portion of this concept was derived from the SickBeard product.

Documentation ¶

Overview ¶

Package audiofile provides data structures and behaviours for audiofile.

Index ¶

type Album
type Artist
type Directory
- func (d Directory) GenerateID() (Directory, error)
- func (d Directory) MaybeFirstTime() (Directory, error)
type File
type Song

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Album ¶

type Album struct {
	Artists []Artist
	Songs   []Song
}

Album gives structure around a single album.

type Artist ¶

type Artist struct {
	Name string `json:"name"`
	//Albums []Album `json:"albums"`
	Status string `json:"status"`
	ID     string `json:"id"`
}

Artist is a house for all data related to a specific Artist.

type Directory ¶

type Directory struct {
	DateAdded   time.Time `json:"date_added" db:"date_added"`
	DateUpdated time.Time `json:"date_updated" db:"date_updated"`
	Directory   string    `json:"directory"`
	ID          string    `json:"id"`
}

Directory defines a location from which files will be discovered.

func (Directory) GenerateID ¶

func (d Directory) GenerateID() (Directory, error)

GenerateID will provide a generated UUIDv4 value to the ID attribute if the attribute does not already have a value.

func (Directory) MaybeFirstTime ¶

func (d Directory) MaybeFirstTime() (Directory, error)

MaybeFirstTime will determine if this directory is being manipulated for the first time, and if so, set additional fields.

type File ¶

type File struct {
	Filename string

	Artists []Artist
	Album   Album
	Song    Song
}

File provides structure to encompass all entity attributes related to a specific file from the file system.

type Song ¶

type Song struct {
}

Song structures data for an individual song.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
audiofile Package main provides the binary for audiofile orchestrating and running the server.	Package main provides the binary for audiofile orchestrating and running the server.
data Package data provides abstraction for interacting with the data store of choice.	Package data provides abstraction for interacting with the data store of choice.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL