V0.3.0 user manual updates

Denny
2017-02-25 06:04:37 -05:00
parent 68b903b393
commit b3960b3dff
5 changed files with 111 additions and 14 deletions

64
AudioPanel_V0.3.0.md Normal file

@@ -0,0 +1,64 @@
# Audio Panel #
The audio panel controls the audio that is played from the decoding channels to
either your computer speakers or headphones. Audio from each decoding channel
is automatically routed to the Audio Manager and the audio manager automatically
routes the highest priority audio to the speakers.
Each audio playback channel is automatically started and stopped depending on
audio availability. Playback channels use an internal buffer to store a
small number of audio frames before automatically starting playback. Therefore,
you may experience a slight delay between seeing a call start in the decoder
window and audio playback starting. Likewise, you may hear audio playing for a
short period after the decoding channel display indicates that the call has
ended.
Audio priority can be specified for each alias that you create. If you want
certain talkgroups or identifiers to have a higher priority for listening, you
can create the alias, assign the talkgroup(s) or identifier(s) and specify a
priority.
If a call is in playback over the speakers and a higher priority call comes in,
the higher priority call will be routed and the existing call audio will be
stopped.
You can override all call priorities defined in the system when you select an
individual decoding channel. Any audio produced from a selected channel is
routed with the highest priority for playback.
## Audio Playback Device ##
The default audio playback device with mono audio is selected by default. You
can change the audio playback device and choose the number of playback channels
by right-clicking on the audio panel and use the AUDIO OUTPUT menu to select a
different audio device.
## Mono Audio Playback ##
You can select mono audio playback to have any playback audio routed to both
speakers.
![](images/mono_audio_panel.png)
## Stereo Audio Playback ##
You can select stereo audio playback so that you have independent LEFT and RIGHT
audio playback over a stereo audio output. Each audio channel will be managed
by the Audio Manager and all audio produced by all decoding channels will be
routed to these two channels on a priority basis.
![](images/stereo_audio_panel.png)
## Mute Button ##
The green speaker icon on the audio panel is the master mute control. Click the
icon to mute the audio and the icon will turn red. Click again, and the audio
will unmute and the icon will turn green again.
![](images/audio_muted.png)
## Channel Menu ##
Right-click on either the MONO channel, or the LEFT or RIGHT channel to access
the context menu for the channel. You can independently mute or change the
audio volume of each channel via this context menu.
## Channel Mute ##
Each channel will show a RED M in the panel when the audio is muted either via
the master mute button, or by the channel mute context menu.

@@ -128,24 +128,42 @@ Channel C attached, then the call would be streamed to all three channels.
## Streaming Status Panel
Select the View menu at the top of the application window and click on the
Select the **View** menu at the top of the application window and click on the
**Show Streaming Status** menu item to turn on the streaming status panel at the
bottom of the application window as shown in Figure 2. This allows you to view
the 'Now Playing' window, channel details windows, and monitor your streaming
the **Now Playing**' window, channel details windows, and monitor your streaming
status at the same time. **Note:** this status panel is read-only. You can only
make changes to stream configurations in the **Streaming** tab.
## Streaming Configurations
### All Server Configurations
* **Delay** - this delays streaming of queued audio calls by the specified minutes (0-60 minutes). Calls will remain in the queue and will not be streamed until the call start time plus the delay minutes has elapsed.
* **Age Limit** - time limit for retaining audio recordings in the broadcast queue (1-60 minutes). If a call remains in the queue too long, it is automatically deleted once the call start time plus delay plus age limit has elapsed. This feature ensures that your streaming queue doesn't grow to the point that streaming will never catch up. It also ensures that what you're streaming is relatively recent audio. Note: if you see that a large number of your calls are being aged off (deleted prior to broadcast), consider changing/reducing the number of aliases that you have designated for that stream, or increase the age limit value to allow for temporary increases in activity.
* **Enabled** - enables or disables a stream. Use this check box to turn streaming on or off.
* **Save** - saves any changes you have made to the configuration. If a stream is running when you make changes, the stream will be disconnected and then recreated with the new settings.
* **Reset** - resets the editor window to the saved configuration values after you have made changes to the editor.
* **Delay** - this delays streaming of queued audio calls by the specified
minutes (0-60 minutes). Calls will remain in the queue and will not be streamed
until the call start time plus the delay minutes has elapsed.
* **Age Limit** - time limit for retaining audio recordings in the broadcast
queue (1-60 minutes). If a call remains in the queue too long, it is
automatically deleted once the call start time plus delay plus age limit has
elapsed. This feature ensures that your streaming queue doesn't grow to the
point that streaming will never catch up. It also ensures that what you're
streaming is relatively recent audio. Note: if you see that a large number of
your calls are being aged off (deleted prior to broadcast), consider
changing/reducing the number of aliases that you have designated for that
stream, or increase the age limit value to allow for temporary increases in
activity.
* **Enabled** - enables or disables a stream. Use this check box to turn
streaming on or off.
* **Save** - saves any changes you have made to the configuration. If a stream
is running when you make changes, the stream will be disconnected and then
recreated with the new settings.
* **Reset** - resets the editor window to the saved configuration values after
you have made changes to the editor.
### Broadcastify
* **Lookup ...** - click this button to lookup your stream provider details on Broadcastify and auto-configure your stream. Enter your user name and password in the dialog window. Click **Get Feeds** and then select one of the streams/feeds that appear in the list. Click **Ok**.
* **Lookup ...** - click this button to lookup your stream provider details on
Broadcastify and auto-configure your stream. Enter your user name and password
in the dialog window. Click **Get Feeds** and then select one of the
streams/feeds that appear in the list. Click **Ok**.
* **Name** - name of your feed
* **Server** - Broadcastify server URL for your feed
* **Port** - Broadcastify server port for your feed

@@ -18,12 +18,27 @@ radio systems when decoding the system control channel.
trunked radio control channels and automatically generating traffic channels for
each system.
Spectral Display
---
* [Spectral Display](SpectralDisplay_V0.3.0)
Audio Playback
---
* [Audio Panel](AudioPanel_V0.3.0)
Configuration Tabs and Views
---
* [Now Playing](NowPlaying)
* [Aliases](Aliases)
* [Channels](Channels)
* [Map](Map)
* [Streaming](Streaming)
* [Tuners](Tuner)
* [Now Playing](NowPlaying_V0.3.0)
* [Aliases](Aliases_V0.3.0)
* [Channels](Channels_V0.3.0)
* [Map](Map_V0.3.0)
* [Streaming](Streaming_V0.3.0)
* [Tuners](Tuners_V0.3.0)
Decoders
---
* [Decoders_V0.3.0]
Menu Items
---