2023-11-11 13:41:20 +00:00
|
|
|
<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Source: components/settings/settings.bs</title><!--[if lt IE 9]>
|
|
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
2023-12-05 16:56:00 +00:00
|
|
|
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(baseURL=(baseURL="https://jellyfin.github.io/jellyfin-roku/").replace(/https?:\/\//i,"")).substr(baseURL.indexOf("/"))</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d=
|
2023-11-11 02:08:52 +00:00
|
|
|
import "pkg:/source/utils/misc.bs"
|
2023-10-06 03:18:36 +00:00
|
|
|
import "pkg:/source/roku_modules/log/LogMixin.brs"
|
2023-11-11 00:30:32 +00:00
|
|
|
' post device profile
|
2023-11-11 02:08:52 +00:00
|
|
|
import "pkg:/source/utils/deviceCapabilities.bs"
|
2023-10-06 03:18:36 +00:00
|
|
|
|
|
|
|
sub init()
|
|
|
|
m.log = log.Logger("Settings")
|
|
|
|
m.top.optionsAvailable = false
|
|
|
|
|
|
|
|
m.userLocation = []
|
|
|
|
|
|
|
|
m.settingsMenu = m.top.findNode("settingsMenu")
|
|
|
|
m.settingDetail = m.top.findNode("settingDetail")
|
|
|
|
m.settingDesc = m.top.findNode("settingDesc")
|
|
|
|
m.path = m.top.findNode("path")
|
|
|
|
|
|
|
|
m.boolSetting = m.top.findNode("boolSetting")
|
|
|
|
m.integerSetting = m.top.findNode("integerSetting")
|
|
|
|
m.radioSetting = m.top.findNode("radioSetting")
|
|
|
|
|
|
|
|
m.integerSetting.observeField("submit", "onKeyGridSubmit")
|
|
|
|
m.integerSetting.observeField("escape", "onKeyGridEscape")
|
|
|
|
|
|
|
|
m.settingsMenu.setFocus(true)
|
|
|
|
m.settingsMenu.observeField("itemFocused", "settingFocused")
|
|
|
|
m.settingsMenu.observeField("itemSelected", "settingSelected")
|
|
|
|
|
|
|
|
m.boolSetting.observeField("checkedItem", "boolSettingChanged")
|
|
|
|
m.radioSetting.observeField("checkedItem", "radioSettingChanged")
|
|
|
|
|
2023-11-11 00:30:32 +00:00
|
|
|
m.postTask = createObject("roSGNode", "PostTask")
|
|
|
|
|
2023-10-06 03:18:36 +00:00
|
|
|
' Load Configuration Tree
|
|
|
|
m.configTree = GetConfigTree()
|
|
|
|
LoadMenu({ children: m.configTree })
|
|
|
|
end sub
|
|
|
|
|
|
|
|
sub onKeyGridSubmit()
|
|
|
|
selectedSetting = m.userLocation.peek().children[m.settingsMenu.itemFocused]
|
|
|
|
set_user_setting(selectedSetting.settingName, m.integerSetting.text)
|
|
|
|
m.settingsMenu.setFocus(true)
|
|
|
|
end sub
|
|
|
|
|
|
|
|
sub onKeyGridEscape()
|
|
|
|
if m.integerSetting.escape = "left" or m.integerSetting.escape = "back"
|
|
|
|
m.settingsMenu.setFocus(true)
|
|
|
|
end if
|
|
|
|
end sub
|
|
|
|
|
|
|
|
sub LoadMenu(configSection)
|
|
|
|
if configSection.children = invalid
|
|
|
|
' Load parent menu
|
|
|
|
m.userLocation.pop()
|
|
|
|
configSection = m.userLocation.peek()
|
|
|
|
else
|
|
|
|
if m.userLocation.Count() > 0 then m.userLocation.peek().selectedIndex = m.settingsMenu.itemFocused
|
|
|
|
m.userLocation.push(configSection)
|
|
|
|
end if
|
|
|
|
|
|
|
|
result = CreateObject("roSGNode", "ContentNode")
|
|
|
|
|
|
|
|
for each item in configSection.children
|
|
|
|
listItem = result.CreateChild("ContentNode")
|
|
|
|
listItem.title = tr(item.title)
|
|
|
|
listItem.Description = tr(item.description)
|
|
|
|
listItem.id = item.id
|
|
|
|
end for
|
|
|
|
|
|
|
|
m.settingsMenu.content = result
|
|
|
|
|
|
|
|
if configSection.selectedIndex <> invalid and configSection.selectedIndex > -1
|
|
|
|
m.settingsMenu.jumpToItem = configSection.selectedIndex
|
|
|
|
end if
|
|
|
|
|
|
|
|
' Set Path display
|
|
|
|
m.path.text = tr("Settings")
|
|
|
|
for each level in m.userLocation
|
|
|
|
if level.title <> invalid then m.path.text += " / " + tr(level.title)
|
|
|
|
end for
|
|
|
|
end sub
|
|
|
|
|
|
|
|
sub settingFocused()
|
|
|
|
|
|
|
|
selectedSetting = m.userLocation.peek().children[m.settingsMenu.itemFocused]
|
|
|
|
m.settingDesc.text = tr(selectedSetting.Description)
|
|
|
|
m.top.overhangTitle = tr(selectedSetting.Title)
|
|
|
|
|
|
|
|
' Hide Settings
|
|
|
|
m.boolSetting.visible = false
|
|
|
|
m.integerSetting.visible = false
|
|
|
|
m.radioSetting.visible = false
|
|
|
|
|
|
|
|
if selectedSetting.type = invalid
|
|
|
|
return
|
|
|
|
else if selectedSetting.type = "bool"
|
|
|
|
|
|
|
|
m.boolSetting.visible = true
|
|
|
|
|
|
|
|
if m.global.session.user.settings[selectedSetting.settingName] = true
|
|
|
|
m.boolSetting.checkedItem = 1
|
|
|
|
else
|
|
|
|
m.boolSetting.checkedItem = 0
|
|
|
|
end if
|
|
|
|
else if selectedSetting.type = "integer"
|
|
|
|
integerValue = m.global.session.user.settings[selectedSetting.settingName].ToStr()
|
|
|
|
if isValid(integerValue)
|
|
|
|
m.integerSetting.text = integerValue
|
|
|
|
end if
|
|
|
|
m.integerSetting.visible = true
|
|
|
|
else if LCase(selectedSetting.type) = "radio"
|
|
|
|
|
|
|
|
selectedValue = m.global.session.user.settings[selectedSetting.settingName]
|
|
|
|
|
|
|
|
radioContent = CreateObject("roSGNode", "ContentNode")
|
|
|
|
|
|
|
|
itemIndex = 0
|
|
|
|
for each item in m.userLocation.peek().children[m.settingsMenu.itemFocused].options
|
|
|
|
listItem = radioContent.CreateChild("ContentNode")
|
|
|
|
listItem.title = tr(item.title)
|
|
|
|
listItem.id = item.id
|
|
|
|
if selectedValue = item.id
|
|
|
|
m.radioSetting.checkedItem = itemIndex
|
|
|
|
end if
|
|
|
|
itemIndex++
|
|
|
|
end for
|
|
|
|
|
|
|
|
m.radioSetting.content = radioContent
|
|
|
|
|
|
|
|
m.radioSetting.visible = true
|
|
|
|
else
|
|
|
|
m.log.warn("Unknown setting type", selectedSetting.type)
|
|
|
|
end if
|
|
|
|
|
|
|
|
end sub
|
|
|
|
|
|
|
|
|
|
|
|
sub settingSelected()
|
|
|
|
|
|
|
|
selectedItem = m.userLocation.peek().children[m.settingsMenu.itemFocused]
|
|
|
|
|
|
|
|
if selectedItem.type <> invalid ' Show setting
|
|
|
|
if selectedItem.type = "bool"
|
|
|
|
m.boolSetting.setFocus(true)
|
|
|
|
end if
|
|
|
|
if selectedItem.type = "integer"
|
|
|
|
m.integerSetting.setFocus(true)
|
|
|
|
end if
|
|
|
|
if (selectedItem.type) = "radio"
|
|
|
|
m.radioSetting.setFocus(true)
|
|
|
|
end if
|
|
|
|
else if selectedItem.children <> invalid and selectedItem.children.Count() > 0 ' Show sub menu
|
|
|
|
LoadMenu(selectedItem)
|
|
|
|
m.settingsMenu.setFocus(true)
|
|
|
|
else
|
|
|
|
return
|
|
|
|
end if
|
|
|
|
|
|
|
|
m.settingDesc.text = m.settingsMenu.content.GetChild(m.settingsMenu.itemFocused).Description
|
|
|
|
|
|
|
|
end sub
|
|
|
|
|
|
|
|
|
|
|
|
sub boolSettingChanged()
|
|
|
|
if m.boolSetting.focusedChild = invalid then return
|
|
|
|
selectedSetting = m.userLocation.peek().children[m.settingsMenu.itemFocused]
|
|
|
|
|
|
|
|
if m.boolSetting.checkedItem
|
|
|
|
session.user.settings.Save(selectedSetting.settingName, "true")
|
|
|
|
if Left(selectedSetting.settingName, 7) = "global."
|
|
|
|
' global user setting
|
|
|
|
' save to main registry block
|
|
|
|
set_setting(selectedSetting.settingName, "true")
|
|
|
|
' setting specific triggers
|
|
|
|
if selectedSetting.settingName = "global.rememberme"
|
|
|
|
print "m.global.session.user.id=", m.global.session.user.id
|
|
|
|
set_setting("active_user", m.global.session.user.id)
|
|
|
|
end if
|
|
|
|
else
|
|
|
|
' regular user setting
|
|
|
|
' save to user specific registry block
|
|
|
|
set_user_setting(selectedSetting.settingName, "true")
|
|
|
|
end if
|
|
|
|
else
|
|
|
|
session.user.settings.Save(selectedSetting.settingName, "false")
|
|
|
|
if Left(selectedSetting.settingName, 7) = "global."
|
|
|
|
' global user setting
|
|
|
|
' save to main registry block
|
|
|
|
set_setting(selectedSetting.settingName, "false")
|
|
|
|
' setting specific triggers
|
|
|
|
if selectedSetting.settingName = "global.rememberme"
|
|
|
|
unset_setting("active_user")
|
|
|
|
end if
|
|
|
|
else
|
|
|
|
' regular user setting
|
|
|
|
' save to user specific registry block
|
|
|
|
set_user_setting(selectedSetting.settingName, "false")
|
|
|
|
end if
|
|
|
|
end if
|
|
|
|
end sub
|
|
|
|
|
|
|
|
sub radioSettingChanged()
|
|
|
|
if m.radioSetting.focusedChild = invalid then return
|
|
|
|
selectedSetting = m.userLocation.peek().children[m.settingsMenu.itemFocused]
|
|
|
|
set_user_setting(selectedSetting.settingName, m.radioSetting.content.getChild(m.radioSetting.checkedItem).id)
|
|
|
|
end sub
|
|
|
|
|
2023-11-11 00:30:32 +00:00
|
|
|
' JFScreen hook that gets ran as needed.
|
|
|
|
' Assumes settings were changed and they affect the device profile.
|
|
|
|
' Posts a new device profile to the server using the task thread
|
|
|
|
sub OnScreenHidden()
|
|
|
|
m.postTask.arrayData = getDeviceCapabilities()
|
|
|
|
m.postTask.apiUrl = "/Sessions/Capabilities/Full"
|
|
|
|
m.postTask.control = "RUN"
|
|
|
|
m.postTask.observeField("responseCode", "postFinished")
|
|
|
|
end sub
|
|
|
|
|
|
|
|
' Triggered by m.postTask after completing a post.
|
|
|
|
' Empty the task data when finished.
|
|
|
|
sub postFinished()
|
|
|
|
m.postTask.unobserveField("responseCode")
|
|
|
|
m.postTask.callFunc("empty")
|
|
|
|
end sub
|
|
|
|
|
2023-10-31 21:04:13 +00:00
|
|
|
' Returns true if any of the data entry forms are in focus
|
|
|
|
function isFormInFocus() as boolean
|
|
|
|
if isValid(m.settingDetail.focusedChild) or m.radioSetting.hasFocus() or m.boolSetting.hasFocus() or m.integerSetting.hasFocus()
|
|
|
|
return true
|
|
|
|
end if
|
|
|
|
return false
|
|
|
|
end function
|
|
|
|
|
2023-10-06 03:18:36 +00:00
|
|
|
function onKeyEvent(key as string, press as boolean) as boolean
|
|
|
|
if not press then return false
|
|
|
|
|
|
|
|
if (key = "back" or key = "left") and m.settingsMenu.focusedChild <> invalid and m.userLocation.Count() > 1
|
|
|
|
LoadMenu({})
|
|
|
|
return true
|
2023-10-31 21:04:13 +00:00
|
|
|
else if (key = "back" or key = "left") and isFormInFocus()
|
2023-10-06 03:18:36 +00:00
|
|
|
m.settingsMenu.setFocus(true)
|
|
|
|
return true
|
|
|
|
end if
|
|
|
|
|
|
|
|
if key = "options"
|
|
|
|
m.global.sceneManager.callFunc("popScene")
|
|
|
|
return true
|
|
|
|
end if
|
|
|
|
|
|
|
|
if key = "right"
|
|
|
|
settingSelected()
|
|
|
|
end if
|
|
|
|
|
|
|
|
return false
|
|
|
|
end function
|
2023-12-05 16:56:00 +00:00
|
|
|
</code></pre></article></section><footer class="footer" id="PeOAagUepe"><div class="wrapper"><span class="jsdoc-message">Automatically generated using <a href="https://github.com/jsdoc/jsdoc" target="_blank">JSDoc</a> and the <a href="https://github.com/ankitskvmdam/clean-jsdoc-theme" target="_blank">clean-jsdoc-theme</a>.</span></div></footer></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">jellyfin-roku Code Documentation</a><div class="mobile-nav-links"><div class="external-link navbar-item"><a id="jellyfin-link-mobile" href="https://jellyfin.org/" target="_blank">Jellyfin</a></div><div class="external-link navbar-item"><a id="github-link-mobile" href="https://github.com/jellyfin/jellyfin-roku" target="_blank">GitHub</a></div><div class="external-link navbar-item"><a id="forum-link-mobile" href="https://forum.jellyfin.org/f-roku-development" target="_blank">Forum</a></div><div class="external-link navbar-item"><a id="matrix-link-mobile" href="https://matrix.to/#/#jellyfin-dev-roku:matrix.org" target="_blank">Matrix</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-AlbumData.html">AlbumData</a></div><div class="sidebar-section-children"><a href="module-AlbumGrid.html">AlbumGrid</a></div><div class="sidebar-section-children"><a href="module-AlbumTrackList.html">AlbumTrackList</a></div><div class="sidebar-section-children"><a href="module-AlbumView.html">AlbumView</a></div><div class="sidebar-section-children"><a href="module-Alpha.html">Alpha</a></div><div class="sidebar-section-children"><a href="module-ArtistView.html">ArtistView</a></div><div class="sidebar-section-children"><a href="module-AudioPlayer.html">AudioPlayer</a></div><div class="sidebar-section-children"><a href="module-AudioPlayerView.html">AudioPlayerView</a></div><div class="sidebar-section-children"><a href="module-AudioTrackListItem.html">AudioTrackListItem</a></div><div class="sidebar-section-children"><a href="module-ButtonGroupHoriz.html">ButtonGroupHoriz</a></div><div class="sidebar-section-children"><a href="module-ButtonGroupVert.html">ButtonGroupVert</a></div><div class="sidebar-section-children"><a href="module-ChannelData.html">ChannelData</a></div><div class="sidebar-section-children"><a href="module-Clock.html">Clock</a></div><div class="sidebar-section-children"><a href="module-CollectionData.html">CollectionData</a></div><div class="sidebar-section-children"><a href="module-ConfigData.html">ConfigData</a></div><div class="sidebar-section-children"><a href="module-ConfigItem.html">ConfigItem</a></div><div class="sidebar-section-children"><a href="module-ConfigList.html">ConfigList</a></div><div class="sidebar-section-children"><a href="module-ExtrasItem.html">ExtrasItem</a></div><div class="sidebar-section-children"><a href="module-ExtrasRowList.html">ExtrasRowList</a></div><div class="sidebar-section-children"><a href="module-FavoriteItemsTask.html">FavoriteItemsTask</a></div><div class="sidebar-section-children"><a href="module-Folder
|