refactor(settings): centralize preference handling and simplify dialogs

Refactored `SettingsFragment` to use `OnSharedPreferenceChangeListener` for updating the UI, replacing multiple individual listeners and custom dialog interfaces. Simplified dialog classes by removing listener callbacks and relying on direct preference storage.

- Refactored `SettingsFragment` to centralize preference updates in `onSharedPreferenceChanged`.
- Removed `LanguageSelectionDialogListener`, `PresetSelectionDialogListener`, and `ThemeSelectionDialogListener` interfaces.
- Added a fallback artwork URL for casting when station-specific images are unavailable.
- Improved `PlayerService` lifecycle management to prevent service termination during casting or remote control active states.
- Modified sleep timer logic to only cancel on explicit user-initiated pauses.
- Updated `RemoteControlServer` to manage the server instance via a companion object.
- Updated README to reflect version 15.1+ features including Android TV and Google Cast support.
- Removed redundant `pause()` call in `MediaController.play` extension.
This commit is contained in:
Michatec committed 2026-08-16 00:34:06 +02:00
1 parent 3822be2e38
commit 40b5685c8a
10 files changed
+108 -164

No files matched your search

@@ -95,6 +95,7 @@ object Keys {
const val PREF_PRESET_DRC: String = "PRESET_DRC"
const val PREF_PRESET_STEREO_WIDTH: String = "PRESET_STEREO_WIDTH"
const val PREF_LANGUAGE_SELECTED: String = "PRESET_LANGUAGE_SELECTED"
const val PREF_CUSTOM_THEME: String = "CUSTOM_THEME"
const val PREF_CUSTOM_THEME_COLOR: String = "CUSTOM_THEME_COLOR"
const val PREF_CUSTOM_THEME_ENABLED: String = "CUSTOM_THEME_ENABLED"
const val PREF_CUSTOM_THEME_INDEX: String = "CUSTOM_THEME_INDEX"
@@ -89,7 +89,6 @@ class PlayerService : MediaLibraryService(), SharedPreferences.OnSharedPreferenc
onError = { error ->
Log.e(TAG, "RemoteControlServer error: $error")
PreferencesHelper.saveRemoteControlEnabled(false)
val intent = Intent(Keys.ACTION_REMOTE_SERVER_ERROR)
LocalBroadcastManager.getInstance(this@PlayerService).sendBroadcast(intent)
}
@@ -696,15 +695,18 @@ class PlayerService : MediaLibraryService(), SharedPreferences.OnSharedPreferenc
)
if (!isPlaying) {
// cancel sleep timer
cancelSleepTimer()
// Only cancel sleep timer if user explicitly paused/stopped
if (!player.playWhenReady) {
cancelSleepTimer()
}
// reset metadata
updateMetadata()
// Check playback state to decide whether to stop the service
when (player.playbackState) {
Player.STATE_ENDED, Player.STATE_IDLE -> {
if (!PreferencesHelper.loadRemoteControlEnabled()) {
// DO NOT stop the service if we are trying to play (e.g. transitioning) or if we are currently casting
if (!player.playWhenReady && player.deviceInfo.playbackType != DeviceInfo.PLAYBACK_TYPE_REMOTE && !PreferencesHelper.loadRemoteControlEnabled()) {
stopSelf()
}
}
@@ -6,6 +6,7 @@ import android.content.ClipboardManager
import android.content.Context
import android.content.Intent
import android.content.pm.PackageManager
import android.content.SharedPreferences
import android.net.Uri
import android.os.Bundle
import android.util.Log
@@ -44,7 +45,7 @@ import java.util.Locale
/*
* SettingsFragment class
*/
class SettingsFragment : PreferenceFragmentCompat(), YesNoDialog.YesNoDialogListener, ThemeSelectionDialog.ThemeSelectionDialogListener, PresetSelectionDialog.PresetSelectionDialogListener, LanguageSelectionDialog.LanguageSelectionDialogListener {
class SettingsFragment : PreferenceFragmentCompat(), SharedPreferences.OnSharedPreferenceChangeListener, YesNoDialog.YesNoDialogListener {
/* Define log tag */
@@ -69,6 +70,89 @@ class SettingsFragment : PreferenceFragmentCompat(), YesNoDialog.YesNoDialogList
(activity as AppCompatActivity).supportActionBar?.title = getString(R.string.fragment_settings_title)
}
/* Overrides onResume from PreferenceFragmentCompat */
override fun onResume() {
super.onResume()
// register preference change listener
PreferencesHelper.registerPreferenceChangeListener(this)
}
/* Overrides onPause from PreferenceFragmentCompat */
override fun onPause() {
super.onPause()
// unregister preference change listener
PreferencesHelper.unregisterPreferenceChangeListener(this)
}
/* Overrides onSharedPreferenceChanged from SharedPreferences.OnSharedPreferenceChangeListener */
@UnstableApi
override fun onSharedPreferenceChanged(sharedPreferences: SharedPreferences?, key: String?) {
when (key) {
Keys.PREF_THEME_SELECTION -> {
val theme = PreferencesHelper.loadThemeSelection()
AppThemeHelper.setTheme(theme)
val preferenceThemeSelection = findPreference<Preference>(Keys.PREF_THEME_SELECTION)
preferenceThemeSelection?.summary = "${getString(R.string.pref_theme_selection_summary)} ${
AppThemeHelper.getCurrentTheme(activity as Context)
}"
}
Keys.PREF_PRESET_SELECTED -> {
val currentPreset = PreferencesHelper.loadSelectedPreset()
val presetPreference = findPreference<Preference>(Keys.PREF_PRESET_SELECTED)
val presetSummary = currentPreset.ifEmpty {
getString(R.string.pref_preset_none)
}
presetPreference?.summary = "${getString(R.string.pref_preset_selection_summary)}: $presetSummary"
updateEqControlStates()
}
Keys.PREF_LANGUAGE_SELECTED -> {
val languagePreference = findPreference<Preference>(Keys.PREF_LANGUAGE_SELECTED)
val languageSummary = LanguageHelper.getCurrentLanguage(activity as Context)
languagePreference?.summary = "${getString(R.string.pref_language_selection_summary)}: $languageSummary"
LanguageHelper.setLanguage(activity as Context, PreferencesHelper.loadSelectedLanguage())
}
Keys.PREF_CUSTOM_THEME_ENABLED -> {
val enabled = PreferencesHelper.loadCustomThemeEnabled()
findPreference<Preference>(Keys.PREF_CUSTOM_THEME)?.isEnabled = enabled
}
Keys.PREF_REMOTE_CONTROL_SECRET_TOKEN -> {
val preferenceRemoteControlSecret = findPreference<Preference>(Keys.PREF_REMOTE_CONTROL_SECRET_TOKEN)
preferenceRemoteControlSecret?.summary = PreferencesHelper.loadRemoteControlSecretToken()
}
Keys.PREF_REMOTE_CONTROL_ENABLED -> {
val enabled = PreferencesHelper.loadRemoteControlEnabled()
findPreference<Preference>(Keys.PREF_REMOTE_CONTROL_AUTH_ENABLED)?.isVisible = enabled
findPreference<Preference>(Keys.PREF_REMOTE_CONTROL_SECRET_TOKEN)?.isVisible = enabled && PreferencesHelper.loadRemoteControlAuthEnabled()
if (enabled) {
val intent = Intent(activity, PlayerService::class.java).apply {
action = Keys.ACTION_START
}
activity?.startService(intent)
}
}
Keys.PREF_REMOTE_CONTROL_AUTH_ENABLED -> {
findPreference<Preference>(Keys.PREF_REMOTE_CONTROL_SECRET_TOKEN)?.isVisible = PreferencesHelper.loadRemoteControlEnabled() && PreferencesHelper.loadRemoteControlAuthEnabled()
}
Keys.PREF_EDIT_STATIONS -> {
val enabled = PreferencesHelper.loadEditStationsEnabled(activity as Context)
val preferenceEnableEditingStreamUri = findPreference<MarqueeSwitchPreference>(Keys.PREF_EDIT_STREAMS_URIS)
if (!enabled) {
preferenceEnableEditingStreamUri?.isChecked = false
}
preferenceEnableEditingStreamUri?.isEnabled = enabled
}
Keys.PREF_ARGUMENTS -> {
val preferenceArguments = findPreference<EditTextPreference>(Keys.PREF_ARGUMENTS)
val currentArguments = PreferencesHelper.loadArguments()
preferenceArguments?.summary = if (currentArguments.isEmpty()) {
getString(R.string.pref_arguments_summary)
} else {
"${getString(R.string.pref_arguments_summary)}\n$currentArguments"
}
}
}
}
/* Overrides onCreatePreferences from PreferenceFragmentCompat */
@UnstableApi
override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
@@ -89,7 +173,7 @@ class SettingsFragment : PreferenceFragmentCompat(), YesNoDialog.YesNoDialogList
}"
preferenceThemeSelection.setOnPreferenceClickListener {
// show theme selection dialog
ThemeSelectionDialog(this).show(activity as Context)
ThemeSelectionDialog().show(activity as Context)
return@setOnPreferenceClickListener true
}
@@ -227,29 +311,10 @@ class SettingsFragment : PreferenceFragmentCompat(), YesNoDialog.YesNoDialogList
// regenerate secret
val newSecret = PreferencesHelper.generateSecretToken()
PreferencesHelper.saveRemoteControlSecretToken(newSecret)
preferenceRemoteControlSecret.summary = newSecret
Snackbar.make(requireView(), R.string.toastmessage_secret_regenerated, Snackbar.LENGTH_LONG).show()
return@setOnPreferenceClickListener true
}
preferenceRemoteControl.setOnPreferenceChangeListener { _, newValue ->
val enabled = newValue as Boolean
preferenceRemoteControlAuth.isVisible = enabled
preferenceRemoteControlSecret.isVisible = enabled && preferenceRemoteControlAuth.isChecked
if (enabled) {
val intent = Intent(activity, PlayerService::class.java).apply {
action = Keys.ACTION_START
}
activity?.startService(intent)
}
return@setOnPreferenceChangeListener true
}
preferenceRemoteControlAuth.setOnPreferenceChangeListener { _, newValue ->
preferenceRemoteControlSecret.isVisible = newValue as Boolean
return@setOnPreferenceChangeListener true
}
// set up "Arguments" preference
val preferenceArguments = EditTextPreference(context)
preferenceArguments.title = getString(R.string.pref_arguments_title)
@@ -263,16 +328,6 @@ class SettingsFragment : PreferenceFragmentCompat(), YesNoDialog.YesNoDialogList
"${getString(R.string.pref_arguments_summary)}\n$currentArguments"
}
preferenceArguments.setDefaultValue(currentArguments)
preferenceArguments.setOnPreferenceChangeListener { _, newValue ->
val arguments = newValue as String
preferenceArguments.summary = if (arguments.isEmpty()) {
getString(R.string.pref_arguments_summary)
} else {
"${getString(R.string.pref_arguments_summary)}\n$arguments"
}
return@setOnPreferenceChangeListener true
}
// set up "Edit Stations" preference
val preferenceEnableEditingGeneral = MarqueeSwitchPreference(context)
@@ -282,18 +337,6 @@ class SettingsFragment : PreferenceFragmentCompat(), YesNoDialog.YesNoDialogList
preferenceEnableEditingGeneral.summaryOn = getString(R.string.pref_edit_station_summary_enabled)
preferenceEnableEditingGeneral.summaryOff = getString(R.string.pref_edit_station_summary_disabled)
preferenceEnableEditingGeneral.setDefaultValue(PreferencesHelper.loadEditStationsEnabled(context))
preferenceEnableEditingGeneral.setOnPreferenceChangeListener { _, newValue ->
when (newValue) {
true -> {
preferenceEnableEditingStreamUri.isEnabled = true
}
false -> {
preferenceEnableEditingStreamUri.isEnabled = false
preferenceEnableEditingStreamUri.isChecked = false
}
}
return@setOnPreferenceChangeListener true
}
// set up "Bass Boost" preference
val preferenceBassBoost = MarqueeSwitchPreference(context)
@@ -332,7 +375,7 @@ class SettingsFragment : PreferenceFragmentCompat(), YesNoDialog.YesNoDialogList
}
preferencePresetSelection.summary = "${getString(R.string.pref_preset_selection_summary)}: $presetSummary"
preferencePresetSelection.setOnPreferenceClickListener {
PresetSelectionDialog(this).show(activity as Context)
PresetSelectionDialog().show(activity as Context)
return@setOnPreferenceClickListener true
}
@@ -451,7 +494,7 @@ class SettingsFragment : PreferenceFragmentCompat(), YesNoDialog.YesNoDialogList
LanguageHelper.getCurrentLanguage(activity as Context)
}"
preferenceLanguageSelection.setOnPreferenceClickListener {
LanguageSelectionDialog(this).show(activity as Context)
LanguageSelectionDialog().show(activity as Context)
return@setOnPreferenceClickListener true
}
@@ -459,6 +502,7 @@ class SettingsFragment : PreferenceFragmentCompat(), YesNoDialog.YesNoDialogList
val preferenceCustomTheme = Preference(context)
preferenceCustomTheme.title = getString(R.string.pref_custom_theme_title)
preferenceCustomTheme.setIcon(R.drawable.ic_rbrush_24dp)
preferenceCustomTheme.key = Keys.PREF_CUSTOM_THEME
preferenceCustomTheme.summary = getString(R.string.pref_custom_theme_summary)
preferenceCustomTheme.isEnabled = PreferencesHelper.loadCustomThemeEnabled()
preferenceCustomTheme.setOnPreferenceClickListener {
@@ -474,19 +518,6 @@ class SettingsFragment : PreferenceFragmentCompat(), YesNoDialog.YesNoDialogList
preferenceCustomThemeEnabled.summaryOff = getString(R.string.pref_custom_theme_disabled_summary)
preferenceCustomThemeEnabled.key = Keys.PREF_CUSTOM_THEME_ENABLED
preferenceCustomThemeEnabled.setDefaultValue(PreferencesHelper.loadCustomThemeEnabled())
preferenceCustomThemeEnabled.setOnPreferenceChangeListener { _, newValue ->
when (newValue) {
true -> {
// enable custom theme
preferenceCustomTheme.isEnabled = true
}
false -> {
// disable custom theme
preferenceCustomTheme.isEnabled = false
}
}
return@setOnPreferenceChangeListener true
}
// set up "Share the App" preference
val preferenceShareApp = Preference(context)
@@ -587,56 +618,6 @@ class SettingsFragment : PreferenceFragmentCompat(), YesNoDialog.YesNoDialogList
preferenceScreen = screen
}
/* Overrides onThemeSelectionDialog from ThemeSelectionDialogListener */
override fun onThemeSelectionDialog(dialogResult: Boolean, selectedTheme: String) {
if (dialogResult) {
// update summary
val themes = arrayOf(
getString(R.string.pref_theme_selection_mode_device_default),
getString(R.string.pref_theme_selection_mode_light),
getString(R.string.pref_theme_selection_mode_dark)
)
val themeValues = arrayOf(
Keys.STATE_THEME_FOLLOW_SYSTEM,
Keys.STATE_THEME_LIGHT_MODE,
Keys.STATE_THEME_DARK_MODE
)
val index = themeValues.indexOf(selectedTheme)
val preferenceThemeSelection = findPreference<Preference>(Keys.PREF_THEME_SELECTION)
preferenceThemeSelection?.summary = "${getString(R.string.pref_theme_selection_summary)} ${themes[index]}"
}
}
/* Overrides onPresetSelectionDialog from PresetSelectionDialogListener */
override fun onPresetSelectionDialog(dialogResult: Boolean, selectedPreset: String) {
if (dialogResult) {
// update summary
val presetPreference = findPreference<Preference>(Keys.PREF_PRESET_SELECTED)
val presetSummary = selectedPreset.ifEmpty {
getString(R.string.pref_preset_none)
}
presetPreference?.summary = "${getString(R.string.pref_preset_selection_summary)}: $presetSummary"
// Enable/disable manual EQ controls based on preset selection
updateEqControlStates()
}
}
/* Overrides onLanguageSelectionDialog from LanguageSelectionDialogListener */
override fun onLanguageSelectionDialog(dialogResult: Boolean, selectedLanguage: String) {
if (dialogResult) {
// update summary
val languagePreference = findPreference<Preference>(Keys.PREF_LANGUAGE_SELECTED)
val languageSummary = if (selectedLanguage.isEmpty()) {
getString(R.string.pref_language_system)
} else {
LanguageHelper.getCurrentLanguage(activity as Context)
}
languagePreference?.summary = "${getString(R.string.pref_language_selection_summary)}: $languageSummary"
}
}
/* Updates the enabled/disabled state of EQ controls based on preset selection */
private fun updateEqControlStates() {
val currentPreset = PreferencesHelper.loadSelectedPreset()
@@ -13,14 +13,7 @@ import com.michatec.radio.helpers.PreferencesHelper
/*
* LanguageSelectionDialog class
*/
class LanguageSelectionDialog(private var languageSelectionDialogListener: LanguageSelectionDialogListener) {
/* Interface used to communicate back to activity */
interface LanguageSelectionDialogListener {
fun onLanguageSelectionDialog(dialogResult: Boolean, selectedLanguage: String)
}
class LanguageSelectionDialog {
/* Main class variables */
private lateinit var dialog: AlertDialog
@@ -96,9 +89,6 @@ class LanguageSelectionDialog(private var languageSelectionDialogListener: Langu
// save language selection to preferences
PreferencesHelper.saveSelectedLanguage(selectedLanguageCode)
// notify listener
languageSelectionDialogListener.onLanguageSelectionDialog(true, selectedLanguageCode)
// dismiss dialog
dialog.dismiss()
}
@@ -106,11 +96,6 @@ class LanguageSelectionDialog(private var languageSelectionDialogListener: Langu
// set custom view
builder.setView(binding.root)
// handle outside-click as cancel
builder.setOnCancelListener {
languageSelectionDialogListener.onLanguageSelectionDialog(false, "")
}
// display dialog
dialog = builder.create()
dialog.show()
@@ -13,14 +13,7 @@ import com.michatec.radio.helpers.PreferencesHelper
/*
* PresetSelectionDialog class
*/
class PresetSelectionDialog(private var presetSelectionDialogListener: PresetSelectionDialogListener) {
/* Interface used to communicate back to activity */
interface PresetSelectionDialogListener {
fun onPresetSelectionDialog(dialogResult: Boolean, selectedPreset: String)
}
class PresetSelectionDialog {
/* Main class variables */
private lateinit var dialog: AlertDialog
@@ -56,8 +49,6 @@ class PresetSelectionDialog(private var presetSelectionDialogListener: PresetSel
}
// save preset selection to preferences
PreferencesHelper.saveSelectedPreset(selectedPreset)
// notify listener
presetSelectionDialogListener.onPresetSelectionDialog(true, selectedPreset)
// dismiss dialog
dialog.dismiss()
}
@@ -65,11 +56,6 @@ class PresetSelectionDialog(private var presetSelectionDialogListener: PresetSel
// set custom view
builder.setView(binding.root)
// handle outside-click as cancel
builder.setOnCancelListener {
presetSelectionDialogListener.onPresetSelectionDialog(false, "")
}
// display dialog
dialog = builder.create()
dialog.show()
@@ -14,15 +14,7 @@ import com.michatec.radio.helpers.PreferencesHelper
/*
* ThemeSelectionDialog class
*/
class ThemeSelectionDialog(private var themeSelectionDialogListener: ThemeSelectionDialogListener) {
/* Interface used to communicate back to activity */
interface ThemeSelectionDialogListener {
fun onThemeSelectionDialog(dialogResult: Boolean, selectedTheme: String) {
}
}
class ThemeSelectionDialog {
/* Main class variables */
private lateinit var dialog: AlertDialog
@@ -61,8 +53,6 @@ class ThemeSelectionDialog(private var themeSelectionDialogListener: ThemeSelect
PreferencesHelper.saveThemeSelection(selectedTheme)
// apply theme immediately
AppThemeHelper.setTheme(selectedTheme)
// notify listener
themeSelectionDialogListener.onThemeSelectionDialog(true, selectedTheme)
// dismiss dialog
dialog.dismiss()
}
@@ -70,11 +60,6 @@ class ThemeSelectionDialog(private var themeSelectionDialogListener: ThemeSelect
// set custom view
builder.setView(binding.root)
// handle outside-click as cancel
builder.setOnCancelListener {
themeSelectionDialogListener.onThemeSelectionDialog(false, Keys.STATE_THEME_FOLLOW_SYSTEM)
}
// display dialog
dialog = builder.create()
dialog.show()
@@ -54,7 +54,6 @@ fun MediaController.requestVisualizerData(): ListenableFuture<SessionResult> {
/* Starts playback with a new media item */
fun MediaController.play(context: Context, station: Station) {
if (isPlaying) pause()
// set media item, prepare and play
setMediaItem(CollectionHelper.buildMediaItem(context, station))
prepare()
@@ -648,6 +648,9 @@ object CollectionHelper {
// Set artwork URI for casting (remote devices need a public URL)
if (station.remoteImageLocation.isNotEmpty()) {
setArtworkUri(station.remoteImageLocation.toUri())
} else {
// Fallback: Use a public app icon for casting if the station has no image
setArtworkUri("https://raw.githubusercontent.com/michatec/Radio/master/app/src/main/assets/web/favicon.png".toUri())
}
/* check for "file://" prevents a crash when an old backup was restored */
@@ -26,10 +26,13 @@ import kotlin.time.Duration.Companion.seconds
class RemoteControlServer(private val context: Context) {
private var server: EmbeddedServer<NettyApplicationEngine, NettyApplicationEngine.Configuration>? = null
companion object {
private var server: EmbeddedServer<NettyApplicationEngine, NettyApplicationEngine.Configuration>? = null
private val lifecycleMutex = Mutex()
}
private var player: Player? = null
private var serverScope = CoroutineScope(Dispatchers.IO + SupervisorJob())
private val lifecycleMutex = Mutex()
private val gson = Gson()
private val _statusUpdates = MutableSharedFlow<WebSocketMessage>(extraBufferCapacity = 1)
private val statusUpdates = _statusUpdates.asSharedFlow()