Dorico.Net 0.3.0-beta

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of Dorico.Net. 
dotnet add package Dorico.Net --version 0.3.0-beta                

                    
                

            
NuGet\Install-Package Dorico.Net -Version 0.3.0-beta
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Dorico.Net" Version="0.3.0-beta" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Dorico.Net --version 0.3.0-beta                

                    
                

            
#r "nuget: Dorico.Net, 0.3.0-beta"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Dorico.Net as a Cake Addin
#addin nuget:?package=Dorico.Net&version=0.3.0-beta&prerelease

// Install Dorico.Net as a Cake Tool
#tool nuget:?package=Dorico.Net&version=0.3.0-beta&prerelease

Dorico.Net

A library for working with Dorico's Remote Control API

Version 0.3.0-beta

Description

See Example app for usage.

Leave feedback or open a branch if there's a common functionality you think should be added.

Internally, Dorico uses a command system to realize each piece of functionality. These commands are echoed in the application.log file (On Windows: C:\Users\[UserName]\AppData\Roaming\Steinberg\Dorico 5\application.log, On Mac: /Library/Users/[UserName]/Application Support/Steinberg/Dorico 5). For example, opening a score generates a command "File.Open?File=[Path]". Dorico's API allows you to send these commands to be executed. (Some seem to be disabled, such as "File.New".) Bear in mind that this is not a plugin, so any UI is external to Dorico.

The big limitation at the moment is there is no way to query for contextual information. The API can return what is currently selected and all the properties for that selection, but there's no good way to get any info about the bar/staff/etc. around that selection.

The Dorico API is not well documented. Examining the application.log is the best way to see which commands and what parameter values are used to accomplish a piece of functionality.

Notes

This code has been tested with Dorico Pro 5.1.70 on Windows 11.

The Note class does not currently support microtonality.

Disclaimer

The Dorico trademark is registered in the US, Europe and other countries by Steinberg Media Technologies GmbH and is used with permission.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.3.0-beta 0 11/26/2024
0.2.0-beta 190 12/5/2023
0.1.0-beta 72 12/4/2023

Many breaking changes

Solution updated to use .NET 8
Various NuGet references updated

StatusResponse.ZoomPercent changed from string? to int?
Multiple new properties added to StatusResponse

DoricoRemote.CurrentStatus added

Partial status responses from Dorico are now merged into CurrentStatus

All response classes now contain Response in their name.

---
The Dorico trademark is registered in the US, Europe and other countries by Steinberg Media Technologies GmbH and is used with permission