Update code docs

Author: jellyrock-bot

docs/components_ItemGrid_LoadItemsTask2.bs.html

@@ -22,6 +22,7 @@
 end sub
 
 sub loadItems()
+  globalUser = m.global.user
   results = []
 
   sort_field = m.top.sortField
@@ -107,33 +108,33 @@
 
   if m.top.ItemType = "LiveTV"
     url = "LiveTv/Channels"
-    params.append({ UserId: m.global.user.id })
+    params.append({ UserId: globalUser.id })
   else if m.top.view = "Networks"
     url = "Studios"
-    params.append({ UserId: m.global.user.id })
+    params.append({ UserId: globalUser.id })
   else if m.top.view = "Genres"
     url = "Genres"
-    params.append({ UserId: m.global.user.id, includeItemTypes: m.top.itemType })
+    params.append({ UserId: globalUser.id, includeItemTypes: m.top.itemType })
   else if m.top.ItemType = "MusicArtist"
     url = "Artists"
     params.append({
-      UserId: m.global.user.id,
+      UserId: globalUser.id,
       Fields: "Genres"
     })
     params.IncludeItemTypes = "MusicAlbum,Audio"
   else if m.top.ItemType = "AlbumArtists"
     url = "Artists/AlbumArtists"
     params.append({
-      UserId: m.global.user.id,
+      UserId: globalUser.id,
       Fields: "Genres"
     })
     params.IncludeItemTypes = "MusicAlbum,Audio"
   else if m.top.ItemType = "MusicAlbum"
-    url = Substitute("Users/{0}/Items/", m.global.user.id)
+    url = Substitute("Users/{0}/Items/", globalUser.id)
     params.append({ ImageTypeLimit: 1 })
     params.append({ EnableImageTypes: "Primary,Backdrop,Banner,Thumb" })
   else
-    url = Substitute("Users/{0}/Items/", m.global.user.id)
+    url = Substitute("Users/{0}/Items/", globalUser.id)
   end if
 
   resp = APIRequest(url, params)
@@ -202,7 +203,7 @@
         tmp = CreateObject("roSGNode", "ContentNode")
         tmp.title = item.name
 
-        genreData = api.users.GetItemsByQuery(m.global.user.id, {
+        genreData = api.users.GetItemsByQuery(globalUser.id, {
           SortBy: "Random",
           SortOrder: "Ascending",
           IncludeItemTypes: m.top.itemType,

docs/components_home_Home.bs.html

@@ -85,19 +85,20 @@
   ' Configure overhang UI
   m.log.increaseIndent("Configuring overhang")
   scene = m.top.getScene()
+  globalUser = m.global.user
   m.log.debug("Retrieved scene", scene)
 
   overhang = scene.findNode("overhang")
   if isValid(overhang)
     m.log.debug("Found overhang node", overhang)
 
     overhang.isLogoVisible = true
-    overhang.currentUser = m.global.user.name
+    overhang.currentUser = globalUser.name
     overhang.title = tr("Home")
     m.log.debug("Updated overhang properties", "user:", overhang.currentUser, "title:", overhang.title, "logoVisible:", overhang.isLogoVisible)
 
     ' Hide clock if user preference is set
-    hideClockSetting = m.global.user.settings.uiDesignHideClock
+    hideClockSetting = globalUser.settings.uiDesignHideClock
     m.log.debug("Hide clock setting", hideClockSetting)
 
     if hideClockSetting
@@ -147,7 +148,7 @@
     refresh()
 
     ' Update backdrop based on current splash background setting
-    splashEnabled = m.global.user.settings.uiHomeSplashBackground
+    splashEnabled = globalUser.settings.uiHomeSplashBackground
     m.log.debug("Current splash background setting", splashEnabled)
 
     if isValid(m.backdrop)

docs/components_home_HomeItem.bs.html

@@ -67,11 +67,8 @@
 
   itemData.Title = itemData.name ' Temporarily required while we move from "HomeItem" to "JRContentItem"
 
-  ' validate to prevent crash
-  userSettings = invalid
-  if isValid(m.global) and isValid(m.global.user) and isValid(m.global.user.settings)
-    userSettings = m.global.user.settings
-  end if
+  globalUser = m.global.user
+  userSettings = globalUser.settings
 
   ' validate to prevent crash
   if not isValid(m.itemPoster) then initItemPoster()
@@ -153,7 +150,7 @@
 
     if isValid(userSettings)
       if userSettings.uiGeneralEpisodeImages = "webclient"
-        tmpSetting = m.global.user.config.useEpisodeImagesInNextUpAndResume
+        tmpSetting = globalUser.config.useEpisodeImagesInNextUpAndResume
         if isValid(tmpSetting) and tmpSetting
           m.itemPoster.uri = itemData.thumbnailURL
         else

docs/components_home_LoadItemsTask.bs.html

@@ -13,13 +13,14 @@
 end sub
 
 sub loadItems()
+  globalUser = m.global.user
 
   results = []
 
   ' Load Libraries
   if m.top.itemsToLoad = "libraries"
 
-    url = Substitute("Users/{0}/Views/", m.global.user.id)
+    url = Substitute("Users/{0}/Views/", globalUser.id)
     resp = APIRequest(url)
     data = getJson(resp)
     if isValid(data) and isValid(data.Items)
@@ -35,7 +36,7 @@
 
     ' Load Latest Additions to Libraries
   else if m.top.itemsToLoad = "latest"
-    activeUser = m.global.user.id
+    activeUser = globalUser.id
     if isValid(activeUser)
       url = Substitute("Users/{0}/Items/Latest", activeUser)
       params = {}
@@ -62,15 +63,15 @@
 
     ' Load Next Up
   else if m.top.itemsToLoad = "nextUp"
-    userSettings = m.global.user.settings
+    userSettings = globalUser.settings
 
     url = "Shows/NextUp"
     params = {}
     params["recursive"] = true
     params["SortBy"] = "DatePlayed"
     params["SortOrder"] = "Descending"
     params["ImageTypeLimit"] = 1
-    params["UserId"] = m.global.user.id
+    params["UserId"] = globalUser.id
     params["EnableRewatching"] = userSettings.uiDetailsEnableRewatchingNextUp
     params["DisableFirstEpisode"] = false
     params["limit"] = 69
@@ -100,7 +101,7 @@
     end if
     ' Load Continue Watching
   else if m.top.itemsToLoad = "continue"
-    activeUser = m.global.user.id
+    activeUser = globalUser.id
     if isValid(activeUser)
       url = Substitute("Users/{0}/Items/Resume", activeUser)
 
@@ -127,7 +128,7 @@
 
   else if m.top.itemsToLoad = "favorites"
 
-    url = Substitute("Users/{0}/Items", m.global.user.id)
+    url = Substitute("Users/{0}/Items", globalUser.id)
 
     params = {}
     params["Filters"] = "IsFavorite"
@@ -161,7 +162,7 @@
   else if m.top.itemsToLoad = "onNow"
     url = "LiveTv/Programs/Recommended"
     params = {}
-    params["userId"] = m.global.user.id
+    params["userId"] = globalUser.id
     params["isAiring"] = true
     params["limit"] = 16 ' 16 to be consistent with "Latest In"
     params["imageTypeLimit"] = 1
@@ -198,7 +199,7 @@
     end for
   else if m.top.itemsToLoad = "specialfeatures"
     params = {}
-    url = Substitute("Users/{0}/Items/{1}/SpecialFeatures", m.global.user.id, m.top.itemId)
+    url = Substitute("Users/{0}/Items/{1}/SpecialFeatures", globalUser.id, m.top.itemId)
     resp = APIRequest(url, params)
     data = getJson(resp)
     if isValid(data) and data.count() > 0
@@ -232,7 +233,7 @@
       end for
     end if
   else if m.top.itemsToLoad = "likethis"
-    params = { "userId": m.global.user.id, "limit": 16 }
+    params = { "userId": globalUser.id, "limit": 16 }
     url = Substitute("Items/{0}/Similar", m.top.itemId)
     resp = APIRequest(url, params)
     data = getJson(resp)

docs/components_liveTv_LoadChannelsTask.bs.html

@@ -9,6 +9,7 @@
 end sub
 
 sub loadChannels()
+  globalUser = m.global.user
 
   results = []
 
@@ -25,7 +26,7 @@
     SortBy: sort_field,
     SortOrder: sort_order,
     recursive: m.top.recursive,
-    UserId: m.global.user.id
+    UserId: globalUser.id
   }
 
   ' Handle special case when getting names starting with numeral
@@ -46,7 +47,7 @@
     params.append({ isFavorite: true })
   end if
 
-  url = Substitute("Users/{0}/Items/", m.global.user.id)
+  url = Substitute("Users/{0}/Items/", globalUser.id)
 
   resp = APIRequest(url, params)
   data = getJson(resp)

docs/components_ui_markupgrid_JRMarkupGrid.bs.html

@@ -15,15 +15,16 @@
 end sub
 
 sub applySectionDividerFontScale()
+  globalUser = m.global.user
   if not isValid(m.top.sectionDividerFont) then return
 
   ' Get the current font size if one is set
   currentSize = m.top.sectionDividerFont.size
   if currentSize <= 0 then return
 
   ' Apply the global scale factor
-  if isValid(m.global.user.fontScaleFactor) and m.global.user.fontScaleFactor > 0
-    scaledSize = currentSize * m.global.user.fontScaleFactor
+  if isValid(globalUser.fontScaleFactor) and globalUser.fontScaleFactor > 0
+    scaledSize = currentSize * globalUser.fontScaleFactor
     m.top.sectionDividerFont.size = scaledSize
   end if
 end sub

docs/components_video_VideoPlayerView.bs.html

@@ -578,9 +578,10 @@
   if m.top.content.contenttype <> 4 then return ' only display when content is type "Episode"
   if m.nextupbuttonseconds = 0 then return ' is the button disabled?
   if m.nextEpisodeButton.opacity <> 0 then return
-  userSettings = m.global.user.settings
+  globalUser = m.global.user
+  userSettings = globalUser.settings
   if userSettings.playbackPlayNextEpisode = "disabled" then return
-  if userSettings.playbackPlayNextEpisode = "webclient" and not m.global.user.config.enableNextEpisodeAutoPlay then return
+  if userSettings.playbackPlayNextEpisode = "webclient" and not globalUser.config.enableNextEpisodeAutoPlay then return
 
   ' align button with bottom right edge with 5% padding
   boundingRect = m.notifyButtons.localBoundingRect()

docs/source_ShowScenes.bs.html

@@ -270,13 +270,14 @@
 end sub
 
 function CreateServerGroup()
+  globalServer = m.global.server
   screen = CreateObject("roSGNode", "SetServerScreen")
   screen.optionsAvailable = true
   m.global.sceneManager.callFunc("pushScene", screen)
   port = CreateObject("roMessagePort")
 
-  if isValid(m.global.server.serverUrl)
-    screen.serverUrl = m.global.server.serverUrl
+  if isValid(globalServer.serverUrl)
+    screen.serverUrl = globalServer.serverUrl
   end if
 
   buttons = screen.findNode("buttons")
@@ -329,7 +330,7 @@
             set_setting("server", serverUrl)
             serverInfoResult = ServerInfo()
             'If this is a different server from what we know, reset username/password setting
-            if m.global.server.serverUrl <> serverUrl
+            if globalServer.serverUrl <> serverUrl
               set_setting("username", "")
               set_setting("password", "")
             end if

docs/source_VideoPlayer.bs.html

@@ -30,6 +30,7 @@
 end function
 
 sub AddVideoContent(video as object, mediaSourceId as dynamic, audio_stream_idx = 1 as integer, subtitle_idx = -1 as integer, playbackPosition = -1 as integer, forceTranscoding = false as boolean, showIntro = true as boolean, allowResumeDialog = true as boolean)
+  globalUser = m.global.user
   video.content = createObject("RoSGNode", "ContentNode")
   meta = ItemMetaData(video.id)
   if not isValid(meta)
@@ -90,7 +91,7 @@
           params = {
             ids: video.Id
           }
-          url = Substitute("Users/{0}/Items/", m.global.user.id)
+          url = Substitute("Users/{0}/Items/", globalUser.id)
           resp = APIRequest(url, params)
           data = getJson(resp)
           for each item in data.Items
@@ -100,7 +101,7 @@
           params = {
             ids: m.series_id
           }
-          url = Substitute("Users/{0}/Items/", m.global.user.id)
+          url = Substitute("Users/{0}/Items/", globalUser.id)
           resp = APIRequest(url, params)
           data = getJson(resp)
           for each item in data.Items
@@ -117,7 +118,7 @@
           params = {
             ids: video.Id
           }
-          url = Substitute("Users/{0}/Items/", m.global.user.id)
+          url = Substitute("Users/{0}/Items/", globalUser.id)
           resp = APIRequest(url, params)
           data = getJson(resp)
           for each item in data.Items
@@ -128,7 +129,7 @@
           params = {
             ids: m.season_id
           }
-          url = Substitute("Users/{0}/Items/", m.global.user.id)
+          url = Substitute("Users/{0}/Items/", globalUser.id)
           resp = APIRequest(url, params)
           data = getJson(resp)
           for each item in data.Items
@@ -138,7 +139,7 @@
           params = {
             ids: m.series_id
           }
-          url = Substitute("Users/{0}/Items/", m.global.user.id)
+          url = Substitute("Users/{0}/Items/", globalUser.id)
           resp = APIRequest(url, params)
           data = getJson(resp)
           for each item in data.Items
@@ -155,7 +156,7 @@
           params = {
             ids: video.Id
           }
-          url = Substitute("Users/{0}/Items/", m.global.user.id)
+          url = Substitute("Users/{0}/Items/", globalUser.id)
           resp = APIRequest(url, params)
           data = getJson(resp)
           for each item in data.Items
@@ -225,7 +226,7 @@
   end if
 
   subtitles = sortSubtitles(meta.id, m.playbackInfo.MediaSources[0].MediaStreams)
-  if m.global.user.settings.playbackSubsOnlyText = true
+  if globalUser.settings.playbackSubsOnlyText = true
     safesubs = []
     for each subtitle in subtitles["all"]
       if subtitle["IsTextSubtitleStream"]
@@ -260,8 +261,8 @@
     ' Find first video stream - MediaStreams[0] might be subtitle/audio
     videoStream = getFirstVideoStream(m.playbackInfo.MediaSources[0].MediaStreams)
     if isValid(videoStream) and isValid(videoStream.codec)
-      tryDirectPlay = m.global.user.settings.playbackTryDirectH264ProfileLevel = true and videoStream.codec = "h264"
-      tryDirectPlay = tryDirectPlay or (m.global.user.settings.playbackTryDirectHevcProfileLevel = true and videoStream.codec = "hevc")
+      tryDirectPlay = globalUser.settings.playbackTryDirectH264ProfileLevel = true and videoStream.codec = "h264"
+      tryDirectPlay = tryDirectPlay or (globalUser.settings.playbackTryDirectHevcProfileLevel = true and videoStream.codec = "hevc")
     else
       tryDirectPlay = false
     end if