search

jamulussoftware / jamuluswebsite

This is the GitHub Pages repository for the Jamulus main website. For the jamulus application source code, please visit jamulussoftware/jamulus.
https://jamulus.io
GNU Lesser General Public License v2.1
16 stars 79 forks source link

Enhancement of Sound-Devices.md (proposals) #136

Closed gegeweb closed 3 years ago

gegeweb commented 3 years ago

Sound-Devices.md is the only page I haven't pushed for the French translation. If I understood correctly, this page will be the official page maintained with up-to-date information. A page on the community area will be completed by the users. Right?

This page should be more structured to be readable and transmit the information correctly, I would suggest the following (as an example):

Sound Devices

This page lists (thanks to Jamulus users) the audio devices known to work (or not) with Jamulus.
Note: depends on how the device works on your system (Linux, MacOS, Windows, etc.).

You can update it with the information you have. Please indicate the platform(s) you are using!.

Audio devices known to work with Jamulus

USB/USB-C devices

Microphones / DI Boxes

Audio interfaces / digital mixing consoles

…

Amp modelers/effects pedals for instruments

…

Digital recorders

…

Firewire devices

…

Thunderbolt devices

…

Internal soundcards

…

Audio devices known not to work with Jamulus

ann0see commented 3 years ago

Yes. This looks much more structured!

ann0see commented 3 years ago

If I understood correctly, this page will be the official page maintained with up-to-date information. A page on the community area will be completed by the users. Right?

I don't know about this exactly but I think there should be one list only. Everyone is free to add things to the list (or improve the docs in general).

gilgongo commented 3 years ago

This list seems to be a natural for a community effort really, since none of us are going to be able to ensure accuracy over time are we? And again, the test here being: is this content needed for everyone on any given platform to actually use Jamulus? If yes, then it's official documentation, if no then it's community content.

gegeweb commented 3 years ago

This list seems to be a natural for a community effort really, since none of us are going to be able to ensure accuracy

Agree. Otherwise, if the device works on the system with other applications, there is no reason why it should not work with Jamulus, unless it does not support 48KHz. so …

the test here being: is this content needed for everyone on any given platform to actually use Jamulus? If yes, then it's official documentation, if no then it's community content.

… Actual tittle of this page is Known good devices, it should be "good devices" and this part of the documentation should explain what is a good audio device for Jamulus ?

And other important points to note (If I've missed something else) and then point to the community page.

So, no need a dedicated page IMHO, but should be in "requires" paragraph in Getting Started.

And as the server is not the cause of most issues with Jamulus, that's the same for the soundcard, it depends of the host capacities. eg. I've tested my new SSL2+ on macOS, Ubunutu 20.10 (PC), Raspberry Pi4 8 Gb RAM (will test soon on Windows), work's verry well "out of the box" with the three. But on the Rpi, to avoid dropouts and other issues, i need to run ONLY Jamulus. If i open a browser for look at the chords of the song, sound went bad.

The most issues are, on Linux, if the manufacter doesn't follow standard for USB Audio or don't provide spec for the Firewire or TB device if a driver is needed. And on Windows with ASIO as I can see.

But if there is a community page, this page should be structured.

gegeweb commented 3 years ago

Even if this page move on the community section, I can do the work as a good starting point and as examples for how to list your device.

gilgongo commented 3 years ago

it should be "good devices" and this part of the documentation should explain what is a good audio device for Jamulus ?

That's a really good idea.

ann0see commented 3 years ago

What we could do would be to maintain a small list which focuses on general suggestions (ASIO Driver, Sample rate,...) and a only a hand full of recommend "first start", cheap devices. And then link to a big page (which is searchable for devices) in the Knowledge Base.

gegeweb commented 3 years ago

And then link to a big page (which is searchable for devices) in the Knowledge Base.

I have finished with the original page and the french version. So, we wait? Or I submit the changes with a PR?

ann0see commented 3 years ago

I don't know that? We haven't agreed yet.

gegeweb commented 3 years ago

I don't know that? We haven't agreed yet.

You said above Yes. This looks much more structured!

So, I've worked on that. But if the structure of the site/wiki change with a community section, I think it is not necessary to propose an update for the actual 'Sound-Devices" page.

ann0see commented 3 years ago

Yes, I did say this. And I still think a structure like that is great.

But we haven't agreed if we want to use two pages or one page.

gegeweb commented 3 years ago

But we haven't agreed if we want to use two pages or one page.

The page I worked on is the actual Sound-Devices page, to be submitted to the changes branch. That's my question: do I submit the PR, or it is better to wait the decision about one or two pages?

ann0see commented 3 years ago

If you've already worked on it I'd suggest to open a pr (since we can always close/modify it). Since it's English, I suggest gilgongo to review this pr.

gegeweb commented 3 years ago

@gilgongo @ann0see @trebmuh You can take à look at the #169 opened this morning (draft on changes).

ann0see commented 3 years ago

Current status of this:

Name of device Description

Windows: Works/doesn’t work

macOS: Works/doesn’t work

Linux: Works/doesn’t work

Additional notes.

Not 100% sure if removing the li was right, but it broke the layout for me (especially on new lines)

gegeweb commented 3 years ago

We now have a short description on the Getting started page about "good devices". We don’t talk about "Allow monitoring signal from computer" etc. @gegeweb any proposals/ideas on this?

Something like should be good:

« We strongly recommend – although you could start without it – to use an audio interface (a box you plug a microphone/instrument into and connect to your PC e.g. via USB) to enjoy higher quality sound with low latency in Jamulus. You can also use a USB microphone. See recommended hardware. It is better if your device allows monitoring of the signal coming back from Jamulus (from the PC, for example). If this is not the case, configure Jamulus (or JACK) to send the signal to the computer's headphone output. »

trebmuh commented 3 years ago

a box you plug a microphone/instrument into and connect to your PC e.g. via USB

What about the PCI, PCI-e, or other sound cards which are very good at providing sound quality too (some are even better) ?

It is better ...

"Why" it is better. Users deserve an explanation of the why here.

gegeweb commented 3 years ago

What about the PCI, PCI-e, or other sound cards which are very good at providing sound quality too (some are even better) ?

I've just added this

It is better if your device allows monitoring of the signal coming back from Jamulus (from the PC, for example). If this is not the case, configure Jamulus (or JACK) to send the signal to the computer's headphone output

Everything else is already present.

trebmuh commented 3 years ago

It is better if your device allows monitoring of the signal coming back from Jamulus (from the PC, for example). If this is not the case, configure Jamulus (or JACK) to send the signal to the computer's headphone output

This sentence doesn't explain why "it is better".

ann0see commented 3 years ago

"Why" it is better. Users deserve an explanation of the why here.

I think it refers to:

ONLY. LISTEN. TO. THE. SIGNAL. FROM. THE. SERVER!

...which might have to be explained too.

Many people I know (mainly singers) don't follow this advice and therefore we have the "slow down" issue. It is really hard to follow this advice as singer, therefore most of us mute ourselves.

trebmuh commented 3 years ago

Agreed. It needs to be written here in this very page. It's not a good habit to tell users to do something without saying why, especially when it might encourage them to buy something.

ann0see commented 3 years ago

250 related. I will close this since there proposal is already on changes