MusicDB
8.0

User Documentation

  • Installation & Update
    • Download
    • Installation via Package Manager
    • Initial Setup
      • Creating a Music Directory
      • Websocket Settings
      • Debugging logs
    • Start MusicDB Server
    • Setup Web User Interface via Apache
      • Start the Web Server
    • Setup Audio Streaming via Icecast
      • Setup Icecast
      • Run Icecast
    • Final Steps
  • Upload and Importing Music
    • Open Import Manager
    • Uploading an Album
    • Importing an Album
  • Music Naming Scheme
    • Overview of the Naming Scheme
    • Artist Directory Name
    • Album Directory Name
    • Song File Name
    • Music Video File Name
  • WebUI
    • Architecture and Wording
    • WebUI in Audio Mode
      • Genre View
      • HUD
      • Stream Control
      • Artists View
      • Album View
      • Queue View
      • Lyrics View
    • WebUI Settings Mode
  • Audio Stream
    • Managing the Audio Stream
    • Connection to Audio Stream via VLC
    • Connection to Audio Stream via WebUI
  • Command Line Interface
    • artwork - Artwork Management
    • database - Music DB Management
    • extern - Music File Exporter
      • File Export to External Device
    • metadata - Metadata Reader
    • mise - Micro Search Engine
    • server - MusicDB Websocket Server
    • stats - MusicDB Song Statistic
    • tags - MusicDB Tag Manager
      • Main commands
      • Style Guide
      • Example calls
    • videoframes - Video Frames and Preview Manager
  • Installation From Source
    • Dependencies
    • Installing the Back-End
    • Installing the Front-End
    • Installing Data and Configuration Files
    • Configure SELinux
  • Documentation Installation

Concepts and Configuration

  • Philosophy of MusicDB
  • MusicDB Configuration
    • meta
    • musicdb
    • directories
    • websocket
    • music
    • albumcover
    • videoframes
    • uploads
    • extern
    • tracker
    • Icecast
    • randy
    • log
    • debug
  • Security Concept
    • File Access Permissions
    • Password Protected Audio Stream
  • MusicDB Data Files and Directories
    • Music Directory
    • MusicDB Data Directory
    • MusicDB Log File
    • Transition from 7.2.0 to 8.0.0
      • Databases
      • Configuration
      • Artworks
      • Music
      • Web Server and Logrotate
  • Definitions in Context of MusicDB
    • Music, Songs and Videos
    • Artwork, Thumbnail, Frame and Preview
    • Flags vs. Tags
    • Music Properties & Statistics
    • MDBState vs. StreamState
  • Overview of MusicDB
    • MusicDB (Green)
      • MusicDB Server
      • MusicDB WebUI
    • External Servers (Black)
      • HTTP Server
      • Icecast Server
    • Music Information (Purple)
    • MusicDB Data (Blue)
      • Music Database
      • Artwork Cache
  • Comparison to Other Tools
    • Metrics
    • Comparison
      • Web UI and Streaming Capabilities
      • Detailed Look
    • Conclusion

Deeper Insight for Hackers

  • MusicDB Streaming Concept
    • General Data Flow
    • Stream Implementation
  • Creating new CLI Modules
    • Loading of Modules
    • Creation of new Modules
  • Workflow for distribution
    • Create Release Candidate Branch
    • Update Version Numbers
    • Source Tarball
    • Arch Linux pacman Package
    • Fedora rpm Package
    • Debian/Ubuntu deb Package
  • MusicDB Websocket API
    • Communication
      • Packet format
      • Methods
    • Client side interface
      • Callback functions
      • Send data to the server
    • Events
    • Server side API
      • Available Methods
      • Special Functions
      • Artists
      • Albums
      • Songs
      • Videos
      • Queue
      • Tag related
      • Lyrics
      • Uploading
      • File Handling
      • Other

API Classes

  • Access Permissions
    • AccessPermissions Class
  • Artwork Management
    • Artwork Related Database Entries
    • Artwork Path structure
      • Web Browsers
    • Scaled Artwork
    • Configuration for Artworks
    • Algorithm to Create Artworks
    • MusicDBArtwork Class
    • ArtworkCache Class
  • Audio Streaming Server
    • Audio Streaming Interface
    • Audio Streaming Thread
    • Audio Stream Command Queue
    • Audio Stream Event Management
    • Audio Stream Manager Class
  • Blacklist
    • Blacklist Module
      • Music Selection Blacklist
    • Blacklist Interface Class
  • MusicDBExtern
    • Initializing a Storage
      • Storage Configuration
      • The State-File
    • Updating a Storage
    • Handling Toxic Environments
    • MusicDBExtern Class
  • Micro Search Engine
    • MusicDBMicroSearchEngine Class
  • Music Management
    • MusicDBMusic Class
  • MusicDirectory
    • MusicDirectory Class
  • Randomizer
    • Randy Module
      • Song Selection Algorithm
        • Database Stage
        • Blacklist Stage
      • Video Selection Algorithm
    • Randy Class
  • MusicDB Websocket Server
  • MusicDB Song Queue
    • Song Queue Management
    • Song Queue Event Management
    • Song Queue Class
  • MusicDBTags
    • MusicDBTags Class
  • Song Tracker
    • Tracker Class
    • Tracker Database
    • TrackerDatabase Class
  • Video Frames and Preview Management
    • Definitions in Context of Videos
    • Relevant Database Entries
    • Video Frames Path structure
    • HTTPS Server Configuration for Video Frames
    • Scaling Video Frames
    • Configuration of Video Frames
    • Algorithm for Creating Video Frames
    • VideoFrames Class
  • MusicDB video Queue
    • Video Queue Management
    • Video Queue Event Management
    • Video Queue Class
  • Video Streaming Server
    • Video Streaming Interface
    • Video Streaming Thread
    • Video Stream Command Queue
    • Video Stream Event Management
    • Video Stream Manager Class

Libraries

  • Configuration Access
    • Base Configuration Classes
      • ini Files
      • csv Files
    • MusicDB Configuration File
    • WebUI Configuration File
    • External Storage Configuration File
    • MusicDB State Files
    • WebSocket API Key File
  • Database
    • Database Class
  • Fileprocessing Methods
    • Fileprocessing Class
  • Filesystem Interface
    • Filesystem Class
  • GStreamer Interface
    • GStreamer Pipeline
      • Installation of GStreamer Plugins
      • Example for Using Plugins
    • GStreamerInterface Class
  • Icecast Interface
    • Introduction to Icecast
      • Icecast Configuration
    • Icecast Class
  • MusicDB Logging
    • MusicDBLogger Class
  • Meta Tags
    • MetaTags Class
  • MP3 Stream Interface
    • MP3Stream Class
  • MP3 Transcoder
    • GStreamer Pipeline for Transcoding
    • UNIX Pipe
    • Transcoding
    • MP3Transcoder Class
  • MusicDatabase
    • Validity of columns
    • Adding a Column
    • Songs Table
      • Song Relates Methods
    • Videos Table
      • Video Relates Methods
    • Albums Table
      • Album Related Methods
      • Artwork Related Methods
      • Origin
    • Artists Table
    • Lyrics Table
    • Tags Table
      • Tag Definition Table
      • Tag Mapping Table
      • Tag Related Methods
    • MusicDatabase Class
  • PID File Handling
  • MusicDB Websocket Protocol
    • Websocket Server
    • Websocket Protocol

Management Modules

  • Artwork Tasks Management
    • ArtworkManager Class
  • Files and Directory Tasks Manager
    • FilesystemManager Class
  • Import Tasks Management
    • ImportManager Class
  • Integration Tasks Management
    • IntegrationManager Class
  • Task Management Thread
  • Task Management
    • TaskManager Class
  • Upload Tasks Management
    • UploadManager Class

Maintain Modules

  • Configuration and Data Maintaining Modules
  • Database Maintaining Modules

JaveScript Classes

  • Websocket Connection
    • Connection Process
    • Watchdog
    • Communication with the server
      • Sending Data
      • Receiving Data
    • Minimal usage

Other

  • Impressum
    • Angaben gemäß § 5 TMG
    • Kontakt
    • Verantwortlich für den Inhalt nach § 55 Abs. 2 RStV
    • Haftung für Inhalte
    • Haftung für Links
    • Urheberrecht
  • Datenschutzerklärung / Privacy Statement
    • Datenschutz
    • Cookies
    • Server-Log-Files
    • Facebook-Plugins (Like-Button)
    • Twitter
    • Google+
    • YouTube
    • SSL-Verschlüsselung
    • Widerspruch Werbe-Mails
MusicDB
  • Docs »
  • Search

© Copyright 2017 - 2022 Ralf Stemmer.

Built with Sphinx using a theme provided by Read the Docs.