OpenSubsonic Compatibility Matrix

Last updated: January 13, 2026
Applies to: Melodee 1.8.0+

Compliance Status: Melodee implements OpenSubsonic API response structures that conform to published XSD schema specifications.

• 311 tests validate response schema structure for all implementable JSON endpoints
• 50+ response elements defined with full attribute validation
• 8 error codes (10-80) validated with proper format
• All tests pass (100% pass rate)
• Binary content endpoints return correct content types

This document provides a detailed compatibility matrix for Melodee’s OpenSubsonic API implementation. Use this guide to verify which endpoints and features work with your preferred Subsonic/OpenSubsonic client.

Quick Reference

What “✅ Supported” Means

An endpoint marked as “✅ Supported” means:

1. The endpoint is implemented in the codebase
2. For endpoints with “Schema Validation” tests: Response structure is verified against XSD
3. For endpoints with “Manual” tests: Functionality has been verified by a person

It does NOT guarantee:

• Full protocol compliance in all edge cases
• Error handling matches specification
• Performance meets expectations
• All client features work correctly

Core Endpoints

System

Browsing

Album/Song Lists

Searching

Playlists

Media Retrieval

User Data

Media Annotation

Bookmarks

Media Library Scanning

Jukebox

Podcasts

Shares

Internet Radio

OpenSubsonic Extensions

Melodee supports the following OpenSubsonic extensions:

Known Limitations and Differences

Compared to other popular Subsonic servers (Navidrome, Airsonic):

Client Behavior Notes

Symfonium (Android)

Feishin (Desktop)

DSub / Ultrasonic (Android)

Supersonic (Desktop)

Client Verification

Testing

Automated Tests

Melodee includes an automated test suite that validates OpenSubsonic API compliance. Run tests with:

# Run schema validation tests
dotnet test tests/Melodee.Tests.Common -v --filter "FullyQualifiedName~OpenSubsonicApiSchemaValidationTests"

# Run all common tests
dotnet test tests/Melodee.Tests.Common

Test Coverage (311 tests total):

Schema Validator Coverage:

The schema validator validates response elements against Subsonic XSD types (50+ elements defined):

Test Results (January 13, 2026):

• Total Tests: 311 (implementation complete)
• Passing: 311 (100%)
• Failed: 0
• Skipped: 0
• Schema Elements Validated: 50+
• Error Codes Validated: 8 (10, 20, 30, 40, 50, 60, 70, 80)

Schema Validation Testing

Melodee includes an automated test suite that validates OpenSubsonic API response structures against published XSD specifications. These tests verify that JSON responses conform to expected schema patterns, including:

• Response Structure: Element hierarchy and child relationships
• Required Attributes: Presence of mandatory fields (id, name, etc.)
• Field Types: Correct data types for all attributes
• Nested Elements: Properly structured arrays and child collections
• Error Responses: All documented error codes (10-80)

Run tests:

dotnet test tests/Melodee.Tests.Common -v --filter "FullyQualifiedName~OpenSubsonicApiSchemaValidationTests"

What These Tests Validate

Our 160 schema validation tests verify:

• Response Structure: JSON response elements conform to Subsonic XSD schema definitions
• Required Attributes: Presence of mandatory fields (e.g., id, name on response elements)
• Field Types: Correct data types (integer, boolean, dateTime, string, float)
• Nested Elements: Properly structured arrays and child elements
• Error Formats: All documented error codes (10-80) with proper code/message structure
• Version Compliance: All responses follow X.Y.Z version format pattern
• Type Field: All responses include type field with “Melodee” value

What These Tests Do NOT Validate

These tests verify SCHEMA STRUCTURE only and do NOT test:

• Request Parameter Validation: Handling of invalid or missing parameters
• Functional Behavior: Actual streaming, transcoding, or playback functionality
• Authentication Flow: Token generation, expiration, or security
• Performance: Rate limiting, throughput, or load handling
• Integration: HTTP controller endpoints (Podcast, Jukebox) require full server setup
• Client-Specific Behavior: Edge cases or workarounds for specific clients

Manual Verification

To manually verify client compatibility with Melodee’s OpenSubsonic implementation:

1. Start Melodee with test data: dotnet run --project src/Melodee.Blazor
2. Configure your client to connect to http://localhost:5000
3. Use credentials: username test, password testpassword
4. Test core functionality: browse, search, stream, playlists, favorites
5. Report any issues at GitHub Issues

Related Documentation

• OpenSubsonic API Reference
• API Overview
• Installation Guide
• Configuration Reference

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.