diff --git a/src/global.h b/src/global.h index 1ff6dc2b23..3a8b2d3e80 100755 --- a/src/global.h +++ b/src/global.h @@ -104,7 +104,7 @@ LED bar: lbr // getting started and software manual URL #define CLIENT_GETTING_STARTED_URL "https://jamulus.io/wiki/Getting-Started" #define SERVER_GETTING_STARTED_URL "https://jamulus.io/wiki/Running-a-Server" -#define SOFTWARE_MANUAL_URL "https://github.com/corrados/jamulus/blob/master/src/res/homepage/manual.md" +#define SOFTWARE_MANUAL_URL "https://jamulus.io/wiki/Software-Manual" // determining server internal address uses well-known host and port // (You can change the service used here to something like Cloudflare (1.1.1.1), Google DNS (8.8.8.8), or something else reliable) diff --git a/src/res/homepage/ES/manual-es.md b/src/res/homepage/ES/manual-es.md index 101322a97e..282a2c3a6c 100644 --- a/src/res/homepage/ES/manual-es.md +++ b/src/res/homepage/ES/manual-es.md @@ -1,209 +1,5 @@ -( [en](https://github.com/corrados/jamulus/blob/master/src/res/homepage/manual.md) | es ) Ayuda para Jamulus (Manual del Software) ============================== -Ventana Principal ------------ - -![Main window](main.png) - -### LEDs de Estado - -![LEDs](led.png) - -El LED de **Estado de Retardo** muestra el estado actual del retardo de audio: - -* **Verde** - El retardo es perfecto para una jam session - -* **Amarillo** - Una sesión aún es posible pero quizá sea más difícil tocar - -* **Rojo** - El retardo es demasiado grande para tocar - -**Buffers** muestra el estado actual del flujo de audio. Si está **rojo**, hay interrupciones en el flujo de audio. Esto puede ser causado por alguno de los siguientes problemas: - -- El jitter buffer de red no es lo suficientemente grande para el jitter actual de la red/interfaz de audio. -- El retardo de buffer de la tarjeta de audio (tamaño buffer) tiene un valor demasiado bajo (ver ventana de Configuración). -- La tasa de subida o bajada is demasiado alta para tu ancho de banda de internet. -- El procesador del cliente o del servidor está al 100%. - -### Nivel de entrada - -![Input level](inputlevel.png) - -Esto muestra los niveles de los dos canales estéreo de tu entrada de audio. -Asegúrate de no clipear la señal de entrada para evitar distorsiones de la señal de audio (los LEDs indicarán el clipeo cuando suceda). - - - -### Botón de chat - -![Chat dialog](chat.png) - -El texto escrito en la ventana del chat es enviado a todos los clientes conectados. Si llega un nuevo mensaje de chat y la venta no está abierta, se abrirá automáticamente para todos los clientes. - -### Ventana de perfil - -![My profile dialog](profile.png) - -Desde el menú de Ver, selecciona Mi Perfil... para establecer tu Alias/Nombre, mostrado debajo de tu fader en la ventana principal del cliente de Jamulus. Si se establece un instrumento y/o un país, los iconos de estas selecciones también se mostrarán bajo tu fader. El nivel de habilidad cambia el color de fondo de la etiqueta del fader y la ciudad se muestra en el tooltip de la etiqueta (ver pantallazo abajo). - -![Fader tag tool tip](fadertagtooltip.png) - -### Botón Conexión/Desconexión - -Abre una ventana donde puedes seleccionar un servidor. Si estás conectado, pulsar este botón finalizará la sesión. - -![Connect dialog](connect.png) - -La ventana de Configuración de Conexión muestra una lista de servidores disponibles junto con el número de usuarios conectados y el número máximo de los mismos soportado. Los operadores de servidores pueden, opcionalmente, listar su servidor por género musical. Utiliza el menú desplegable de Lista para elegir un género, haz clic sobre el servidor al que te quieres unir y otra vez sobre el botón de Conectar para conectarte. También puedes hacer doble clic sobre el nombre del servidor. Los servidores permanentes (aquellos que llevan más de 24 horas en la lista) se muestran en negrita. - -Puedes filtrar la lista por nombre de servidor o ubicación. Para solo mostrar los servidores ocupados, escribe el caracter "#". - -Si conoces la dirección IP o URL de un servidor, puedes conectarte a él utilizando el campo de Nombre/Dirección del Servidor. Se puede añadir un número de puerto opcional tras la dirección IP o URL utilizando dos puntos como separador, por ej. -jamulus.dyndns.org:22124. El campo también mostrará una lista de los servidores utilizados recientemente. - -### Botón de Silenciarme Yo - -Corta tu flujo de audio al servidor de modo que te escucharás y verás tus propios niveles de audio, pero otros músicos no. Ten en cuenta que otros músicos no sabrán si te has silenciado. - -### Efecto Reverb - -![Reverberation](reverberation.png) - -Se puede aplicar un efecto de reverberación a un canal local de audio mono o a ambos canales en modo estéreo. Se puede modificar la selección de canales en modo mono y el nivel de reverberación. Por ejemplo, si la señal del micrófono va por el canal derecho de la tarjeta de audio y se desea aplicar reverberación, cambia el selector de canal a derecho y sube el fader hasta alcanzar el nivel de reverberación deseado. - -### Control local de paneo / balance - -Control local de paneo / balance - -Controla los niveles relativos de los canales locales de audio derecho e izquierdo. Para una señal mono actúa como paneo entre los dos canales. Por ejemplo, si se conecta un miocrófono al canal derecho y un instrumento al izquierdo que suena mucho más alto que el micrófono, mueve el fader en una dirección donde la etiqueta sobre el fader muestra L -x, donde x es el indicador de atenuación actual. - -### Mezclador de audio del servidor - -![Audio faders](faders.png) - -En la ventana del mezclador de audio, se muestra un fader para cada cliente conectado al servidor (incluyéndote a ti). -Los faders te permiten ajustar el nivel de lo que escuchas sin afectar a lo que escuchan los demás. - -El vúmetro muestra el nivel de entrada en el servidor - esto es, el sonido enviado. - -Si has configurado tu Canal de Audio a Estéreo o Salida Estéreo en tu Configuración, también verás un control de paneo. - -Si ves un icono de "silenciado" sobre un canal, significa que ese músico no puede escucharte. Puede que te hayan silenciado, aplicado 'solo' a uno o más canales sin incluir el tuyo, o han bajado tu fader en su mezcla a cero. - -Utilizar el **botón de Mute** evita que el canal indicado se escuche en tu mezcla local. Ten en cuenta que cuando muteas a un músico, verán un icono de "silenciado" sobre tu fader para indicar que no puedes escucharle. Ten en cuenta también que continuarás viendo mover su vúmetro si el sonido del músico muteado llega al servidor. La posición del fader para ellos en tu mezcla no se verá afectada. - -El **botón de Solo** te permite escuchar uno o más músicos asilados de los demás. Los que no lo tengan aplicado estarán silenciados. Ten en cuenta que aquellos músicos que no lo tienen aplicado verán el icono de "silenciado" sobre tu fader. - -Los canales se muestran de izquierda a derecha en el orden en el que se conectan los clientes hasta que se marchan, momento en el cual su "posición" es ocupada por cada nueva conexión. Puedes cambiar el orden utilizando la opción Editar en el menú de la aplicación. - -Puedes agrupar faders utilizando el botón de "grupo" (GRP). Si mueves el fader de cualquier miembro del grupo, los demás del grupo también se moverán en la misma proporción. - -Si el operador del servidor ha habilitado la grabación, verás un mensaje sobre el mezclador indicando que estás siendo grabado. - - - -Ventana de Configuración ---------------- - -![Settings](settings.png) - -### Dispositivo de Audio - -![Sound card device Windows](soundcarddevicewindows.png) -![Sound card device Mac](soundcarddevicemac.png) - -El driver ASIO (tarjeta de audio) se puede seleccionar utilizando Jamulus en el sistema operativo Windows. Si el driver ASIO no es válido se mostrará un mensaje de error y el anterior driver válido será seleccionado. En Mac, se puede seleccionar el hardware de entrada y salida. - -### Mapeo canales entrada/salida - -![Channel mapping](channelmapping.png) - -Si el dispositivo de audio ofrece más de un canal de entrada o salida, son visibles las configuraciones para el _Mapeo de Canales de Entrada y de Salida_. Para cada canal de entrada/salida (canal Izquierdo y Derecho) de Jamulus se puede seleccionar un canal diferente de la tarjeta de audio. - -### Activar Buffers de Red Pequeños - -Permite soporte para paquetes de audio por red muy reducidos. Solo se utilizan si el retardo del buffer de la tarjeta de audio es menor de 128 muestras. Cuanto menores los buffers de red, menor la latencia de audio. Pero al mismo tiempo, aumenta la carga de red y la probabilidad de caídas de audio también aumenta. - -### Retardo de Buffer - -![Buffer delay](bufferdelay.png) - -El retardo de buffer es un parámetro fundamental en Jamulus. Este parámetro tiene un impacto sobre muchas propiedades de la conexión. Hay soporte para tres tamaños de buffer: - -- 64 muestras: Es la configuración aconsejada puesto que ofrece la latencia más baja, aunque no funciona con todas las tarjetas de audio. -- 128 muestras: Debería de funcionar con la mayoría de tarjetas de audio. -- 256 samples: Solo debería usarse con un ordenador muy lento o con una conexión a internet muy lenta. - -Algunos drivers de tarjetas de audio no permiten cambiar el retardo de buffer desde dentro de Jamulus. En este caso la configuración del retardo de buffer se deshabilita y hay que cambiarlo utilizando el driver de la tarjeta de audio. En Windows, pulsa el botón de Configuración ASIO para acceder al panel de configuración. - -![Buffer delay Windows](bufferdelaywindows.png) - -En Linux, utiliza la herramienta de configuración de Jack para cambiar el tamaño del buffer. - -El retardo del buffer tiene un impacto en el estado de la conexión, la tasa de subida y el retardo total. Cuanto menor sea el buffer, mayor la probabilidad de que el indicador de estado esté en rojo (caídas de audio), mayor la tasa de subida y menor el retardo total. - -![Buffer delay dependencies](bufferdelaydependency.png) - -Por tanto la configuración del buffer es un compromiso entre calidad de audio y retardo total. - -### Jitter buffer con indicador del estado del buffer - -![Jitter buffer](jitterbuffer.png) - -El jitter buffer compensa el jitter de la red y la tarjeta de audio. El tamaño de este buffer tiene por tanto un impacto sobre la calidad del flujo de audio (el número de caídas de la señal) y el retardo total (a mayor buffer, mayor retardo). - -El tamaño del jitter buffer se puede establecer manualmente para el cliente local y para el servidor remoto. Para el jitter buffer local, las caídas del flujo de audio se indican mediante la luz debajo de los faders del jitter buffer. Si la luz se vuelve roja, significa que ha habido una interrupción del flujo de audio. - -Por tanto la configuración del jitter buffer es un compromiso entre calidad y retardo total. - -Si se activa la casilla de Auto, los jitter buffers del cliente local y del servidor remoto se configuran automáticamente basándose en mediciones del jitter de la red y la tarjeta de audio. Si se activa esta opción, los faders quedan deshabilitados (no pueden moverse con el ratón). - -### Canales de Audio - -![Audio channels](audiochannels.png) - -Selecciona el número de canales de audio a utilizar para la comunicación entre cliente y servidor. Hay tres modos disponibles: - -Los modos Mono y Estéreo utilizan uno y dos canales de audio respectivamente. - -Entrada-mono/Salida-estéreo: La señal de audio enviada al servidor es mono pero la señal que vuelve es estéreo. Esto es útil si la tarjeta de audio tiene un instrumento en un canal de entrada y un micrófono en el otro. En ese caso las dos señales de entrada pueden combinarse en un canal mono pero la mezcla del servidor se escucha en estéreo. - -Activar el modo estéreo aumentará la tasa de envío de datos. Asegúrate de que la tasa de subida no excede el ancho de banda disponible en tu conexión a internet. - -En el caso del modo estéreo, no estará disponible la selección de canal para el efecto de reverb en la ventana principal puesto que en este caso el efecto se aplicará a ambos canales. - -### Calidad del Audio - -![Audio quality](audioquality.png) - -Cuanto mayor la calidad del audio, mayor la tasa de subida del audio. Asegúrate de que tu tasa de subida no excede el ancho de banda de tu conexión a Internet. - -### Nivel cliente nuevo - -![New client level](newclientlevel.png) - -Este ajuste define el nivel del fader de una nueva conexión de cliente, en porcentaje. Si se conecta un nuevo cliente al servidor actual, el nivel inicial de su fader tomará este valor si no se ha especificado anteriormente un valor para ese cliente de una conexión anterior. - -### Interfaz oscura - -![Fancy skin](fancyskin.png) - -Esto aplicará un aspecto oscuro a la ventana principal. - -### Dirección personalizada del servidor central - -![Central server address](centralserveraddress.png) - -Deja esto en blanco a menos que necesites escribir la dirección de un servidor distinto a los que hay por defecto. - -### Parámetro de estado de conexión actual - -![Indicators](indicators.png) - -El Ping es el tiempo que requiere el flujo de audio para viajar desde el cliente al servidor y volver. Este retardo lo determina la red y debería ser de unos 20-30 ms. Si este retardo es mayor de unos 50 ms, la distancia al servidor es demasiado grande o tu conexión a internet no es óptima. - -El retardo total se calcula con el ping y el retardo ocasionado por la configuración de buffers. - -La Tasa de Subida de Audio depende del tamaño actual de los paquetes de audio y la configuración de compresión de audio. Asegúrate de que la tasa de subida no es mayor que la velocidad de subida disponible (comprueba la tasa de subida de tu conexión a internet, por ejemplo con [speedtest.net](http://speedtest.net)). +## Movido a https://jamulus.io/es/wiki/Software-Manual diff --git a/src/res/homepage/manual.md b/src/res/homepage/manual.md index bbf9049b53..9e4afe4b1d 100644 --- a/src/res/homepage/manual.md +++ b/src/res/homepage/manual.md @@ -1,247 +1,5 @@ -( en | [es](https://github.com/corrados/jamulus/blob/master/src/res/homepage/ES/manual-es.md) ) - Jamulus Help (Software Manual) ============================== -Main Window ------------ - -![Main window](main.png) - -### Status LEDs - -![LEDs](led.png) - -The **Delay Status** LED shows the current audio delay status: - -* **Green** - The delay is perfect for a jam session - -* **Yellow** - A session is still possible but it may be harder to play - -* **Red** - The delay is too large for jamming - -**Buffers** shows the current audio/streaming status. If the light is **red**, the audio stream is interrupted. This is caused by one of the following problems: - -- The network jitter buffer is not large enough for the current network/audio interface jitter. -- The sound card's buffer delay (buffer size) is too small (see Settings window). -- The upload or download stream rate is too high for your internet bandwidth. -- The CPU of the client or server is at 100%. - -### Input level - -![Input level](inputlevel.png) - -This shows the level of the two stereo channels for your audio input. -Make sure not to clip the input signal to avoid distortions of the audio signal (the LEDs will indicate clipping when it occurs). - - - -### Chat button - -![Chat dialog](chat.png) - -The chat text entered in that dialog is sent to -all connected clients. If a new chat message arrives and the Chat dialog is not already open, it will -opened automatically for all clients. - -### Profile window - -![My profile dialog](profile.png) - -From the View menu, select My Profile... to set your Alias/Name -which is displayed below your fader in the server audio mixer board. If an instrument and/or country is set, -icons for these selections will also be shown below your fader. The skill setting changes the background colour of -the fader tag and the city entry shows up in the tool tip of the fader tag (see screenshot below). - -![Fader tag tool tip](fadertagtooltip.png) - -### Connect/disconnect button - -Opens a dialog where you can select a server to connect to. If you are connected, -pressing this button will end the session. - -![Connect dialog](connect.png) - -The Connection Setup window shows a list of available servers together with the number of occupants and the maxmium number supported. Server operators can optionally list their servers by musical genre. Use the List dropdown to select a genre, click on the server you want to join and press the Connect button to connect to it. Alternatively, double-click on the server name. Permanent servers (those that have been listed for longer than 24 hours) are shown in bold. - -You can filter the list by server name or location. To list only occupied servers, enter a "#" character. - -If you know the IP address or URL of a server, you can connect to it using the Server Name/Address -field. An optional port number can be added after the IP address or URL using a colon as a separator, e.g, -jamulus.dyndns.org:22124. The field will also show a list of the most recently used server addresses. - -### Mute Myself button - -Cuts your audio stream to the server so that you will be able to hear yourself and see your own input levels, but other musicians will not. Be aware that other musicians will not know if you have muted yourself. - -### Reverb effect - -![Reverberation](reverberation.png) - -Reverb can be applied to one local mono audio channel or to both channels in stereo mode. -The mono channel selection and the reverberation level can be modified. For example, if a microphone signal is fed -in to the right audio channel of the sound card and a reverb effect needs to be applied, set the channel selector -to the right and move the fader upwards until the desired reverb level is reached. - -### Local audio pan / balance control - -![Local audio pan / balance control](audiofader.png) - -Controls the relative levels of the left and right local audio channels. For a mono signal -it acts as a pan between the two channels. For example, if a microphone is connected to the right input channel and -an instrument is connected to the left input channel which is much louder than the microphone, move the audio fader -in a direction where the label above the fader shows L -x, where x is the current attenuation indicator. - -### Server audio mixer - -![Audio faders](faders.png) - -In the audio mixer frame, a fader is shown for each connected client at the server (including yourself). -The faders allow you to adjust the level of what you hear without affecting what others hear. - -The VU meter shows the input level at the server - that is, the sound being sent. - -If you have set your Audio Channel to Stereo or Stereo Out in your Settings, you will also see a pan control. - -If you see a "mute" icon above a channel, it means that musician cannot hear you. Either they have muted you, soloed one or more channels not including yours, or have set your fader in their mix to zero. - -Using the **Mute button** prevents the indicated channel being heard in your local mix. Be aware that when you mute a musician, they will see a "muted" icon above your fader to indicate that you cannot hear them. Note also that you will continue to see their VU meters moving if sound from the muted musician is reaching the server. Your fader position for them is also unaffected. - -The **Solo button** allows you to hear one or more musicians on their own. Those not soloed will be muted. Note also that those musicians who are not soloed will see a "muted" icon above your fader. - -Channels are listed left to right in the order that clients connect until they leave, at which point their "slot" is filled by the next new arrival. You can change the sort order using the Edit option in the application menu. - -You can group faders together using the "group" toggle. Moving the fader of any member of the group will move the other faders in that group by the same amount. - -If the server operator has enabled recording, you will see a message above the mixer showing that you are being recorded. - - - -Settings Window ---------------- - -![Settings](settings.png) - -### Sound card device - -![Sound card device Windows](soundcarddevicewindows.png) -![Sound card device Mac](soundcarddevicemac.png) - -The ASIO driver (sound card) can be selected using Jamulus under the Windows operating system. If the selected ASIO -driver is not valid an error message is shown and the previous valid driver is selected. Under the Mac operating -system the input and output hardware can be selected. - -### Input/output channel mapping - -![Channel mapping](channelmapping.png) - -If the selected sound card device offers more than one input or output channel, the _Input Channel Mapping -and Output Channel Mapping_ settings are visible. For each Jamulus input/output channel (left and right channel) -a different actual sound card channel can be selected. - -### Enable small network buffers - -Allows support for very small network audio packets. These are only used if the sound card buffer delay is smaller than 128 samples. The smaller the network buffers, the -lower the audio latency. But at the same time the network load increases and the probability of audio dropouts -also increases. - -### Buffer delay - -![Buffer delay](bufferdelay.png) - -The buffer delay setting is a fundamental setting of the Jamulus software. This setting has an influence on many -connection properties. Three buffer sizes are supported: - -- 64 samples: The preferred setting. Provides the lowest latency but does not work with all sound cards. -- 128 samples: Should work for most available sound cards. -- 256 samples: Should only be used on very slow computers, or with a slow internet connection. - -Some sound card drivers do not allow the buffer delay to be changed from within the Jamulus software. -In this case the buffer delay setting is disabled and has to be changed using the sound card driver. On Windows, press the ASIO Setup button to open the driver settings panel. - -![Buffer delay Windows](bufferdelaywindows.png) - -On Linux, use the Jack configuration tool to change the buffer size. - -The actual buffer delay has influence on the connection status, the current upload rate and the overall delay. -The lower the buffer size, the higher the probability of a red light in the status indicator (drop outs) and the -higher the upload rate and the lower the overall delay. - -![Buffer delay dependencies](bufferdelaydependency.png) - -The buffer setting is therefore a trade-off between audio quality and overall delay. - -### Jitter buffer with buffer status indicator - -![Jitter buffer](jitterbuffer.png) - -The jitter buffer compensates for network and sound card timing jitters. The size of the buffer -therefore influences the quality of the audio stream (how many dropouts occur) and the overall delay -(the longer the buffer, the higher the delay). - -You can set the jitter buffer size manually for the local client and the remote server. For the local jitter -buffer, dropouts in the audio stream are indicated by the light below the jitter buffer size faders. -If the light turns to red, a buffer overrun/underrun has taken place and the audio stream is interrupted. - -The jitter buffer setting is therefore a trade-off between audio quality and overall delay. - -If the Auto setting is enabled, the jitter buffers -of the local client and the remote server are set automatically based on measurements of the network and sound card -timing jitter. If the Auto check is enabled, the jitter buffer size faders are disabled (they cannot be moved with the mouse). - -### Audio channels - -![Audio channels](audiochannels.png) - -Selects the number of audio channels to be used for communication between client and server. There are three modes -available: - -Mono and Stereo modes use one and two audio channels respectively. - -Mono-in/Stereo-out: The audio signal sent to the server is mono but the return signal is stereo. This is useful if the sound card has the instrument on one input channel and the microphone on the other. In that case -the two input signals can be mixed to one mono channel but the server mix is heard in stereo. - -Enabling stereo mode will increase your stream's data rate. Make sure your upload rate does -not exceed the available upload speed of your internet connection. - -In stereo streaming mode, no audio channel selection for the reverb effect will be available on -the main window since the effect is applied to both channels in this case. - -### Audio quality - -![Audio quality](audioquality.png) - -The higher the audio quality, the higher your audio stream's data rate. Make sure your upload rate does not exceed the available upload speed of your internet connection. - -### New client level - -![New client level](newclientlevel.png) - -This setting defines the fader level of a newly connected client in percent. If a new musician connects -to the current server, they will get the specified initial fader level if no other fader level from a previous connection of -that client was already stored. - -### Fancy skin - -![Fancy skin](fancyskin.png) - -This applies a fancy skin to the main window. - -### Custom central server address - -![Central server address](centralserveraddress.png) - -Leave this blank unless you need to enter the address of a central server other than the default. - -### Current connection status parameter - -![Indicators](indicators.png) - -The Ping Time is the time required for the audio stream to travel from the client to the server and back again. -This delay is introduced by the network and should about 20-30ms. If this delay is higher than about 50ms, -your distance to the server is too large or your internet connection is not sufficient. - -Overall Delay is calculated from the current Ping Time and the delay introduced by the current buffer settings. +## The manual has moved to https://jamulus.io/wiki/Software-Manual -Audio Upstream Rate depends on the current audio packet size and compression setting. Make sure that the upstream -rate is not higher than your available internet upload speed (check this with a service such as [speedtest.net](http://speedtest.net)).