Add server api definition

This commit is contained in:
2025-05-24 19:54:06 +02:00
commit a80465c6c1
37 changed files with 3842 additions and 0 deletions

View File

@@ -0,0 +1,16 @@
using Microsoft.AspNetCore.Mvc;
using MusicCast.Net.Api.Server.Models;
namespace MusicCast.Net.Api.Server.Controllers;
[ApiController]
[Route("/YamahaExtendedControl/v1/dist/")]
public class DistController
{
[HttpGet]
[Route("getDistributionInfo")]
public GetDistributionInfoResponse GetDistributionInfo()
{
throw new NotImplementedException();
}
}

View File

@@ -0,0 +1,59 @@
using Microsoft.AspNetCore.Mvc;
using MusicCast.Net.Api.Server.Models;
namespace MusicCast.Net.Api.Server.Controllers;
[ApiController]
[Route("/YamahaExtendedControl/v1/main/")]
public class MainController
{
[HttpGet]
[Route("getStatus")]
public GetStatusResponse GetStatus()
{
throw new NotImplementedException();
}
[HttpGet]
[Route("getSignalInfo")]
public GetSignalInfoResponse GetSignalInfo()
{
throw new NotImplementedException();
}
[HttpGet]
[Route("setVolume")]
public BaseResponse SetVolume([FromQuery] int volume)
{
throw new NotImplementedException();
}
[HttpGet]
[Route("prepareInputChange")]
public BaseResponse PrepareInputChange([FromQuery] string input)
{
throw new NotImplementedException();
}
[HttpGet]
[Route("setInput")]
public BaseResponse SetInput([FromQuery] string input)
{
throw new NotImplementedException();
}
[EndpointSummary("Shutdown after the specified interval in minutes")]
[HttpGet]
[Route("setSleep")]
public BaseResponse SetSleep([FromQuery] int sleep)
{
throw new NotImplementedException();
}
[HttpGet]
[Route("setPower")]
public BaseResponse SetPower([FromQuery] PowerState power)
{
throw new NotImplementedException();
}
}

View File

@@ -0,0 +1,124 @@
using Microsoft.AspNetCore.Mvc;
using MusicCast.Net.Api.Server.Models;
namespace MusicCast.Net.Api.Server.Controllers;
[ApiController]
[Route("/YamahaExtendedControl/v1/netusb/")]
public class NetUsbController
{
[HttpGet]
[Route("getMcPlaylistName")]
public GetMcPlaylistNameResponse GetMcPlaylistName()
{
throw new NotImplementedException();
}
[HttpGet]
[Route("getStreamingServiceSettings")]
public GetStreamingServiceSettingsResponse GetStreamingServiceSettings()
{
throw new NotImplementedException();
}
[HttpGet]
[Route("getPlayInfo")]
public GetPlayInfoResponse GetPlayInfo()
{
throw new NotImplementedException();
}
[HttpGet]
[Route("getPlayQueue")]
public GetPlayQueueResponse GetPlayQueue([FromQuery] int index)
{
throw new NotImplementedException();
}
[HttpGet]
[Route("getRecentInfo")]
public GetRecentInfoResponse GetRecentInfo()
{
throw new NotImplementedException();
}
[HttpGet]
[Route("recallRecentItem")]
public BaseResponse RecallRecentItem([FromQuery] string zone, [FromQuery] int num)
{
throw new NotImplementedException();
}
[HttpGet]
[Route("setPlayback")]
public BaseResponse SetPlayback([FromQuery] PlaybackAction playback)
{
throw new NotImplementedException();
}
[HttpGet]
[Route("toggleShuffle")]
public BaseResponse ToggleShuffle()
{
throw new NotImplementedException();
}
[HttpGet]
[Route("toggleRepeat")]
public BaseResponse ToggleRepeat()
{
throw new NotImplementedException();
}
[HttpGet]
[Route("getListInfo")]
public GetListInfoResponse GetListInfo([FromQuery] string list_id, [FromQuery] string input, [FromQuery] int size, [FromQuery] string lang)
{
throw new NotImplementedException();
}
[HttpGet]
[Route("setListControl")]
public BaseResponse SetListControl([FromQuery] ListControlAction type, [FromQuery] int index, [FromQuery] string zone)
{
throw new NotImplementedException();
}
[HttpGet]
[Route("manageList")]
public BaseResponse ManageList(
[FromQuery] string list_id,
[FromQuery] ManageListAction type,
[FromQuery] int index,
[FromQuery] int timeout,
[FromQuery] string zone
)
{
throw new NotImplementedException();
}
[HttpGet]
[Route("managePlayQueue")]
public BaseResponse ManagePlayQueue(
[FromQuery] ManagePlayQueueAction type,
[FromQuery] int index,
[FromQuery] string zone
)
{
throw new NotImplementedException();
}
[HttpGet]
[Route("copyPlayQueue")]
public BaseResponse CopyPlayQueue([FromQuery] int index)
{
throw new NotImplementedException();
}
[HttpGet]
[Route("movePlayQueueItem")]
public BaseResponse MovePlayQueueItem([FromQuery] int from, [FromQuery] int to)
{
throw new NotImplementedException();
}
}

View File

@@ -0,0 +1,95 @@
using Microsoft.AspNetCore.Mvc;
using MusicCast.Net.Api.Server.Models;
namespace MusicCast.Net.Api.Server.Controllers;
[ApiController]
[Route("/YamahaExtendedControl/v1/system/")]
public class SystemController : ControllerBase
{
[HttpGet]
[Route("getFeatures")]
[EndpointSummary("Get the available features for this device")]
public GetFeaturesResponse GetFeatures()
{
throw new NotImplementedException();
}
[HttpGet]
[Route("getLocationInfo")]
public GetLocationInfoResponse GetLocationInfo()
{
throw new NotImplementedException();
}
[HttpGet]
[Route("getNameText")]
[EndpointSummary("Get sources friendly names")]
public GetNameTextResponse GetNameText()
{
throw new NotImplementedException();
}
[HttpGet]
[Route("getDeviceInfo")]
public GetDeviceInfoResponse GetDeviceInfo()
{
throw new NotImplementedException();
}
[HttpGet]
[Route("isNewFirmwareAvailable")]
public IsNewFirmwareAvailableResponse IsNewFirmwareAvailable([FromQuery] string type)
{
throw new NotImplementedException();
}
[HttpGet]
[Route("getFuncStatus")]
public GetFuncStatusResponse GetFuncStatus()
{
throw new NotImplementedException();
}
[HttpGet]
[Route("getDisklavierSettings")]
public GetDisklavierSettingsResponse GetDisklavierSettings()
{
throw new NotImplementedException();
}
[HttpGet]
[Route("getTag")]
public GetTagResponse GetTag()
{
throw new NotImplementedException();
}
[HttpGet]
[Route("getYpaoConfig")]
public GetYpaoConfigResponse GetYpaoConfig()
{
throw new NotImplementedException();
}
[HttpGet]
[Route("setSpeakerA")]
public BaseResponse setSpeakerA([FromQuery] bool enable)
{
throw new NotImplementedException();
}
[HttpGet]
[Route("setSpeakerB")]
public BaseResponse setSpeakerB([FromQuery] bool enable)
{
throw new NotImplementedException();
}
[HttpGet]
[Route("getNetworkStandby")]
public GetNetworkStandbyResponse GetNetworkStandby()
{
throw new NotImplementedException();
}
}

View File

@@ -0,0 +1,6 @@
namespace MusicCast.Net.Api.Server.Models;
public class BaseResponse
{
public string response_code { get; set; }
}

View File

@@ -0,0 +1,17 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetDeviceInfoResponse
{
public int response_code { get; set; }
public string model_name { get; set; }
public string destination { get; set; }
public string device_id { get; set; }
public string system_id { get; set; }
public int system_version { get; set; }
public double api_version { get; set; }
public int netmodule_generation { get; set; }
public string netmodule_version { get; set; }
public string netmodule_checksum { get; set; }
public string operation_mode { get; set; }
public string update_error_code { get; set; }
}

View File

@@ -0,0 +1,21 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetDisklavierSettingsResponse
{
public int response_code { get; set; }
public bool enable { get; set; }
public string mode { get; set; }
public string input { get; set; }
public Pair pair { get; set; }
public Disklavier disklavier { get; set; }
public class Pair
{
public string mac_address { get; set; }
}
public class Disklavier
{
public string ip_address { get; set; }
}
}

View File

@@ -0,0 +1,11 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetDistributionInfoResponse
{
public int response_code { get; set; }
public string group_id { get; set; }
public string group_name { get; set; }
public string role { get; set; }
public string server_zone { get; set; }
public object[] client_list { get; set; }
}

View File

@@ -0,0 +1,190 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetFeaturesResponse
{
public int response_code { get; set; }
public System system { get; set; }
public Zone[] zone { get; set; }
public Tuner tuner { get; set; }
public Netusb netusb { get; set; }
public Distribution distribution { get; set; }
public Ccs ccs { get; set; }
public class System
{
public string[] func_list { get; set; }
public int zone_num { get; set; }
public Input_list[] input_list { get; set; }
public Speaker_settings speaker_settings { get; set; }
public string[] ypao_speaker_unit_list { get; set; }
}
public class Input_list
{
public string id { get; set; }
public bool distribution_enable { get; set; }
public bool rename_enable { get; set; }
public bool account_enable { get; set; }
public string play_info_type { get; set; }
}
public class Speaker_settings
{
public string type { get; set; }
public Common common { get; set; }
public Front_l front_l { get; set; }
public Front_r front_r { get; set; }
public Swfr swfr { get; set; }
}
public class Common
{
public int attribute { get; set; }
public int[] swfr_crossover_list { get; set; }
public Speaker_size[] speaker_size { get; set; }
}
public class Speaker_size
{
public string id { get; set; }
public string[] size_list { get; set; }
}
public class Front_l
{
public int attribute { get; set; }
public Range_step[] range_step { get; set; }
}
public class Range_step
{
public string id { get; set; }
public int min { get; set; }
public int max { get; set; }
public int step { get; set; }
}
public class Front_r
{
public int attribute { get; set; }
public Range_step1[] range_step { get; set; }
}
public class Range_step1
{
public string id { get; set; }
public int min { get; set; }
public int max { get; set; }
public int step { get; set; }
}
public class Swfr
{
public int attribute { get; set; }
public Range_step2[] range_step { get; set; }
}
public class Range_step2
{
public string id { get; set; }
public int min { get; set; }
public int max { get; set; }
public int step { get; set; }
}
public class Zone
{
public string id { get; set; }
public string[] func_list { get; set; }
public string[] input_list { get; set; }
public string[] link_control_list { get; set; }
public string[] link_audio_delay_list { get; set; }
public string[] link_audio_quality_list { get; set; }
public Range_step3[] range_step { get; set; }
}
public class Range_step3
{
public string id { get; set; }
public int min { get; set; }
public int max { get; set; }
public int step { get; set; }
}
public class Tuner
{
public string[] func_list { get; set; }
public Range_step4[] range_step { get; set; }
public Preset preset { get; set; }
}
public class Range_step4
{
public string id { get; set; }
public int min { get; set; }
public int max { get; set; }
public int step { get; set; }
}
public class Preset
{
public string type { get; set; }
public int num { get; set; }
}
public class Netusb
{
public string[] func_list { get; set; }
public Preset1 preset { get; set; }
public Recent_info recent_info { get; set; }
public Play_queue play_queue { get; set; }
public Mc_playlist mc_playlist { get; set; }
public string net_radio_type { get; set; }
public Pandora pandora { get; set; }
public Siriusxm siriusxm { get; set; }
}
public class Preset1
{
public int num { get; set; }
}
public class Recent_info
{
public int num { get; set; }
}
public class Play_queue
{
public int size { get; set; }
}
public class Mc_playlist
{
public int size { get; set; }
public int num { get; set; }
}
public class Pandora
{
public string[] sort_option_list { get; set; }
}
public class Siriusxm
{
public string api_type { get; set; }
}
public class Distribution
{
public int version { get; set; }
public int[] compatible_client { get; set; }
public int client_max { get; set; }
public string[] server_zone_list { get; set; }
}
public class Ccs
{
public bool supported { get; set; }
}
}

View File

@@ -0,0 +1,10 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetFuncStatusResponse
{
public int response_code { get; set; }
public bool auto_power_standby { get; set; }
public bool speaker_a { get; set; }
public bool speaker_b { get; set; }
public bool headphone { get; set; }
}

View File

@@ -0,0 +1,22 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetListInfoResponse
{
public int response_code { get; set; }
public string input { get; set; }
public int menu_layer { get; set; }
public int max_line { get; set; }
public int index { get; set; }
public int playing_index { get; set; }
public string menu_name { get; set; }
public List_info[] list_info { get; set; }
public class List_info
{
public string text { get; set; }
public object[] subtexts { get; set; }
public string thumbnail { get; set; }
public string logo { get; set; }
public int attribute { get; set; }
}
}

View File

@@ -0,0 +1,14 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetLocationInfoResponse
{
public int response_code { get; set; }
public string id { get; set; }
public string name { get; set; }
public Zone_list zone_list { get; set; }
public class Zone_list
{
public bool main { get; set; }
}
}

View File

@@ -0,0 +1,7 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetMcPlaylistNameResponse
{
public int response_code { get; set; }
public string[] name_list { get; set; }
}

View File

@@ -0,0 +1,21 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetNameTextResponse
{
public int response_code { get; set; }
public Zone_list[] zone_list { get; set; }
public Input_list[] input_list { get; set; }
public object[] sound_program_list { get; set; }
public class Zone_list
{
public string id { get; set; }
public string text { get; set; }
}
public class Input_list
{
public string id { get; set; }
public string text { get; set; }
}
}

View File

@@ -0,0 +1,7 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetNetworkStandbyResponse
{
public int response_code { get; set; }
public string network_standby { get; set; }
}

View File

@@ -0,0 +1,23 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetPlayInfoResponse
{
public int response_code { get; set; }
public string input { get; set; }
public string play_queue_type { get; set; }
public string playback { get; set; }
public string repeat { get; set; }
public string shuffle { get; set; }
public int play_time { get; set; }
public int total_time { get; set; }
public string artist { get; set; }
public string album { get; set; }
public string track { get; set; }
public string albumart_url { get; set; }
public int albumart_id { get; set; }
public string usb_devicetype { get; set; }
public bool auto_stopped { get; set; }
public int attribute { get; set; }
public string[] repeat_available { get; set; }
public string[] shuffle_available { get; set; }
}

View File

@@ -0,0 +1,22 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetPlayQueueResponse
{
public int response_code { get; set; }
public string type { get; set; }
public int max_line { get; set; }
public int playing_index { get; set; }
public int index { get; set; }
public Track_info[] track_info { get; set; }
public class Track_info
{
public string input { get; set; }
public string text { get; set; }
public string thumbnail { get; set; }
public int attribute { get; set; }
}
}

View File

@@ -0,0 +1,16 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetRecentInfoResponse
{
public int response_code { get; set; }
public Recent_info[] recent_info { get; set; }
public class Recent_info
{
public string input { get; set; }
public string text { get; set; }
public string albumart_url { get; set; }
public int play_count { get; set; }
public int attribute { get; set; }
}
}

View File

@@ -0,0 +1,14 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetSignalInfoResponse
{
public int response_code { get; set; }
public Audio audio { get; set; }
public class Audio
{
public int error { get; set; }
public string format { get; set; }
public string fs { get; set; }
}
}

View File

@@ -0,0 +1,17 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetStatusResponse
{
public int response_code { get; set; }
public string power { get; set; }
public int sleep { get; set; }
public int volume { get; set; }
public bool mute { get; set; }
public int max_volume { get; set; }
public string input { get; set; }
public bool distribution_enable { get; set; }
public string link_control { get; set; }
public string link_audio_delay { get; set; }
public string link_audio_quality { get; set; }
public int disable_flags { get; set; }
}

View File

@@ -0,0 +1,14 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetStreamingServiceSettingsResponse
{
public int response_code { get; set; }
public Services[] services { get; set; }
public class Services
{
public string input { get; set; }
public bool confirmed { get; set; }
public bool use_service { get; set; }
}
}

View File

@@ -0,0 +1,20 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetTagResponse
{
public int response_code { get; set; }
public Zone_list[] zone_list { get; set; }
public Input_list[] input_list { get; set; }
public class Zone_list
{
public string id { get; set; }
public int tag { get; set; }
}
public class Input_list
{
public string id { get; set; }
public int tag { get; set; }
}
}

View File

@@ -0,0 +1,11 @@
namespace MusicCast.Net.Api.Server.Models;
public class GetYpaoConfigResponse
{
public int response_code { get; set; }
public string ypao_status { get; set; }
public bool ypao_setting { get; set; }
public string ypao_speaker_unit { get; set; }
public bool ypao_volume { get; set; }
public int disable_flags { get; set; }
}

View File

@@ -0,0 +1,7 @@
namespace MusicCast.Net.Api.Server.Models;
public class IsNewFirmwareAvailableResponse
{
public int response_code { get; set; }
public bool available { get; set; }
}

View File

@@ -0,0 +1,8 @@
namespace MusicCast.Net.Api.Server.Models;
public enum ListControlAction
{
select,
play,
@return,
}

View File

@@ -0,0 +1,8 @@
namespace MusicCast.Net.Api.Server.Models;
public enum ManageListAction
{
play_now,
play_next,
add_to_queue
}

View File

@@ -0,0 +1,7 @@
namespace MusicCast.Net.Api.Server.Models;
public enum ManagePlayQueueAction
{
play,
remove
}

View File

@@ -0,0 +1,9 @@
namespace MusicCast.Net.Api.Server.Models;
public enum PlaybackAction
{
pause,
previous,
next,
stop
}

View File

@@ -0,0 +1,7 @@
namespace MusicCast.Net.Api.Server.Models;
public enum PowerState
{
on,
standby
}

View File

@@ -0,0 +1,21 @@
<Project Sdk="Microsoft.NET.Sdk.Web">
<PropertyGroup>
<TargetFramework>net9.0</TargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<OpenApiDocumentsDirectory>.</OpenApiDocumentsDirectory>
<NoWarn>CS8618</NoWarn>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.5"/>
<PackageReference Include="Microsoft.Extensions.ApiDescription.Server" Version="9.0.5">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="8.1.2" />
</ItemGroup>
</Project>

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,40 @@
using System.Text.Json.Serialization;
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
builder.Services.AddControllers();
// Learn more about configuring OpenAPI at https://aka.ms/aspnet/openapi
builder.Services.AddOpenApi();
// String enums: https://stackoverflow.com/a/76644093
builder.Services.ConfigureHttpJsonOptions(options =>
{
options.SerializerOptions.Converters.Add(new JsonStringEnumConverter());
});
builder.Services.Configure<Microsoft.AspNetCore.Mvc.JsonOptions>(options =>
{
options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
});
var app = builder.Build();
// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
app.MapOpenApi();
app.UseSwaggerUI(options =>
{
options.SwaggerEndpoint("/openapi/v1.json", "v1");
});
}
app.UseHttpsRedirection();
app.UseAuthorization();
app.MapControllers();
app.Run();

View File

@@ -0,0 +1,25 @@
{
"$schema": "https://json.schemastore.org/launchsettings.json",
"profiles": {
"http": {
"commandName": "Project",
"dotnetRunMessages": true,
"launchBrowser": true,
"launchUrl": "swagger",
"applicationUrl": "http://localhost:5235",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
}
},
"https": {
"commandName": "Project",
"dotnetRunMessages": true,
"launchBrowser": true,
"launchUrl": "swagger",
"applicationUrl": "https://localhost:7211;http://localhost:5235",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
}
}
}
}

View File

@@ -0,0 +1,8 @@
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
}
}
}

View File

@@ -0,0 +1,9 @@
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
}
},
"AllowedHosts": "*"
}