However, the same server-side API can also be implemented by other programs (such as Carla),
although consistency and robustness will likely suffer if non-NSM compliant clients are allowed to
-participate in a session. There is no direct dependency for client implementations, as long as they
-can send and receive OSC. Some clients use liblo (the OSC library), which becomes a dependency if
-you choose to implement NSM-support with the provided header file nsm.h.
There is no direct dependency for client implementations, as long as they
+can send and receive OSC.
+Some clients use liblo (the OSC library), which becomes a dependency if you choose to implement
+NSM-support with the provided header file nsm.h (extras/nsm.h/nsm.h in the git repository).
+Some clients use the provided single-file python library pynsm (extras/pynsm/nsmclient.py in the git repository)
+which has no dependencies outside the Python3 standard library.
The aim of this project is to thoroughly define the behavior required of clients. Often the @@ -691,6 +703,30 @@ session. The symlinks thus created should, at the very least, be named after the to. Some unique component may be required to prevent collisions.
Subdirectories MAY be made to organize sessions into meaningful structures, such as album/track or
+composer/genre/piece. For example: Johann Sebastian Bach/Kantaten/Wie schön leuchtet der Morgenstern.
+Which results in the same directory structure on disk. Session names can contain any characters that
+are supported by the underlying file system, usually UTF-8.
Subdirectories are created by either nsmd itself or by the users themselves, through their file
+manager or a GUI (while the session is not open).
The project_name from /nsm/server/new s:project_name accepts the format a/b/c/d.
Any session itself MUST be a "leaf" in this directory tree. A session MUST NOT contain further
+session subdirectories: any directory that contains a file session.nsm is the final
+element in the hierarchy.
optional-gui
server responds to optional-gui messages. If this capability is not present then clients with optional-guis MUST always keep them visible
server responds to optional-gui messages. This capability is always present and MUST be supported by any server implementation.
New Session Manager
1.4.0
1.5.0
New Session Manager API
1.1.0 NEW nsmd.cpp
1.1.1 NEW nsmd.cpp
New API Document
1.4.0 Here
1.5.0 Here
Server-capability :optional-gui: is now mandatory for SERVER implementations. Reasoning: +This is an important core feature of NSM and thus will be treated as such by guaranteeing it to exist. +After looking at all currently known clients and server-implementations it turns out that all servers +support :optional-gui: and the vast majority of clients not only support it, but actually assume it +and do not test for the server capability, as it was written in this document. +There are now two choices: Adjust this document to the (good) reality or consider all clients broken. +Summary: We consider this API document wrong and therefore fix it, thus increasing API version +patch-level from 1.1.0 to 1.1.1
+Add API-section "Subdirectories / Hierarchical Structure" that explains the session directory. +This behaviour was already the case for nsm-legacy-gui and nsmd 1.5.0 was patched to adhere to this +behaviour more strictly as well, removing false session entries in 3rd party clients such as Agordejo.
+