Skip to content

Socket friendly directories#3816

Open
digable1 wants to merge 7 commits into
jamulussoftware:mainfrom
digable1:socket-friendly-directories
Open

Socket friendly directories#3816
digable1 wants to merge 7 commits into
jamulussoftware:mainfrom
digable1:socket-friendly-directories

Conversation

@digable1

@digable1 digable1 commented Jul 21, 2026

Copy link
Copy Markdown

This provides a way to get the friendly directory name: For example, directory socket anygenre2.jamulus.io:22224 has a friendly name of "Any Genre 2" on the Jamulus client - and previously no current way to get to that friendly name in the API.

CHANGELOG: Adds API call jamulusclient/getSocketAndFriendlyDirectories

Context: Fixes an issue? No

Does this change need documentation? What needs to be documented and how? JSON-RPC doc

Status of this Pull Request

??

What is missing until this pull request can be merged?

??

Checklist

  • I've verified that this Pull Request follows the general code principles
  • I tested my code and it does what I want
  • My code follows the style guide
  • I waited some time after this Pull Request was opened and all GitHub checks completed without errors.
  • I've filled all the content above

@mcfnord

mcfnord commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

I only recently learned that friendly names are translated. So is this result translated? English is requested for our github discussions, but why would an API want an English-only friendly name?

@ann0see

ann0see commented Jul 21, 2026

Copy link
Copy Markdown
Member

I think we consistently don't translate in JSON-RPC?

@mcfnord

mcfnord commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

I think we consistently don't translate in JSON-RPC?

Are there other examples where we return a string that gets localized in the GUI? It's not the right way to store the directory, compared to the canonical machine-readable name. And it's not the right string to show users, who don't necessarily know that string. I would use the canonical, machine-readable name and then look it up in my own copy of your localization table to get the translated string. When would an English-only string be more reliable and useful than that?

@digable1

Copy link
Copy Markdown
Author

This PR is not about translation. It's about getting the 'friendly name' in any context (and in this environment, we have settled on English).

@ann0see is right: This is API work, not for human display in a UI/UX setting. Therefore, translations should be confined to the visual side of the product. The user of the API can handle their own translation as needed.

That being said: If we want an optional argument to this method being the locale code (en_us, fr_CA, etc), that would present a consistent binding of how the Jamulus client renders the friendly directory name, so the actual friendly name remains consistent everywhere for all interactions, GUI and API.

@digable1

Copy link
Copy Markdown
Author

And: This does not take into account translating custom directory names, of course.

@ann0see ann0see added the AI AI generated or potentially AI generated label Jul 21, 2026
@pljones

pljones commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

@digable1 I've updated your PR (third one). Could you follow the instructions in the comments more carefully, please.

@pljones pljones added this to Tracking Jul 21, 2026
@github-project-automation github-project-automation Bot moved this to Triage in Tracking Jul 21, 2026
@pljones pljones added the JSON-RPC Related to the JSON-RPC API label Jul 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI AI generated or potentially AI generated JSON-RPC Related to the JSON-RPC API

Projects

Status: Triage

Development

Successfully merging this pull request may close these issues.

4 participants