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

582 lines
27 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>jellyfin-roku api docs Source: components/liveTv/ProgramDetails.brs</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.dark.css">
<link type="text/css" rel="stylesheet" href="styles/site.darkly.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top ">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">jellyfin-roku api docs</a>
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
<ul class="dropdown-menu ">
2023-10-28 21:26:12 +00:00
<li><a href="module-AlbumData.html">AlbumData</a></li><li><a href="module-AlbumGrid.html">AlbumGrid</a></li><li><a href="module-AlbumTrackList.html">AlbumTrackList</a></li><li><a href="module-AlbumView.html">AlbumView</a></li><li><a href="module-Alpha.html">Alpha</a></li><li><a href="module-ArtistView.html">ArtistView</a></li><li><a href="module-AudioPlayer.html">AudioPlayer</a></li><li><a href="module-AudioPlayerView.html">AudioPlayerView</a></li><li><a href="module-AudioTrackListItem.html">AudioTrackListItem</a></li><li><a href="module-ButtonGroupHoriz.html">ButtonGroupHoriz</a></li><li><a href="module-ChannelData.html">ChannelData</a></li><li><a href="module-CollectionData.html">CollectionData</a></li><li><a href="module-ConfigData.html">ConfigData</a></li><li><a href="module-ConfigItem.html">ConfigItem</a></li><li><a href="module-ConfigList.html">ConfigList</a></li><li><a href="module-ExtrasItem.html">ExtrasItem</a></li><li><a href="module-ExtrasRowList.html">ExtrasRowList</a></li><li><a href="module-FavoriteItemsTask.html">FavoriteItemsTask</a></li><li><a href="module-FolderData.html">FolderData</a></li><li><a href="module-GetFiltersTask.html">GetFiltersTask</a></li><li><a href="module-GetNextEpisodeTask.html">GetNextEpisodeTask</a></li><li><a href="module-GetPlaybackInfoTask.html">GetPlaybackInfoTask</a></li><li><a href="module-GetShuffleEpisodesTask.html">GetShuffleEpisodesTask</a></li><li><a href="module-GridItem.html">GridItem</a></li><li><a href="module-GridItemSmall.html">GridItemSmall</a></li><li><a href="module-Home.html">Home</a></li><li><a href="module-HomeData.html">HomeData</a></li><li><a href="module-HomeItem.html">HomeItem</a></li><li><a href="module-HomeRows.html">HomeRows</a></li><li><a href="module-IconButton.html">IconButton</a></li><li><a href="module-Image.html">Image</a></li><li><a href="module-ImageData.html">ImageData</a></li><li><a href="module-ItemGrid.html">ItemGrid</a></li><li><a href="module-ItemGridOptions.html">ItemGridOptions</a></li><li><a href="module-Items.html">Items</a></li><li><a href="module-JFButton.html">JFButton</a></li><li><a href="module-JFButtons.html">JFButtons</a></li><li><a href="module-JFGroup.html">JFGroup</a></li><li><a href="module-JFMessageDialog.html">JFMessageDialog</a></li><li><a href="module-JFOverhang.html">JFOverhang</a></li><li><a href="module-JFScene.html">JFScene</a></li><li><a href="module-JFScreen.html">JFScreen</a></li><li><a href="module-JFServer.html">JFServer</a></li><li><a href="module-JFVideo.html">JFVideo</a></li><li><a href="module-ListPoster.html">ListPoster</a></li><li><a href="module-LoadChannelsTask.html">LoadChannelsTask</a></li><li><a href="module-LoadItemsTask.html">LoadItemsTask</a></li><li><a href="module-LoadItemsTask2.html">LoadItemsTask2</a></li><li><a href="module-LoadPhotoTask.html">LoadPhotoTask</a></li><li><a href="module-LoadProgramDetailsTask.html">LoadProgramDetailsTask</a></li><li><a href="module-LoadScreenSaverTimeoutTask.html">LoadScreenSaverTimeoutTask</a></li><li><a href="module-LoadSheduleTask.html">LoadSheduleTask</a></li><li><a href="module-LoadVideoContentTask.html">LoadVideoContentTask</a></li><li><a href="module-LoginScene.html">LoginScene</a></li><li><a href="module-Main.html">Main</a></li><li><a href="module-MovieData.html">MovieData</a></li><li><a href="module-MovieDetails.html">MovieDetails</a></li><li><a href="module-MovieLibraryView.html">MovieLibraryView</a></li><li><a href="module-MovieOptions.html">MovieOptions</a></li><li><a href="module-MusicAlbumData.html">MusicAlbumData</a></li><li><a href="module-MusicAlbumSongListData.html">MusicAlbumSongListData</a></li><li><a href="module-MusicArtistData.html">MusicArtistData</a></li><li><a href="module-MusicArtistGridItem.html">MusicArtistGridItem</a></li><li><a href="module-MusicLibraryView.html">MusicLibraryView</a></li><li><a href="module-MusicSongData.html">MusicSongData</a></li><li><a href="module-OptionNode.html">OptionNode</a></li><li><a href="module-OptionsButton.html">OptionsButton</a></li><li><a href="module-OptionsData.html">OptionsData</a></li><li>
</ul>
</li>
</ul>
<div class="col-sm-3 col-md-3">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
</form>
</div>
</div>
</div>
</div>
<div class="container" id="toc-content">
<div class="row">
<div class="col-md-12">
<div id="main">
<h1 class="page-title">Source: components/liveTv/ProgramDetails.brs</h1>
<section>
<article>
<pre
class="sunlight-highlight-javascript linenums">import "pkg:/source/utils/misc.brs"
2023-10-06 03:18:36 +00:00
import "pkg:/source/utils/config.brs"
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
</pre>
</article>
</section>
</div>
</div>
<div class="clearfix"></div>
</div>
</div>
<div class="modal fade" id="searchResults">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
<h4 class="modal-title">Search results</h4>
</div>
<div class="modal-body"></div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div><!-- /.modal-content -->
</div><!-- /.modal-dialog -->
</div>
<footer>
<span class="jsdoc-message">Source code: <a href="https://github.com/jellyfin/jellyfin-roku">https://github.com/jellyfin/jellyfin-roku</a></span><span class="jsdoc-message">Jellyfin Roku Development Forum: <a href="https://forum.jellyfin.org/f-roku-development">https://forum.jellyfin.org/f-roku-development</a></span>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
2023-10-28 01:54:11 +00:00
on Oct 28th 2023
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>
<script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
lang = langClassMatch ? langClassMatch[1] : "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : true,
showMenu : true,
enableDoclinks : true
} );
$.catchAnchorLinks( {
navbarOffset: 10
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
showAndHide : false,
smoothScrolling: true
} );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
$( "table" ).each( function () {
var $this = $( this );
$this.addClass('table');
} );
} );
</script>
<!--Navigation and Symbol Display-->
<!--Google Analytics-->
<script type="text/javascript">
$(document).ready(function() {
SearcherDisplay.init();
});
</script>
</body>
</html>