content

Documentation

Index

• Constants
• type Content
  • func New(cfg *config.Cfg) (cnt *Content, err error)
  • func (me *Content) AlbumsSpreadAcrossMultipleDirs(w io.Writer)
  • func (me *Content) AlbumsWithInconsistentTrackNumbers(w io.Writer)
  • func (me *Content) AlbumsWithMultipleCovers(w io.Writer)
  • func (me *Content) Browse(id ObjID, mode string, start, wanted uint32) (result string, returned, total uint32, err error)
  • func (me *Content) ContainerUpdateIDs() (updates string)
  • func (me *Content) Errors() <-chan error
  • func (me *Content) InconsistentAlbums(w io.Writer)
  • func (me *Content) InitialUpdate(ctx context.Context) (err error)
  • func (me *Content) Picture(id uint64) *[]byte
  • func (me *Content) ResetCtrUpdCounts()
  • func (me *Content) Run(ctx context.Context, wg *sync.WaitGroup)
  • func (me *Content) Trackpath(id uint64) (string, error)
  • func (me *Content) TracksWithoutAlbum(w io.Writer)
  • func (me *Content) TracksWithoutCover(w io.Writer)
  • func (me *Content) UpdateNotification() <-chan UpdateNotification
  • func (me *Content) WriteStatus(w io.Writer)
• type ObjID
  • func ObjIDFromString(s string) (ObjID, error)
• type UpdateNotification

Constants

const (
	ModeMetadata = "BrowseMetadata"
	ModeChildren = "BrowseDirectChildren"
)

values of the BrowseFlag attribute of the ContentDirectory service

const (
	MusicFolder   = "/music/"
	PictureFolder = "/pictures/"
)

root folder for music and picture requests note: they must end with a slash!

Types

type Content

type Content struct {
	// contains filtered or unexported fields
}

Content contains the different muserv content objects, such as tracks, albums, hierarchies and methods to management them

func New

func New(cfg *config.Cfg) (cnt *Content, err error)

New creats a new Content instance

func (*Content) AlbumsSpreadAcrossMultipleDirs

func (me *Content) AlbumsSpreadAcrossMultipleDirs(w io.Writer)

AlbumsSpreadAcrossMultipleDirs determines albums whose tracks are spread across more than one directory. The result is printed to w

func (*Content) AlbumsWithInconsistentTrackNumbers

func (me *Content) AlbumsWithInconsistentTrackNumbers(w io.Writer)

AlbumsWithInconsistentTrackNumbers determines albums that have either overlapping track numbers or that have gaps in the track numbering. The result is printed to w

func (*Content) AlbumsWithMultipleCovers

func (me *Content) AlbumsWithMultipleCovers(w io.Writer)

AlbumsWithMultipleCovers determines albums that contain tracks that have not the same cover picture. The result is printed to w

func (*Content) Browse

func (me *Content) Browse(id ObjID, mode string, start, wanted uint32) (result string, returned, total uint32, err error)

Browse implements the Browse SOAP action of the ContentDirectory service

func (*Content) ContainerUpdateIDs

func (me *Content) ContainerUpdateIDs() (updates string)

ContainerUpdateIDs assembles the new value for the state variable ContainerUpdateIDs

func (*Content) Errors

func (me *Content) Errors() <-chan error

Errors returns a receive-only channel for errors that occur during the regular update

func (*Content) InconsistentAlbums

func (me *Content) InconsistentAlbums(w io.Writer)

InconsistentAlbums checks if albums with the same title from the same album artists have the same year and compilation flag assigned. If that's not the case, that's an indicator for an inconsistency and the album data is printed to w

func (*Content) InitialUpdate

func (me *Content) InitialUpdate(ctx context.Context) (err error)

InitialUpdate executes a one-time content update after muserv has been started

func (*Content) Picture

func (me *Content) Picture(id uint64) *[]byte

Picture returns the picture with the given ID. If it doesn't exist, nil is returned

func (*Content) ResetCtrUpdCounts

func (me *Content) ResetCtrUpdCounts()

ResetCtrUpdCounts resets the ContainerUpdateIDValues for all container objects

func (*Content) Run

func (me *Content) Run(ctx context.Context, wg *sync.WaitGroup)

Run starts the regular content updates

func (*Content) Trackpath

func (me *Content) Trackpath(id uint64) (string, error)

Trackpath return the path of the music track with the object id id. An error is returned if the track cannot be found

func (*Content) TracksWithoutAlbum

func (me *Content) TracksWithoutAlbum(w io.Writer)

TracksWithoutAlbum determines tracks that do not have a album tag assigned. The result is printed to w

func (*Content) TracksWithoutCover

func (me *Content) TracksWithoutCover(w io.Writer)

TracksWithoutCover determines tracks that do not have a cover picture assigned. The result is printed to w

func (*Content) UpdateNotification

func (me *Content) UpdateNotification() <-chan UpdateNotification

UpdateNotification returns a receive-only channel to notify about updates

func (*Content) WriteStatus

func (me *Content) WriteStatus(w io.Writer)

WriteStatus writes the content status to w

type ObjID

type ObjID int64

ObjID is the unique identified of an object

func ObjIDFromString

func ObjIDFromString(s string) (ObjID, error)

ObjIDFromString create an object ID from a string

type UpdateNotification

type UpdateNotification struct {
	// Update triggers update
	Update func()
	// Updated provides the info update was done and how many objects were
	// changed, deleted or added
	Updated chan uint32
}

UpdateNotification is used to inform the caller about updates. It contains a function to execute the update and a channel to inform the caller that the update was done