jf-roku/docs/api/components_liveTv_ProgramDetails.bs.html

377 lines
50 KiB
HTML
Raw Normal View History

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/liveTv/ProgramDetails.bs</title><!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![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/config.bs"
2023-10-06 03:18:36 +00:00
sub init()
' Max "Overview" lines to show in Preview and Detail
m.maxPreviewLines = 5
m.maxDetailLines = 14
m.detailsView = m.top.findNode("detailsView")
m.noInfoView = m.top.findNode("noInformation")
m.programName = m.top.findNode("programName")
m.episodeTitle = m.top.findNode("episodeTitle")
m.episodeNumber = m.top.findNode("episodeNumber")
m.overview = m.top.findNode("overview")
m.episodeDetailsGroup = m.top.findNode("episodeDetailsGroup")
m.isLiveGroup = m.top.findNode("isLive")
m.isRepeatGroup = m.top.findNode("isRepeat")
m.broadcastDetails = m.top.findNode("broadcastDetails")
m.duration = m.top.findNode("duration")
m.channelName = m.top.findNode("channelName")
m.image = m.top.findNode("image")
m.favorite = m.top.findNode("favorite")
m.viewChannelFocusAnimationOpacity = m.top.findNode("viewChannelFocusAnimationOpacity")
m.recordFocusAnimationOpacity = m.top.findNode("recordFocusAnimationOpacity")
m.recordSeriesFocusAnimationOpacity = m.top.findNode("recordSeriesFocusAnimationOpacity")
m.focusAnimation = m.top.findNode("focusAnimation")
m.viewChannelButton = m.top.findNode("viewChannelButton")
m.recordButton = m.top.findNode("recordButton")
m.recordSeriesButton = m.top.findNode("recordSeriesButton")
m.viewChannelOutline = m.top.findNode("viewChannelOutline")
m.recordOutline = m.top.findNode("recordOutline")
m.recordSeriesOutline = m.top.findNode("recordSeriesOutline")
m.viewChannelLabel = m.top.findNode("viewChannelButtonLabel")
m.recordLabel = m.top.findNode("recordButtonLabel")
m.recordSeriesLabel = m.top.findNode("recordSeriesButtonLabel")
m.viewChannelButtonBackground = m.top.findNode("viewChannelButtonBackground")
m.recordButtonBackground = m.top.findNode("recordButtonBackground")
m.recordSeriesButtonBackground = m.top.findNode("recordSeriesButtonBackground")
m.focusAnimation.observeField("state", "onAnimationComplete")
setupLabels()
end sub
' Set up Live and Repeat label sizes
sub setupLabels()
boundingRect = m.top.findNode("isLiveText").boundingRect()
isLiveBackground = m.top.findNode("isLiveBackground")
isLiveBackground.width = boundingRect.width + 16
isLiveBackground.height = boundingRect.height + 8
m.episodeDetailsGroup.removeChildIndex(0)
boundingRect = m.top.findNode("isRepeatText").boundingRect()
isRepeatBackground = m.top.findNode("isRepeatBackground")
isRepeatBackground.width = boundingRect.width + 16
isRepeatBackground.height = boundingRect.height + 8
m.episodeDetailsGroup.removeChildIndex(0)
m.viewChannelLabel.text = tr("View Channel")
boundingRect = m.viewChannelButton.boundingRect()
viewButtonBackground = m.top.findNode("viewChannelButtonBackground")
viewButtonBackground.width = boundingRect.width + 20
viewButtonBackground.height = boundingRect.height + 20
m.viewChannelOutline.width = viewButtonBackground.width
m.viewChannelOutline.height = viewButtonBackground.height
m.recordLabel.text = tr("Record")
boundingRect = m.recordButton.boundingRect()
recordButtonBackground = m.top.findNode("recordButtonBackground")
recordButtonBackground.width = boundingRect.width + 20
recordButtonBackground.height = boundingRect.height + 20
m.recordOutline.width = recordButtonBackground.width
m.recordOutline.height = recordButtonBackground.height
m.recordSeriesLabel.text = tr("Record Series")
boundingRect = m.recordSeriesButton.boundingRect()
recordSeriesButtonBackground = m.top.findNode("recordSeriesButtonBackground")
recordSeriesButtonBackground.width = boundingRect.width + 20
recordSeriesButtonBackground.height = boundingRect.height + 20
m.recordSeriesOutline.width = recordSeriesButtonBackground.width
m.recordSeriesOutline.height = recordSeriesButtonBackground.height
m.userCanRecord = m.global.session.user.settings["livetv.canrecord"]
if m.userCanRecord = false
m.recordButton.visible = false
m.recordSeriesButton.visible = false
end if
end sub
sub updateLabels(recordText = "Record", recordSeriesText = "Record Series")
m.recordLabel.text = tr(recordText)
m.recordSeriesLabel.text = tr(recordSeriesText)
boundingRect = m.recordButton.boundingRect()
recordButtonBackground = m.top.findNode("recordButtonBackground")
recordButtonBackground.width = boundingRect.width
recordButtonBackground.height = boundingRect.height
m.recordOutline.width = recordButtonBackground.width
m.recordOutline.height = recordButtonBackground.height
boundingRect = m.recordSeriesButton.boundingRect()
recordSeriesButtonBackground = m.top.findNode("recordSeriesButtonBackground")
recordSeriesButtonBackground.width = boundingRect.width
recordSeriesButtonBackground.height = boundingRect.height
m.recordSeriesOutline.width = recordSeriesButtonBackground.width
m.recordSeriesOutline.height = recordSeriesButtonBackground.height
end sub
sub channelUpdated()
if m.top.channel = invalid
m.top.findNode("noInfoChannelName").text = ""
m.channelName.text = ""
else
m.top.findNode("noInfoChannelName").text = m.top.channel.Title
m.channelName.text = m.top.channel.Title
if m.top.programDetails = invalid
m.image.uri = m.top.channel.posterURL
end if
m.favorite.visible = m.top.channel.favorite
end if
end sub
sub programUpdated()
m.top.watchSelectedChannel = false
m.top.recordSelectedChannel = false
m.top.recordSeriesSelectedChannel = false
m.overview.maxLines = m.maxDetailLines
prog = m.top.programDetails
' If no program selected, hide details view
if prog = invalid
channelUpdated()
m.detailsView.visible = "false"
m.noInfoView.visible = "true"
return
end if
m.programName.text = prog.Title
m.overview.text = prog.description
m.episodeDetailsGroup.removeChildrenIndex(m.episodeDetailsGroup.getChildCount(), 0)
if prog.isLive
m.episodeDetailsGroup.appendChild(m.isLiveGroup)
else if prog.isRepeat
m.episodeDetailsGroup.appendChild(m.isRepeatGroup)
end if
' Episode Number
if prog.seasonNumber > 0 and prog.episodeNumber > 0
m.episodeNumber.text = "S" + StrI(prog.seasonNumber).trim() + ":E" + StrI(prog.episodeNumber).trim()
if prog.episodeTitle &lt;> "" then m.episodeNumber.text = m.episodeNumber.text + " -" ' Add a Dash if showing Episode Number and Title
m.episodeDetailsGroup.appendChild(m.episodeNumber)
end if
if prog.episodeTitle &lt;> invalid and prog.episodeTitle &lt;> ""
m.episodeTitle.text = prog.episodeTitle
m.episodeTitle.visible = true
m.episodeDetailsGroup.appendChild(m.episodeTitle)
end if
m.duration.text = getDurationStringFromSeconds(prog.PlayDuration)
' Calculate Broadcast Details
now = createObject("roDateTime")
startDate = createObject("roDateTime")
endDate = createObject("roDateTime")
startDate.FromISO8601String(prog.StartDate)
endDate.FromISO8601String(prog.EndDate)
day = getRelativeDayName(startDate)
' Get Start Date in local timezone for display to user
localStartDate = createObject("roDateTime")
localStartDate.FromISO8601String(prog.StartDate)
localStartDate.ToLocalTime()
if startDate.AsSeconds() &lt; now.AsSeconds() and endDate.AsSeconds() > now.AsSeconds()
if day = "today"
m.broadcastDetails.text = tr("Started at") + " " + formatTime(localStartDate)
else
m.broadcastDetails.text = tr("Started") + " " + tr(day) + ", " + formatTime(localStartDate)
end if
else if startDate.AsSeconds() > now.AsSeconds()
if day = "today"
m.broadcastDetails.text = tr("Starts at") + " " + formatTime(localStartDate)
else
m.broadcastDetails.text = tr("Starts") + " " + tr(day) + ", " + formatTime(localStartDate)
end if
else
if day = "today"
m.broadcastDetails.text = tr("Ended at") + " " + formatTime(localStartDate)
else
m.broadcastDetails.text = tr("Ended") + " " + tr(day) + ", " + formatTime(localStartDate)
end if
end if
m.image.uri = prog.PosterURL
' If currently being recorded, change button to "Stop Recording"
if prog.json.TimerId &lt;> invalid
if prog.json.SeriesTimerId &lt;> invalid
updateLabels("Cancel Recording", "Cancel Series Recording")
else
updateLabels("Cancel Recording", "Record Series")
end if
else
updateLabels()
end if
' If not a series, hide Record Series button
if prog.json.isSeries &lt;> true ' could be invalid or false
m.recordSeriesButton.visible = false
else
m.recordSeriesButton.visible = true
end if
m.detailsView.visible = "true"
m.noInfoView.visible = "false"
m.top.height = m.detailsView.boundingRect().height
m.overview.maxLines = m.maxPreviewLines
end sub
'
' Get relative date name for a date (yesterday, today, tomorrow, or otherwise weekday name )
function getRelativeDayName(date) as string
now = createObject("roDateTime")
' Check for Today
if now.AsDateString("short-date-dashes") = date.AsDateString("short-date-dashes")
return "today"
end if
' Check for Yesterday
todayMidnight = now.AsSeconds() - (now.AsSeconds() mod 86400)
dateMidnight = date.AsSeconds() - (date.AsSeconds() mod 86400)
if todayMidnight - dateMidnight = 86400
return "yesterday"
end if
if dateMidnight - todayMidnight = 86400
return "tomorrow"
end if
return date.GetWeekday()
end function
'
' Get program duration string (e.g. 1h 20m)
function getDurationStringFromSeconds(seconds) as string
hours = 0
minutes = seconds / 60.0
if minutes > 60
hours = (minutes - (minutes mod 60)) / 60
minutes = minutes mod 60
end if
if hours > 0
return "%1h %2m".Replace("%1", StrI(hours).trim()).Replace("%2", StrI(minutes).trim())
else
return "%1m".Replace("%1", StrI(minutes).trim())
end if
end function
'
' Show view channel button when item has Focus
sub focusChanged()
if m.top.hasFocus = true
m.overview.maxLines = m.maxDetailLines
m.viewChannelFocusAnimationOpacity.keyValue = [0, 1]
m.recordFocusAnimationOpacity.keyValue = [0, 1]
m.recordSeriesFocusAnimationOpacity.keyValue = [0, 1]
m.viewChannelButton.setFocus(true)
m.viewChannelOutline.visible = true
m.recordOutline.visible = false
m.recordSeriesOutline.visible = false
m.viewChannelButtonBackground.blendColor = "#006fab"
m.recordButtonBackground.blendColor = "#000000"
m.recordSeriesButtonBackground.blendColor = "#000000"
else
m.top.watchSelectedChannel = false
m.top.recordSelectedChannel = false
m.top.recordSeriesSelectedChannel = false
m.viewChannelFocusAnimationOpacity.keyValue = [1, 0]
m.recordFocusAnimationOpacity.keyValue = [1, 0]
m.recordSeriesFocusAnimationOpacity.keyValue = [1, 0]
end if
m.focusAnimation.control = "start"
end sub
sub onAnimationComplete()
if m.focusAnimation.state = "stopped" and m.top.hasFocus = false
m.overview.maxLines = m.maxPreviewLines
end if
end sub
function onKeyEvent(key as string, press as boolean) as boolean
if not press then return false
if key = "OK" and m.viewChannelButton.hasFocus()
m.top.watchSelectedChannel = true
return true
else if key = "OK" and m.recordButton.hasFocus()
m.top.recordSelectedChannel = true
return true
else if key = "OK" and m.recordSeriesButton.hasFocus()
m.top.recordSeriesSelectedChannel = true
return true
end if
if m.userCanRecord = "true"
if key = "right" and m.viewChannelButton.hasFocus()
m.recordButton.setFocus(true)
m.viewChannelOutline.visible = false
m.recordOutline.visible = true
m.viewChannelButtonBackground.blendColor = "#000000"
m.recordButtonBackground.blendColor = "#006fab"
m.recordSeriesButtonBackground.blendColor = "#000000"
return true
else if key = "right" and m.recordButton.hasFocus()
m.recordSeriesButton.setFocus(true)
m.recordOutline.visible = false
m.recordSeriesOutline.visible = true
m.viewChannelButtonBackground.blendColor = "#000000"
m.recordButtonBackground.blendColor = "#000000"
m.recordSeriesButtonBackground.blendColor = "#006fab"
return true
else if key = "left" and m.recordSeriesButton.hasFocus()
m.recordButton.setFocus(true)
m.recordOutline.visible = true
m.recordSeriesOutline.visible = false
m.viewChannelButtonBackground.blendColor = "#000000"
m.recordButtonBackground.blendColor = "#006fab"
m.recordSeriesButtonBackground.blendColor = "#000000"
return true
else if key = "left" and m.recordButton.hasFocus()
m.viewChannelButton.setFocus(true)
m.viewChannelOutline.visible = true
m.recordOutline.visible = false
m.viewChannelButtonBackground.blendColor = "#006fab"
m.recordButtonBackground.blendColor = "#000000"
m.recordSeriesButtonBackground.blendColor = "#000000"
return true
end if
end if
if key = "up" or key = "down"
return true
end if
return false
end function
2023-11-11 13:41:20 +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