Update code docs

Author: jellyrock-bot

docs/components_ItemGrid_LoadVideoContentTask.bs.html

@@ -24,8 +24,9 @@
 sub loadItems()
   queueManager = m.global.queueManager
 
-  ' Reset intro tracker in case task gets reused
+  ' Reset per-run fields in case task gets reused
   m.top.isIntro = false
+  m.top.errorMsg = ""
 
   ' Only show preroll once per queue
   if queueManager.callFunc("isPrerollActive")
@@ -127,12 +128,17 @@
   subtitle_idx = m.top.selectedSubtitleIndex
   videotype = LCase(meta.type)
 
-  ' Check for any Live TV streams or Recordings coming from other places other than the TV Guide
+  ' Check for any Live TV streams or Recordings coming from other places other than the TV Guide.
+  ' TvChannel is always live — include it here so mediaSourceId is cleared and live-stream
+  ' flags (content.live, StreamFormat, transcodeParams.LiveStreamId) are set correctly below.
   isLive = false
   titleOverride = ""
-  if videotype = "recording" or isValidAndNotEmpty(meta.channelId)
+  if videotype = "recording" or videotype = "tvchannel" or isValidAndNotEmpty(meta.channelId)
     if isValidAndNotEmpty(meta.episodeTitle)
       titleOverride = meta.episodeTitle
+    else if videotype = "tvchannel" and isValid(meta.currentProgram) and isValidAndNotEmpty(meta.currentProgram.name)
+      ' For TvChannel, prefer the currently-airing program's name over the channel name
+      titleOverride = meta.currentProgram.name
     else
       titleOverride = meta.name
     end if
@@ -144,9 +150,6 @@
     end if
   end if
 
-  ' TVChannel CurrentProgram fields (live program title/episode info) deferred to Phase 6
-  ' meta.json.CurrentProgram is not a typed field on JellyfinBaseItem
-
   video.chapters = meta.chapters
   video.title = isValidAndNotEmpty(titleOverride) ? titleOverride : meta.title
   video.showID = meta.seriesId
@@ -177,6 +180,21 @@
     else if isValidAndNotEmpty(meta.primaryImageTag)
       video.logoImage = ImageURL(meta.id, "Primary", { maxHeight: 212, maxWidth: 500, quality: 90, tag: meta.primaryImageTag })
     end if
+  else if videotype = "tvchannel"
+    ' For live TV channels, prefer the currently-airing program's artwork over the channel icon.
+    ' Priority: program logo → program primary (poster) → channel icon (fallback).
+    currentProgram = meta.currentProgram
+    if isValid(currentProgram)
+      if isValidAndNotEmpty(currentProgram.logoImageTag)
+        video.logoImage = ImageURL(currentProgram.id, "Logo", { maxHeight: 212, maxWidth: 500, quality: 90, tag: currentProgram.logoImageTag })
+      else if isValidAndNotEmpty(currentProgram.primaryImageTag)
+        video.logoImage = ImageURL(currentProgram.id, "Primary", { maxHeight: 534, maxWidth: 500, quality: 90, tag: currentProgram.primaryImageTag })
+      else if isValidAndNotEmpty(meta.primaryImageTag)
+        video.logoImage = ImageURL(meta.id, "Primary", { maxHeight: 212, maxWidth: 212, quality: 90, tag: meta.primaryImageTag })
+      end if
+    else if isValidAndNotEmpty(meta.primaryImageTag)
+      video.logoImage = ImageURL(meta.id, "Primary", { maxHeight: 212, maxWidth: 212, quality: 90, tag: meta.primaryImageTag })
+    end if
   end if
 
   if LCase(m.top.itemType) = "episode"
@@ -226,22 +244,27 @@
   ' Call ItemPostPlaybackInfo ONCE with final subtitle_idx
   m.playbackInfo = ItemPostPlaybackInfo(video.id, mediaSourceId, audio_stream_idx, subtitle_idx, playbackPosition, meta, bypassDoviPreservation, forceTranscoding)
   if not isValid(m.playbackInfo)
-    video.errorMsg = "Error loading playback info"
+    m.log.error("ItemPostPlaybackInfo returned invalid response")
+    m.top.errorMsg = tr("There was an error retrieving playback information from the server.")
     video.content = invalid
     return
   end if
 
-  ' Playback info can be logged here for debugging playback issues
-  print "LoadItems_AddVideoContent() m.playbackInfo =", m.playbackInfo
-  if m.playbackInfo.MediaSources.Count() > 0
-    for each mediaSource in m.playbackInfo.MediaSources
-      print "mediaSource =", mediaSource
-      ' for each mediaStream in mediaSource.MediaStreams
-      '   print "mediaStream =", mediaStream
-      ' end for
-    end for
+  ' Surface structured server errors as user-friendly messages before inspecting MediaSources
+  if isValidAndNotEmpty(m.playbackInfo.ErrorCode)
+    errorCode = m.playbackInfo.ErrorCode
+    m.log.error("PlaybackInfo returned error code", "errorCode", errorCode, "itemId", video.id)
+    if errorCode = "NoCompatibleStream"
+      m.top.errorMsg = tr("No compatible streams are available for this item.")
+    else
+      m.top.errorMsg = tr("The server was unable to start playback.") + " (" + errorCode + ")"
+    end if
+    video.content = invalid
+    return
   end if
 
+  m.log.debug("PlaybackInfo loaded", "mediaSourceCount", m.playbackInfo.MediaSources.Count())
+
   ' Call addSubtitlesToVideo ONCE after ItemPostPlaybackInfo
   addSubtitlesToVideo(video, meta)
 
@@ -313,9 +336,10 @@
     applyLiveDirectPlayFallback(video, meta)
   else
     if not isValid(m.playbackInfo.MediaSources[0].TranscodingUrl)
-      ' If server does not provide a transcode URL, display a message to the user
-      m.global.sceneManager.callFunc("userMessage", tr("Error Getting Playback Information"), tr("An error was encountered while playing this item.  Server did not provide required transcoding data."))
-      video.errorMsg = "Error getting playback information"
+      ' Server did not provide a transcode URL — surface a message to the user via the task field
+      ' so VideoPlayerView shows one dialog (not two).
+      m.log.error("Server did not provide a TranscodingUrl", "itemId", video.id)
+      m.top.errorMsg = tr("An error was encountered while playing this item. The server did not provide the required transcoding data.")
       video.content = invalid
       return
     end if

docs/components_video_OSD.bs.html

@@ -63,10 +63,15 @@
 
   itemType = item.type
 
-  ' Determine isMovie/isSeries flags for ratings display settings
-  ' TODO Phase 6: For TvChannel/Program types, isMovie/isSeries should come from CurrentProgram data
-  isMovieFlag = item.isMovie
-  isSeriesFlag = item.isSeries
+  ' Determine isMovie/isSeries flags for ratings display settings.
+  ' For TvChannel, use the currently-airing program's flags if available.
+  if itemType = "TvChannel" and isValid(item.currentProgram)
+    isMovieFlag = item.currentProgram.isMovie
+    isSeriesFlag = item.currentProgram.isSeries
+  else
+    isMovieFlag = item.isMovie
+    isSeriesFlag = item.isSeries
+  end if
 
   ' Validate mutual exclusivity: both flags cannot be true
   if isMovieFlag and isSeriesFlag
@@ -95,16 +100,17 @@
   ' Stream counts - read pre-computed values from item node
   m.top.numAudioStreams = item.audioStreamCount
 
-  ' Runtime
-  if item.runTimeTicks > 0
-    m.top.runTimeMinutes = ticksToMinutes(item.runTimeTicks)
+  ' Runtime — for TvChannel, use the currently-airing program's runtime if available
+  runTimeTicks = item.runTimeTicks
+  if itemType = "TvChannel" and isValid(item.currentProgram) and item.currentProgram.runTimeTicks > 0
+    runTimeTicks = item.currentProgram.runTimeTicks
+  end if
+  if runTimeTicks > 0
+    m.top.runTimeMinutes = ticksToMinutes(runTimeTicks)
   else
     m.top.runTimeMinutes = 0
   end if
 
-  ' TODO Phase 6: Live TV CurrentProgram override for runTimeTicks/runTimeMinutes
-  ' When currentProgram data is available on JellyfinBaseItem, override here.
-
   setButtonStates()
   populateData()
 end sub
@@ -150,15 +156,30 @@
 end sub
 
 sub setEndsAtText()
+  endsAtText = m.top.findNode("endsAtText")
+
   if m.global.user.settings.uiDesignHideClock
-    endsAtText = m.top.findNode("endsAtText")
     endsAtText.visible = false
     m.endsAtTime.text = ""
     return
   end if
 
-  ' TODO Phase 6: Live TV "ends at" time from CurrentProgram.EndDate
-  ' When currentProgram data is available on JellyfinBaseItem, restore TvChannel EndDate display here.
+  ' For live TV channels, use the currently-airing program's EndDate for end time.
+  ' remainingPositionTime ≈ 0 for live streams so the default calculation would show current time.
+  if isValid(m.itemData) and m.itemData.type = "TvChannel"
+    currentProgram = m.itemData.currentProgram
+    if isValid(currentProgram) and isValidAndNotEmpty(currentProgram.endDate)
+      endDt = CreateObject("roDateTime")
+      endDt.FromISO8601String(currentProgram.endDate)
+      endDt.toLocalTime()
+      m.endsAtTime.text = formatTime(endDt)
+      endsAtText.visible = true
+    else
+      endsAtText.visible = false
+      m.endsAtTime.text = ""
+    end if
+    return
+  end if
 
   ' Calculate endsAtTime based on remainingPositionTime
   date = CreateObject("roDateTime")
@@ -171,16 +192,16 @@
 
 sub setVideoLogoGroup()
   m.videoLogo.uri = m.top.videoLogo
-
-  ' TODO Phase 6: Live TV channel logo from CurrentProgram image tags
-  ' When currentProgram data is available on JellyfinBaseItem, restore TvChannel logo override here.
 end sub
 
 sub setVideoTitle()
-  m.videoTitle.text = m.itemData.name
-
-  ' TODO Phase 6: Live TV channel title from CurrentProgram.Name
-  ' When currentProgram data is available on JellyfinBaseItem, restore TvChannel title override here.
+  item = m.itemData
+  ' For TvChannel, display the currently-airing program name rather than the channel name
+  if item.type = "TvChannel" and isValid(item.currentProgram) and isValidAndNotEmpty(item.currentProgram.name)
+    m.videoTitle.text = item.currentProgram.name
+  else
+    m.videoTitle.text = item.name
+  end if
 end sub
 
 sub setVideoSubTitle()
@@ -191,6 +212,12 @@
   item = m.itemData
   itemType = item.type
 
+  ' For TvChannel, ratings and dates are sourced from the currently-airing program when available
+  metaItem = item
+  if itemType = "TvChannel" and isValid(item.currentProgram)
+    metaItem = item.currentProgram
+  end if
+
   ' EPISODE
   if itemType = "Episode" or itemType = "Recording"
     ' Title
@@ -241,18 +268,53 @@
       displaySubtitleNode(productionYearNode)
     end if
   else if itemType = "TvChannel"
-    ' TODO Phase 6: Live TV channel number/name from CurrentProgram data
-    ' When currentProgram data is available on JellyfinBaseItem, restore channel info display here.
+    ' Display currently-airing program metadata (episode info or movie year)
+    currentProgram = item.currentProgram
+    if isValid(currentProgram)
+      if currentProgram.isSeries
+        ' Episode info: S1E2 - Episode Name
+        episodeInfoText = ""
+        if currentProgram.parentIndexNumber > 0
+          episodeInfoText = episodeInfoText + `${tr("S")}${currentProgram.parentIndexNumber}`
+        end if
+        if currentProgram.indexNumber > 0
+          episodeInfoText = episodeInfoText + `${tr("E")}${currentProgram.indexNumber}`
+        end if
+        if isValidAndNotEmpty(currentProgram.name)
+          if isValidAndNotEmpty(episodeInfoText)
+            episodeInfoText = episodeInfoText + ` - ${currentProgram.name}`
+          else
+            episodeInfoText = currentProgram.name
+          end if
+        end if
+        if isValidAndNotEmpty(episodeInfoText)
+          episodeInfoNode = createSubtitleLabelNode("episodeInfo")
+          episodeInfoNode.text = episodeInfoText
+          displaySubtitleNode(episodeInfoNode)
+        end if
+      else if currentProgram.isMovie and currentProgram.productionYear > 0
+        airDateNodeCreated = true
+        productionYearNode = createSubtitleLabelNode("productionYear")
+        productionYearNode.text = currentProgram.productionYear.toStr().trim()
+        displaySubtitleNode(productionYearNode)
+      end if
+    end if
+    ' Channel number (e.g. "CH 4") — always shown when available
+    if isValidAndNotEmpty(item.channelNumber)
+      channelNumberNode = createSubtitleLabelNode("channelNumber")
+      channelNumberNode.text = `${tr("CH")} ${item.channelNumber}`
+      displaySubtitleNode(channelNumberNode)
+    end if
   end if
 
   ' append these to all video types
   '
   userSettings = m.global.user.settings
 
   ' Official Rating
-  if isValidAndNotEmpty(item.officialRating)
+  if isValidAndNotEmpty(metaItem.officialRating)
     officialRatingNode = createSubtitleLabelNode("officialRating")
-    officialRatingNode.text = item.officialRating
+    officialRatingNode.text = metaItem.officialRating
     displaySubtitleNode(officialRatingNode)
   end if
 
@@ -271,30 +333,28 @@
 
   if showRatings
     ' communityRating (star + rating)
-    ' TODO Phase 6: For TvChannel/Program, communityRating should come from CurrentProgram
-    if item.communityRating <> 0
+    if metaItem.communityRating <> 0
       communityRatingNode = CreateObject("roSGNode", "CommunityRating")
       communityRatingNode.id = "communityRating"
-      communityRatingNode.rating = item.communityRating
+      communityRatingNode.rating = metaItem.communityRating
       communityRatingNode.iconSize = 30
       displaySubtitleNode(communityRatingNode)
     end if
 
     ' criticRating (tomato + rating)
-    ' TODO Phase 6: For TvChannel/Program, criticRating should come from CurrentProgram
-    if item.criticRating <> 0
+    if metaItem.criticRating <> 0
       criticRatingNode = CreateObject("roSGNode", "CriticRating")
       criticRatingNode.id = "criticRating"
-      criticRatingNode.rating = item.criticRating
+      criticRatingNode.rating = metaItem.criticRating
       criticRatingNode.iconSize = 30
       displaySubtitleNode(criticRatingNode)
     end if
   end if
 
   ' videoAirDate if needed
-  if not airDateNodeCreated and isValidAndNotEmpty(item.premiereDate)
+  if not airDateNodeCreated and isValidAndNotEmpty(metaItem.premiereDate)
     premiereDateNode = createSubtitleLabelNode("videoAirDate")
-    premiereDateNode.text = formatIsoDateVideo(item.premiereDate)
+    premiereDateNode.text = formatIsoDateVideo(metaItem.premiereDate)
     displaySubtitleNode(premiereDateNode)
   end if
 

docs/components_video_VideoPlayerView.bs.html

@@ -519,10 +519,17 @@
   videoContent = m.LoadMetaDataTask.content
   m.LoadMetaDataTask.content = []
 
-  ' If we have nothing to play, return to previous screen
+  ' If we have nothing to play, show an error dialog and return.
+  ' Prefer the task's specific errorMsg (e.g. NoCompatibleStream) over the generic fallback
+  ' so the user sees an actionable message rather than a generic one.
   if not isValid(videoContent) or not isValid(videoContent[0])
     stopLoadingSpinner()
-    showPlaybackErrorDialog(tr("There was an error retrieving the data for this item from the server."))
+    taskErrorMsg = m.LoadMetaDataTask.errorMsg
+    if isValidAndNotEmpty(taskErrorMsg)
+      showPlaybackErrorDialog(taskErrorMsg)
+    else
+      showPlaybackErrorDialog(tr("There was an error retrieving the data for this item from the server."))
+    end if
     return
   end if
 

docs/source_data_JellyfinDataTransformer.bs.html

@@ -197,6 +197,24 @@
         m.transformSeasonFields(item, apiData)
       else if itemType = "Series"
         m.transformSeriesFields(item, apiData)
+      else if itemType = "TvChannel"
+        ' TV channels are always live — set the ContentNode live built-in so applyLiveDirectPlayFallback
+        ' can arm the transcode retry path, and isLive in the JellyfinBaseItem field for consistency.
+        item.isLive = true
+        item.live = true
+        ' Channel number lives in apiData.Number for TvChannel items (distinct from apiData.ChannelNumber,
+        ' which is the program-to-channel reference field used only on Program/Recording items).
+        item.channelNumber = apiData.Number ?? ""
+        ' CurrentProgram is a nested BaseItemDto returned by default on all TvChannel items
+        ' (not gated behind ItemFields — no extra fields= param needed). Transform it so the
+        ' OSD and playback stack can read typed program fields (name, episode info, artwork,
+        ' runtime, end time) directly from the TvChannel node.
+        if isValid(apiData.CurrentProgram)
+          programNode = m.transformBaseItem(apiData.CurrentProgram, serverVersion)
+          if isValid(programNode)
+            item.currentProgram = programNode
+          end if
+        end if
       else if itemType = "Program" or itemType = "Recording"
         m.transformProgramFields(item, apiData)
       else if itemType = "MusicAlbum" or itemType = "Audio" or itemType = "MusicArtist" or itemType = "MusicVideo"