User Documentation
Concepts and Configuration
Deeper Insight for Hackers
MusicDBWebSocketInterface
API Classes
AccessPermissions
AccessPermissions.EvaluateArtworkDirectory()
AccessPermissions.EvaluateStateDirectory()
AccessPermissions.EvaluateTasksDirectory()
AccessPermissions.EvaluateUploadsDirectory()
AccessPermissions.IsReadable()
AccessPermissions.IsWritable()
MusicDBArtwork
MusicDBArtwork.CreateArtworkName()
MusicDBArtwork.GetArtworkFromFile()
MusicDBArtwork.SetArtwork()
MusicDBArtwork.UpdateAlbumArtwork()
MusicDBArtwork.UpdateFileAttributes()
ArtworkCache
ArtworkCache.GetArtwork()
ArtworkCache.RebuildArtwork()
AudioStreamingThread()
StartAudioStreamingThread()
StopAudioStreamingThread()
AudioStreamManager
AudioStreamManager.GetStreamState()
AudioStreamManager.Play()
AudioStreamManager.PlayNextSong()
AudioStreamManager.PushCommand()
AudioStreamManager.RegisterCallback()
AudioStreamManager.RemoveCallback()
BlacklistInterface
BlacklistInterface.AddSong()
BlacklistInterface.AddVideo()
BlacklistInterface.CheckAllListsForSong()
BlacklistInterface.CheckAllListsForVideo()
BlacklistInterface.CheckSongList()
BlacklistInterface.GetIDsFromBlacklist()
BlacklistInterface.GetValidIDsFromBlacklists()
BlacklistInterface.ValidateBlacklist()
MusicDBExtern
MusicDBExtern.CheckForDependencies()
MusicDBExtern.CopyNewSongs()
MusicDBExtern.CopySong()
MusicDBExtern.FixPath()
MusicDBExtern.InitializeStorage()
MusicDBExtern.IsStorageInitialized()
MusicDBExtern.ReadSongmap()
MusicDBExtern.ReducePathLength()
MusicDBExtern.RemoveOldSongs()
MusicDBExtern.SetMountpoint()
MusicDBExtern.UpdateSongmap()
MusicDBExtern.UpdateStorage()
MusicDBExtern.WriteSongmap()
MusicDBMicroSearchEngine
MusicDBMicroSearchEngine.Find()
MusicDBMicroSearchEngine.NormalizeString()
MusicDBMicroSearchEngine.UpdateCache()
MusicDBMusic
MusicDBMusic.AddAlbum()
MusicDBMusic.AddArtist()
MusicDBMusic.AddLyricsFromFile()
MusicDBMusic.AddSong()
MusicDBMusic.AddVideo()
MusicDBMusic.ChangeAlbumArtist()
MusicDBMusic.CreateNewArtist()
MusicDBMusic.FindLostPaths()
MusicDBMusic.FindNewPaths()
MusicDBMusic.FindNewSongs()
MusicDBMusic.RemoveAlbum()
MusicDBMusic.RemoveArtist()
MusicDBMusic.RemoveSong()
MusicDBMusic.UpdateAlbum()
MusicDBMusic.UpdateArtist()
MusicDBMusic.UpdateChecksum()
MusicDBMusic.UpdateSong()
MusicDBMusic.UpdateVideo()
MusicDirectory
MusicDirectory.AnalyseAlbumDirectoryName()
MusicDirectory.AnalysePath()
MusicDirectory.AnalyseSongFileName()
MusicDirectory.AnalyseVideoFileName()
MusicDirectory.EstimateContentTypeByPath()
MusicDirectory.EvaluateAlbumDirectory()
MusicDirectory.EvaluateArtistDirectory()
MusicDirectory.EvaluateMusicFile()
MusicDirectory.FixAttributes()
MusicDirectory.RenameAlbumDirectory()
MusicDirectory.RenameArtistDirectory()
MusicDirectory.RenameSongFile()
MusicDirectory.RenameVideoFile()
MusicDirectory.TryAnalysePathFor()
Randy
Randy.GetSong()
Randy.GetSongFromAlbum()
Randy.GetVideo()
Randy.ReloadConfiguration()
Initialize()
Run()
SIGTERM_Handler()
Shutdown()
SignalHandler()
StartWebSocketServer()
UpdateCaches()
SongQueue
SongQueue.AddRandomSong()
SongQueue.AddSong()
SongQueue.CurrentSong()
SongQueue.Event_SongChanged()
SongQueue.Event_SongQueueChanged()
SongQueue.GenerateID()
SongQueue.GetQueue()
SongQueue.GetSong()
SongQueue.Load()
SongQueue.MoveSong()
SongQueue.NextSong()
SongQueue.RegisterCallback()
SongQueue.RemoveCallback()
SongQueue.RemoveSong()
SongQueue.Save()
SongQueue.TriggerEvent()
MusicDBTags
MusicDBTags.CreateGenre()
MusicDBTags.CreateMood()
MusicDBTags.CreateSubgenre()
MusicDBTags.DeleteGenre()
MusicDBTags.DeleteMood()
MusicDBTags.DeleteSubgenre()
MusicDBTags.DeriveAlbumTags()
MusicDBTags.GetAllGenres()
MusicDBTags.GetAllMoods()
MusicDBTags.GetAllSubgenres()
MusicDBTags.ModifyGenre()
MusicDBTags.ModifyMood()
MusicDBTags.ModifySubgenre()
MusicDBTags.ModifyTag()
Tracker
Tracker.Track()
TrackerDatabase
TrackerDatabase.AddMusic()
TrackerDatabase.AddRelation()
TrackerDatabase.GetRelations()
TrackerDatabase.RemoveRelation()
TrackerDatabase.RemoveSong()
TrackerDatabase.RemoveVideo()
VideoFrames
VideoFrames.ChangeThumbnail()
VideoFrames.CreateAnimation()
VideoFrames.CreateFramesDirectory()
VideoFrames.CreateFramesDirectoryName()
VideoFrames.GenerateFrames()
VideoFrames.GeneratePreviews()
VideoFrames.ScaleFrame()
VideoFrames.ScaleThumbnail()
VideoFrames.SetVideoFrames()
VideoFrames.UpdateVideoFrames()
VideoQueue
VideoQueue.AddRandomVideo()
VideoQueue.AddVideo()
VideoQueue.CurrentVideo()
VideoQueue.Event_VideoChanged()
VideoQueue.Event_VideoQueueChanged()
VideoQueue.GenerateID()
VideoQueue.GetQueue()
VideoQueue.GetVideo()
VideoQueue.Load()
VideoQueue.MoveVideo()
VideoQueue.NextVideo()
VideoQueue.RegisterCallback()
VideoQueue.RemoveCallback()
VideoQueue.RemoveVideo()
VideoQueue.Save()
VideoQueue.TriggerEvent()
StartVideoStreamingThread()
StopVideoStreamingThread()
VideoStreamingThread()
VideoStreamManager
VideoStreamManager.GetStreamState()
VideoStreamManager.Play()
VideoStreamManager.PlayNextVideo()
VideoStreamManager.PushCommand()
VideoStreamManager.RegisterCallback()
VideoStreamManager.RemoveCallback()
VideoStreamManager.VideoEnded()
Libraries
Config
CSVFile
MusicDBConfig
MusicDBConfig.GetDirectory()
MusicDBConfig.GetFile()
WebUIConfig
WebUIConfig.LoadConfig()
WebUIConfig.SaveConfig()
ExternConfig
MDBState
MDBState.GetActiveTagIDs()
MDBState.GetAllSubgenreFilterLists()
MDBState.GetGenreFilterList()
MDBState.GetSubgenreFilterList()
MDBState.GetUIMode()
MDBState.LoadBlacklists()
MDBState.LoadSongQueue()
MDBState.LoadVideoQueue()
MDBState.ReadList()
MDBState.SaveBlacklists()
MDBState.SaveSongQueue()
MDBState.SaveVideoQueue()
MDBState.SetUIMode()
MDBState.UpdateGenreFilterList()
MDBState.UpdateSubgenreFilterList()
MDBState.WriteList()
RandyConfiguration
RandyConfiguration.LoadConfig()
RandyConfiguration.Reload()
RandyConfiguration.SaveConfig()
WebSocketAPIKey
WebSocketAPIKey.CreateIfMissing()
WebSocketAPIKey.Read()
Database
Database.Compress()
Database.Decompress()
Database.Execute()
Database.ExecuteScript()
Database.GetFromDatabase()
Fileprocessing
Fileprocessing.Checksum()
Fileprocessing.ConvertToMP3()
Fileprocessing.ExistsProgram()
Fileprocessing.OptimizeM4ATags()
Fileprocessing.OptimizeMP3Tags()
Filesystem
Filesystem.AbsolutePath()
Filesystem.AssertDirectory()
Filesystem.AssertFile()
Filesystem.CheckAccessPermissions()
Filesystem.CopyFile()
Filesystem.CreateSubdirectory()
Filesystem.Execute()
Filesystem.Exists()
Filesystem.GetAccessPermissions()
Filesystem.GetDirectory()
Filesystem.GetDirectoryName()
Filesystem.GetFileExtension()
Filesystem.GetFileName()
Filesystem.GetFiles()
Filesystem.GetMode()
Filesystem.GetModificationDate()
Filesystem.GetOwner()
Filesystem.GetRoot()
Filesystem.GetSubdirectories()
Filesystem.GuessMimeType()
Filesystem.IsDirectory()
Filesystem.IsFile()
Filesystem.ListDirectory()
Filesystem.MoveDirectory()
Filesystem.MoveFile()
Filesystem.RemoveDirectory()
Filesystem.RemoveFile()
Filesystem.RemoveRoot()
Filesystem.Rename()
Filesystem.SetAccessPermissions()
Filesystem.SetAttributes()
Filesystem.SetOwner()
Filesystem.ToString()
Filesystem.TryRemoveRoot()
GStreamerInterface
GStreamerInterface.Cancel()
GStreamerInterface.CreateElement()
GStreamerInterface.Execute()
GStreamerInterface.GetState()
IcecastInterface
IcecastInterface.Connect()
IcecastInterface.Disconnect()
IcecastInterface.IsConnected()
IcecastInterface.Mute()
IcecastInterface.StreamChunk()
IcecastInterface.StreamFile()
IcecastInterface.UpdateTitle()
MusicDBLogger
MusicDBLogger.Reconfigure()
MusicDBLogger.SetFilePermissions()
MDBLogFormatter
MDBLogFormatter.format()
MetaTags
MetaTags.AnalysePlaytime()
MetaTags.CheckArtwork()
MetaTags.GetAlbumname()
MetaTags.GetAllMetadata()
MetaTags.GetArtistname()
MetaTags.GetBitrate()
MetaTags.GetCDNumber()
MetaTags.GetLyrics()
MetaTags.GetOrigin()
MetaTags.GetPlaytime()
MetaTags.GetReleaseyear()
MetaTags.GetSongname()
MetaTags.GetTracknumber()
MetaTags.GetVideoCodec()
MetaTags.GetVideoResolution()
MetaTags.Load()
MetaTags.StoreArtwork()
MP3Stream
MP3Stream.AnalyzeHeader()
MP3Stream.Frames()
MP3Transcoder
MP3Transcoder.Cancel()
MP3Transcoder.GetChunk()
MP3Transcoder.Transcode()
MP3Transcoder.onDecoderPadAdded()
MusicDatabase
MusicDatabase.AddAlbum()
MusicDatabase.AddArtist()
MusicDatabase.AddFullSong()
MusicDatabase.AddFullVideo()
MusicDatabase.AddSong()
MusicDatabase.AddVideo()
MusicDatabase.CreateTag()
MusicDatabase.DeleteTag()
MusicDatabase.DeleteTagById()
MusicDatabase.DeleteTagByName()
MusicDatabase.GenreListToGenreTree()
MusicDatabase.GetAlbumById()
MusicDatabase.GetAlbumByPath()
MusicDatabase.GetAlbums()
MusicDatabase.GetAlbumsByArtistId()
MusicDatabase.GetAllAlbumIds()
MusicDatabase.GetAllAlbums()
MusicDatabase.GetAllArtists()
MusicDatabase.GetAllSongs()
MusicDatabase.GetAllTags()
MusicDatabase.GetArtistById()
MusicDatabase.GetArtistByPath()
MusicDatabase.GetFilteredAlbumIds()
MusicDatabase.GetFilteredAlbums()
MusicDatabase.GetFilteredAlbumsByArtistId()
MusicDatabase.GetFilteredSongIds()
MusicDatabase.GetLyrics()
MusicDatabase.GetRandomSong()
MusicDatabase.GetRandomVideo()
MusicDatabase.GetSongById()
MusicDatabase.GetSongByPath()
MusicDatabase.GetSongs()
MusicDatabase.GetSongsByAlbumId()
MusicDatabase.GetSongsByArtistId()
MusicDatabase.GetSubgenresOfGenre()
MusicDatabase.GetTagById()
MusicDatabase.GetTagByName()
MusicDatabase.GetTagStatistics()
MusicDatabase.GetTargetTags()
MusicDatabase.GetVideoById()
MusicDatabase.GetVideoByPath()
MusicDatabase.GetVideos()
MusicDatabase.GetVideosByArtistId()
MusicDatabase.ModifyTag()
MusicDatabase.ModifyTagById()
MusicDatabase.RemoveAlbum()
MusicDatabase.RemoveArtist()
MusicDatabase.RemoveSong()
MusicDatabase.RemoveTargetTag()
MusicDatabase.SetAlbumAddedTime()
MusicDatabase.SetAlbumHiddenState()
MusicDatabase.SetAlbumOrigin()
MusicDatabase.SetArtwork()
MusicDatabase.SetArtworkColorByAlbumId()
MusicDatabase.SetColorThemeByVideoId()
MusicDatabase.SetLyrics()
MusicDatabase.SetTargetTag()
MusicDatabase.SetVideoFrames()
MusicDatabase.SetVideoTimeFrame()
MusicDatabase.SplitTagsByClass()
MusicDatabase.UpdateMusicProperty()
MusicDatabase.UpdateSongStatistic()
MusicDatabase.UpdateVideoStatistic()
MusicDatabase.WriteAlbum()
MusicDatabase.WriteArtist()
MusicDatabase.WriteSong()
MusicDatabase.WriteTag()
MusicDatabase.WriteVideo()
CheckPIDFile()
CreatePIDFile()
DeletePIDFile()
MusicDBWebSocketProtocol
MusicDBWebSocketServer
MusicDBWebSocketServer.HandleEvents()
MusicDBWebSocketServer.Setup()
MusicDBWebSocketServer.Start()
MusicDBWebSocketServer.Stop()
MusicDBWebSocketFactory
MusicDBWebSocketFactory.AddToBroadcast()
MusicDBWebSocketFactory.BroadcastPacket()
MusicDBWebSocketFactory.CloseConnections()
MusicDBWebSocketFactory.RemoveFromBroadcast()
WebSocket
WebSocket.BeautifyValues()
WebSocket.BroadcastPacket()
WebSocket.SendPacket()
WebSocket.onClose()
WebSocket.onCloseHandshakeTimeout()
WebSocket.onConnect()
WebSocket.onMessage()
WebSocket.onOpen()
WebSocket.onOpenHandshakeTimeout()
Management Modules
ArtworkManager
ArtworkManager.ImportAlbumArtwork()
ArtworkManager.ImportArtwork()
ArtworkManager.ImportArtworkFromUpload()
ArtworkManager.ImportVideoArtwork()
ArtworkManager.InitiateImport()
FilesystemManager
FilesystemManager.FindNewPaths()
FilesystemManager.InitiateFilesystemScan()
FilesystemManager.ScanFilesystem()
ImportManager
ImportManager.ImportAlbum()
ImportManager.ImportMusic()
ImportManager.ImportVideo()
ImportManager.InitiateImport()
IntegrationManager
IntegrationManager.InitiateIntegration()
IntegrationManager.IntegrateAlbumFile()
IntegrationManager.IntegrateUploadedFile()
IntegrationManager.IntegrateVideo()
TaskManager
TaskManager.CreateNewTask()
TaskManager.CreateTaskID()
TaskManager.ExistsTaskFile()
TaskManager.GetTaskByID()
TaskManager.GetTasks()
TaskManager.InitiateProcess()
TaskManager.LoadTasks()
TaskManager.NotifyClient()
TaskManager.RegisterCallback()
TaskManager.RemoveCallback()
TaskManager.RemoveTask()
TaskManager.SaveTask()
TaskManager.ScheduleTask()
TaskManager.UpdateTaskState()
UploadManager
UploadManager.AnnotateUpload()
UploadManager.InitiateUpload()
UploadManager.NewChunk()
UploadManager.PreProcessAlbumFile()
UploadManager.PreProcessArtwork()
UploadManager.PreProcessUploadedFile()
UploadManager.PreProcessVideo()
UploadManager.RequestRemoveUpload()
UploadManager.UploadCompleted()
Maintain Modules
JaveScript Classes
Other
musicdb
musicdb.lib.cache
musicdb.lib.cfg.config
musicdb.lib.cfg.csv
musicdb.lib.cfg.extern
musicdb.lib.cfg.mdbstate
musicdb.lib.cfg.musicdb
musicdb.lib.cfg.randy
musicdb.lib.cfg.webui
musicdb.lib.cfg.wsapikey
musicdb.lib.db.database
musicdb.lib.db.musicdb
musicdb.lib.db.trackerdb
musicdb.lib.fileprocessing
musicdb.lib.filesystem
musicdb.lib.logging
musicdb.lib.metatags
musicdb.lib.pidfile
musicdb.lib.stream.gstreamer
musicdb.lib.stream.icecast
musicdb.lib.stream.mp3stream
musicdb.lib.stream.mp3transcoder
musicdb.lib.ws.mdbwsi
musicdb.lib.ws.server
musicdb.lib.ws.websocket
musicdb.maintain.database
musicdb.maintain.datadirectory
musicdb.maintain.musicdatabase
musicdb.maintain.sslcert
musicdb.maintain.trackerdatabase
musicdb.mdbapi.accesspermissions
musicdb.mdbapi.artwork
musicdb.mdbapi.audiostream
musicdb.mdbapi.blacklist
musicdb.mdbapi.extern
musicdb.mdbapi.mise
musicdb.mdbapi.music
musicdb.mdbapi.musicdirectory
musicdb.mdbapi.randy
musicdb.mdbapi.server
musicdb.mdbapi.songqueue
musicdb.mdbapi.tags
musicdb.mdbapi.tracker
musicdb.mdbapi.videoframes
musicdb.mdbapi.videoqueue
musicdb.mdbapi.videostream
musicdb.mod.artwork
musicdb.mod.database
musicdb.mod.extern
musicdb.mod.metadata
musicdb.mod.mise
musicdb.mod.server
musicdb.mod.stats
musicdb.mod.tags
musicdb.mod.videoframes
musicdb.taskmanagement.artworkmanager
musicdb.taskmanagement.filesystemmanager
musicdb.taskmanagement.importmanager
musicdb.taskmanagement.integrationmanager
musicdb.taskmanagement.managementthread
musicdb.taskmanagement.taskmanager
musicdb.taskmanagement.uploadmanager