API Reference

This section contains the complete API reference for Walrio modules, automatically generated from the source code docstrings.

Module APIs

• Walrio Libraries API
  • Database Module
  • Player Module
  • Playlist Module
  • Queue Module
  • Overview
• Addons API
  • Overview

Core Libraries

The core libraries provide the fundamental functionality for Walrio:

modules.libraries.database	Audio Library Analyzer Copyright (c) 2025 TAPS OSS Project: https://github.com/TAPSOSS/Walrio Licensed under the BSD-3-Clause License (see LICENSE file for details)
modules.libraries.player	Audio Player using GStreamer Command-Line Tools Copyright (c) 2025 TAPS OSS Project: https://github.com/TAPSOSS/Walrio Licensed under the BSD-3-Clause License (see LICENSE file for details)
modules.libraries.playlist	Playlist Manager Copyright (c) 2025 TAPS OSS Project: https://github.com/TAPSOSS/Walrio Licensed under the BSD-3-Clause License (see LICENSE file for details)
modules.libraries.queue	Audio Queue Manager Copyright (c) 2025 TAPS OSS Project: https://github.com/TAPSOSS/Walrio Licensed under the BSD-3-Clause License (see LICENSE file for details)

Module Overview

Database Module

SQLite database operations for music metadata and library management.

Player Module

Audio playback functionality.

Playlist Module

M3U playlist creation, parsing, and management from various sources including database queries and file system scanning.

Queue Module

Playback queue management with shuffle, repeat, and queue manipulation features.

Quick Reference

Common Classes

• database.DatabaseManager - Main database interface

• player.GStreamerPlayer - Core audio player implementation

• queue.PlaybackQueue - Queue management for playback

Common Functions

• database.create_database() - Initialize music library database

• player.format_time() - Format duration for display

• playlist.create_m3u_playlist() - Generate M3U playlist files

• queue.shuffle_queue() - Randomize playback order

Constants

• database.AUDIO_EXTENSIONS - Supported audio file formats

• playlist.DEFAULT_DB_PATH - Default database location

• player.SUPPORTED_FORMATS - Audio formats supported by player