diff --git a/User-Preferences.md b/User-Preferences.md index b6109bb..8bf8652 100644 --- a/User-Preferences.md +++ b/User-Preferences.md @@ -1,9 +1,9 @@ # User Preferences Editor +You can access the User Preferences editor from the main application window via the **View** menu. + The user preferences editor contains sdrtrunk application settings that the user can customize. These settings are organized by category. -You can access the User Preferences editor from the main application window via the **View** menu. - ## Audio The audio tab contains settings for audio playback, recording and call handling. @@ -110,3 +110,54 @@ button * **Calibrate** - starts the calibration process. * **Reset All Calibrations** - resets all calibrations to default (ie not calibrated) so that they can be run again. +## Decoder +![Image of the user preferences editor with the Decoder category and the JMBE Audio Library editor pane showing](images/user_preferences_jmbe.png "User Preferences Editor - JMBE Audio Library") +### JMBE Audio Library +The JMBE audio library can be used to decode digital audio frames for some decoders like APCO25 and DMR. The +sdrtrunk application bundle does not include the JMBE library. However, you can download the source code for the +JMBE library and compile it yourself and then update sdrtrunk to use that library. + +* **Current Version** - displays the current version of the library that's being used by sdrtrunk. +* **File** - file location for the user-created JMBE library. +* **Create Library** - opens a dialog to download the JMBE source code and compile the JMBE Audio Library. +* **Check For Library Updates** - checks to see if there is a newer version of the JMBE library source code. +* **Select** - allows you to select a compiled JMBE library file to use. +* **Reset** - clears the currently selected JMBE library file. +* **Alert when decoder requires missing JMBE library** - when selected, alerts you when you start a channel +with a decoder that requires the JMBE audio library to produce audio, whenever the library is missing. + +## Display +### Channel Events +* **Timestamp Format** - selects the display format for timestamps in the Events tab for a decoding channel. + +![Image of the user preferences editor with the Display category and the Talkgroup and Radio ID editor pane showing](images/user_preferences_talkgroup_radio_format.png "User Preferences Editor - Talkgroup & Radio ID Formats") +### Talkgroup & Radio ID +Select the display format for talkgroups and radio identifiers for each of the radio protocols +supported by the sdtrunk application. + +* **Decimal** - decimal (base-10) format. +* **Hexadecimal** - hexadecimal (base-16) format +* **Formatted** - custom format generally used for identifiers in that protocol. +* **Fixed Width** - formats all values to the same number of digits, using zero prefix padding as necessary. + +## File Storage +### Directories +![Image of the user preferences editor with the File Storage category and the Directories editor pane showing](images/user_preferences_file_directories.png "User Preferences Editor - File Storage Directories") +Select default or alternate file storage locations that sdtrunk uses to store file artifacts. + +* **Application Root** - the root folder for all application folders. When you change this, it changes all of +the other folder preferences to set the root for each of them. However, you can override these changes +for each of the child folders. +* **Application Logs** - application log files. +* **Configuration** - configuration files used by sdrtrunk +* **Event Logs** - event logs generated by the channel decoders when event logging is enabled. +* **JMBE Libraries** - location where sdrtrunk looks for the JMBE library on startup and the location +where the JMBE audio library will be stored when the user downloads and compiles the library. +* **PLaylists** - sdtrunk playlist directory. +* **Recordings** - folder where channel recordings, tuner wideband recordings, demodulated bit stream +recordings, and MBE frame recordings are stored. +* **Screen Captures** - storage for screen captures generated by the user. +* **Streaming** - temporary folder used for storing audio recordings awaiting streaming. + +## Source +### Tuner Channelizer diff --git a/images/user_preferences_file_directories.png b/images/user_preferences_file_directories.png new file mode 100644 index 0000000..19f1234 Binary files /dev/null and b/images/user_preferences_file_directories.png differ diff --git a/images/user_preferences_jmbe.png b/images/user_preferences_jmbe.png new file mode 100644 index 0000000..af7ab83 Binary files /dev/null and b/images/user_preferences_jmbe.png differ diff --git a/images/user_preferences_talkgroup_radio_format.png b/images/user_preferences_talkgroup_radio_format.png new file mode 100644 index 0000000..9b570be Binary files /dev/null and b/images/user_preferences_talkgroup_radio_format.png differ