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

303 lines
146 KiB
HTML
Raw Normal View History

2023-10-06 03:18:36 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
components/manager/ViewCreator.brs - Documentation
</title>
<link href="https://www.braintreepayments.com/images/favicon-ccda0b14.png" rel="icon" type="image/png">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<!-- start Mixpanel -->
<script type="text/javascript">(function(e,a){if(!a.__SV){var b=window;try{var c,l,i,j=b.location,g=j.hash;c=function(a,b){return(l=a.match(RegExp(b+"=([^&]*)")))?l[1]:null};g&&c(g,"state")&&(i=JSON.parse(decodeURIComponent(c(g,"state"))),"mpeditor"===i.action&&(b.sessionStorage.setItem("_mpcehash",g),history.replaceState(i.desiredHash||"",e.title,j.pathname+j.search)))}catch(m){}var k,h;window.mixpanel=a;a._i=[];a.init=function(b,c,f){function e(b,a){var c=a.split(".");2==c.length&&(b=b[c[0]],a=c[1]);b[a]=function(){b.push([a].concat(Array.prototype.slice.call(arguments,
0)))}}var d=a;"undefined"!==typeof f?d=a[f]=[]:f="mixpanel";d.people=d.people||[];d.toString=function(b){var a="mixpanel";"mixpanel"!==f&&(a+="."+f);b||(a+=" (stub)");return a};d.people.toString=function(){return d.toString(1)+".people (stub)"};k="disable time_event track track_pageview track_links track_forms register register_once alias unregister identify name_tag set_config reset people.set people.set_once people.increment people.append people.union people.track_charge people.clear_charges people.delete_user".split(" ");
for(h=0;h<k.length;h++)e(d,k[h]);a._i.push([b,c,f])};a.__SV=1.2;b=e.createElement("script");b.type="text/javascript";b.async=!0;b.src="undefined"!==typeof MIXPANEL_CUSTOM_LIB_URL?MIXPANEL_CUSTOM_LIB_URL:"file:"===e.location.protocol&&"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js".match(/^\/\//)?"https://cdn.mxpnl.com/libs/mixpanel-2-latest.min.js":"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js";c=e.getElementsByTagName("script")[0];c.parentNode.insertBefore(b,c)}})(document,window.mixpanel||[]);
mixpanel.init("1919205b2da72e4da3b9b6639b444d59");</script>
<!-- end Mixpanel -->
</head>
<body>
<svg style="display: none;">
<defs>
<symbol id="linkIcon" fill="#706d77" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M0 0h24v24H0z" fill="none"/>
<path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/>
</symbol>
</defs>
</svg>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<div class="top-nav-wrapper">
<ul>
<li >
<a href="index.html">
<svg fill="#6D6D6D" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"/>
<path d="M0 0h24v24H0z" fill="none"/>
</svg>
</a>
</li>
</ul>
</div>
<nav>
<h3 class="reference-title">
Braintree SDK Client Reference
</h3>
<h3>Classes</h3><ul><li id="Logger-nav"><a href="module-log.Logger.html">Logger</a><ul class='methods'><li data-type="method" id="Logger-debug-nav"><a href="module-log.Logger.html#debug">debug</a></li><li data-type="method" id="Logger-decreaseIndent-nav"><a href="module-log.Logger.html#decreaseIndent">decreaseIndent</a></li><li data-type="method" id="Logger-error-nav"><a href="module-log.Logger.html#error">error</a></li><li data-type="method" id="Logger-increaseIndent-nav"><a href="module-log.Logger.html#increaseIndent">increaseIndent</a></li><li data-type="method" id="Logger-info-nav"><a href="module-log.Logger.html#info">info</a></li><li data-type="method" id="Logger-log-nav"><a href="module-log.Logger.html#log">log</a></li><li data-type="method" id="Logger-method-nav"><a href="module-log.Logger.html#method">method</a></li><li data-type="method" id="Logger-resetIndent-nav"><a href="module-log.Logger.html#resetIndent">resetIndent</a></li><li data-type="method" id="Logger-toString-nav"><a href="module-log.Logger.html#toString">toString</a></li><li data-type="method" id="Logger-verbose-nav"><a href="module-log.Logger.html#verbose">verbose</a></li><li data-type="method" id="Logger-warn-nav"><a href="module-log.Logger.html#warn">warn</a></li></ul></li></ul><h3>Modules</h3><ul><li id="AlbumData-nav"><a href="module-AlbumData.html">AlbumData</a><ul class='methods'><li data-type="method" id="AlbumData-setFields-nav"><a href="module-AlbumData.html#.setFields">setFields</a></li></ul></li><li id="AlbumGrid-nav"><a href="module-AlbumGrid.html">AlbumGrid</a><ul class='methods'><li data-type="method" id="AlbumGrid-getData-nav"><a href="module-AlbumGrid.html#.getData">getData</a></li><li data-type="method" id="AlbumGrid-init-nav"><a href="module-AlbumGrid.html#.init">init</a></li><li data-type="method" id="AlbumGrid-onKeyEvent-nav"><a href="module-AlbumGrid.html#.onKeyEvent">onKeyEvent</a></li></ul></li><li id="AlbumTrackList-nav"><a href="module-AlbumTrackList.html">AlbumTrackList</a><ul class='methods'><li data-type="method" id="AlbumTrackList-getData-nav"><a href="module-AlbumTrackList.html#.getData">getData</a></li><li data-type="method" id="AlbumTrackList-init-nav"><a href="module-AlbumTrackList.html#.init">init</a></li></ul></li><li id="AlbumView-nav"><a href="module-AlbumView.html">AlbumView</a><ul class='methods'><li data-type="method" id="AlbumView-OnScreenHidden-nav"><a href="module-AlbumView.html#.OnScreenHidden">OnScreenHidden</a></li><li data-type="method" id="AlbumView-adjustScreenForNoOverview-nav"><a href="module-AlbumView.html#.adjustScreenForNoOverview">adjustScreenForNoOverview</a></li><li data-type="method" id="AlbumView-createDialogPallete-nav"><a href="module-AlbumView.html#.createDialogPallete">createDialogPallete</a></li><li data-type="method" id="AlbumView-createFullDscrDlg-nav"><a href="module-AlbumView.html#.createFullDscrDlg">createFullDscrDlg</a></li><li data-type="method" id="AlbumView-init-nav"><a href="module-AlbumView.html#.init">init</a></li><li data-type="method" id="AlbumView-onDoneLoading-nav"><a href="module-AlbumView.html#.onDoneLoading">onDoneLoading</a></li><li data-type="method" id="AlbumView-onKeyEvent-nav"><a href="module-AlbumView.html#.onKeyEvent">onKeyEvent</a></li><li data-type="method" id="AlbumView-pageContentChanged-nav"><a href="module-AlbumView.html#.pageContentChanged">pageContentChanged</a></li><li data-type="method" id="AlbumView-setOnScreenTextValues-nav"><a href="module-AlbumView.html#.setOnScreenTextValues">setOnScreenTextValues</a></li><li data-type="method" id="AlbumView-setPosterImage-nav"><a href="module-AlbumView.html#.setPosterImage">setPosterImage</a></li><li data-type="method" id="AlbumView-setScreenTitle-nav"><a href="module-AlbumView.html#.setScreenTitle">setScreenTitle</a></li><li data-type="method" id="AlbumView-setupMainNode-nav"><a href="module-AlbumView.html#.setupMainNode">setupMainNode</a></li></ul></li><li id="Alpha-nav"><a href="module-Alpha.html">Alpha</a><ul class='methods'><li data-type="method" id="Alpha-init-nav"><a href="module-Alpha.html#.init">
</nav>
<div id="main">
<h1 class="page-title">
components/manager/ViewCreator.brs
</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>' Play Audio
sub CreateAudioPlayerView()
m.view = CreateObject("roSGNode", "AudioPlayerView")
m.view.observeField("state", "onStateChange")
m.global.sceneManager.callFunc("pushScene", m.view)
end sub
' Play Video
sub CreateVideoPlayerView()
m.playbackData = {}
m.selectedSubtitle = {}
m.view = CreateObject("roSGNode", "VideoPlayerView")
m.view.observeField("state", "onStateChange")
m.view.observeField("selectPlaybackInfoPressed", "onSelectPlaybackInfoPressed")
m.view.observeField("selectSubtitlePressed", "onSelectSubtitlePressed")
mediaSourceId = m.global.queueManager.callFunc("getCurrentItem").mediaSourceId
if not isValid(mediaSourceId) or mediaSourceId = ""
mediaSourceId = m.global.queueManager.callFunc("getCurrentItem").id
end if
m.getPlaybackInfoTask = createObject("roSGNode", "GetPlaybackInfoTask")
m.getPlaybackInfoTask.videoID = mediaSourceId
m.getPlaybackInfoTask.observeField("data", "onPlaybackInfoLoaded")
m.global.sceneManager.callFunc("pushScene", m.view)
end sub
' -----------------
' Event Handlers
' -----------------
' User requested subtitle selection popup
sub onSelectSubtitlePressed()
' None is always first in the subtitle list
subtitleData = {
data: [{
"Index": -1,
"IsExternal": false,
"Track": {
"description": "None"
},
"Type": "subtitleselection"
}]
}
for each item in m.view.fullSubtitleData
item.type = "subtitleselection"
if m.view.selectedSubtitle &lt;> -1
' Subtitle is a track within the file
if item.index = m.view.selectedSubtitle
item.selected = true
end if
else
' Subtitle is from an external source
availableSubtitleTrackIndex = availSubtitleTrackIdx(item.track.TrackName)
if availableSubtitleTrackIndex &lt;> -1
' Convert Jellyfin subtitle track name to Roku track name
subtitleFullTrackName = m.view.availableSubtitleTracks[availableSubtitleTrackIndex].TrackName
if subtitleFullTrackName = m.view.subtitleTrack
item.selected = true
end if
end if
end if
subtitleData.data.push(item)
end for
m.global.sceneManager.callFunc("radioDialog", tr("Select Subtitles"), subtitleData)
m.global.sceneManager.observeField("returnData", "onSelectionMade")
end sub
' User has selected something from the radioDialog popup
sub onSelectionMade()
m.global.sceneManager.unobserveField("returnData")
if not isValid(m.global.sceneManager.returnData) then return
if not isValid(m.global.sceneManager.returnData.type) then return
if LCase(m.global.sceneManager.returnData.type) = "subtitleselection"
processSubtitleSelection()
end if
end sub
sub processSubtitleSelection()
m.selectedSubtitle = m.global.sceneManager.returnData
' The selected encoded subtitle did not change.
if m.view.selectedSubtitle &lt;> -1 or m.selectedSubtitle.index &lt;> -1
if m.view.selectedSubtitle = m.selectedSubtitle.index then return
end if
' The playbackData is now outdated and must be refreshed
m.playbackData = invalid
if LCase(m.selectedSubtitle.track.description) = "none"
m.view.globalCaptionMode = "Off"
m.view.subtitleTrack = ""
if m.view.selectedSubtitle &lt;> -1
m.view.selectedSubtitle = -1
end if
return
end if
if m.selectedSubtitle.IsEncoded
m.view.globalCaptionMode = "Off"
else
m.view.globalCaptionMode = "On"
end if
if m.selectedSubtitle.IsExternal
availableSubtitleTrackIndex = availSubtitleTrackIdx(m.selectedSubtitle.Track.TrackName)
if availableSubtitleTrackIndex = -1 then return
m.view.subtitleTrack = m.view.availableSubtitleTracks[availableSubtitleTrackIndex].TrackName
else
m.view.selectedSubtitle = m.selectedSubtitle.Index
end if
end sub
' User requested playback info
sub onSelectPlaybackInfoPressed()
' Check if we already have playback info and show it in a popup
if isValid(m.playbackData) and isValid(m.playbackData.playbackinfo)
m.global.sceneManager.callFunc("standardDialog", tr("Playback Info"), m.playbackData.playbackinfo)
return
end if
m.getPlaybackInfoTask.control = "RUN"
end sub
' The playback info task has returned data
sub onPlaybackInfoLoaded()
m.playbackData = m.getPlaybackInfoTask.data
' Check if we have playback info and show it in a popup
if isValid(m.playbackData) and isValid(m.playbackData.playbackinfo)
m.global.sceneManager.callFunc("standardDialog", tr("Playback Info"), m.playbackData.playbackinfo)
end if
end sub
' Playback state change event handlers
sub onStateChange()
if LCase(m.view.state) = "finished"
' Close any open dialogs
if m.global.sceneManager.callFunc("isDialogOpen")
m.global.sceneManager.callFunc("dismissDialog")
end if
' If there is something next in the queue, play it
if m.global.queueManager.callFunc("getPosition") &lt; m.global.queueManager.callFunc("getCount") - 1
m.global.sceneManager.callFunc("clearPreviousScene")
m.global.queueManager.callFunc("moveForward")
m.global.queueManager.callFunc("playQueue")
return
end if
' Playback completed, return user to previous screen
m.global.sceneManager.callFunc("popScene")
m.global.audioPlayer.loopMode = ""
end if
end sub
' Roku translates the info provided in subtitleTracks into availableSubtitleTracks
' Including ignoring tracks, if they are not understood, thus making indexing unpredictable.
' This function translates between our internel selected subtitle index
' and the corresponding index in availableSubtitleTracks.
function availSubtitleTrackIdx(tracknameToFind as string) as integer
idx = 0
for each availTrack in m.view.availableSubtitleTracks
' The TrackName must contain the URL we supplied originally, though
' Roku mangles the name a bit, so we check if the URL is a substring, rather
' than strict equality
if Instr(1, availTrack.TrackName, tracknameToFind)
return idx
end if
idx = idx + 1
end for
return -1
end function
</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
</footer>
<script src="scripts/linenumber.js"></script>
<script src="scripts/pagelocation.js"></script>
</body>
</html>