2023-10-27 02:19:51 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width" >
< title > jellyfin-roku api docs Source: components/data/SceneManager.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-11-11 00:30:32 +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-ButtonGroupVert.html" > ButtonGroupVert< / a > < / li > < li > < a href = "module-ChannelData.html" > ChannelData< / a > < / li > < li > < a href = "module-Clock.html" > Clock< / 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-IntegerKeyboard.html" > IntegerKeyboard< / 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 > < l
2023-10-27 02:19:51 +00:00
< / 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/data/SceneManager.brs< / h1 >
< section >
< article >
< pre
class="sunlight-highlight-javascript linenums">import "pkg:/source/roku_modules/log/LogMixin.brs"
sub init()
m.log = log.Logger("SceneManager")
m.groups = []
m.scene = m.top.getScene()
m.content = m.scene.findNode("content")
m.overhang = m.scene.findNode("overhang")
end sub
'
' Push a new group onto the stack, replacing the existing group on the screen
sub pushScene(newGroup)
currentGroup = m.groups.peek()
if newGroup < > invalid
if currentGroup < > invalid
'Search through group and store off last focused item
if currentGroup.focusedChild < > invalid
focused = currentGroup.focusedChild
while focused.hasFocus() = false
focused = focused.focusedChild
end while
currentGroup.lastFocus = focused
currentGroup.setFocus(false)
else
currentGroup.setFocus(false)
end if
if currentGroup.isSubType("JFGroup")
unregisterOverhangData(currentGroup)
end if
currentGroup.visible = false
if currentGroup.isSubType("JFScreen")
currentGroup.callFunc("OnScreenHidden")
end if
end if
m.groups.push(newGroup)
if currentGroup < > invalid
m.content.replaceChild(newGroup, 0)
else
m.content.appendChild(newGroup)
end if
if newGroup.isSubType("JFScreen")
newGroup.callFunc("OnScreenShown")
end if
'observe info about new group, set overhang title, etc.
if newGroup.isSubType("JFGroup")
registerOverhangData(newGroup)
' Some groups set focus to a specific component within init(), so we don't want to
' change if that is the case.
if newGroup.isInFocusChain() = false
newGroup.setFocus(true)
end if
else if newGroup.isSubType("JFVideo")
newGroup.setFocus(true)
newGroup.control = "play"
m.overhang.visible = false
end if
else
currentGroup.focusedChild.setFocus(true)
end if
end sub
'
' Remove the current group and load the last group from the stack
sub popScene()
group = m.groups.pop()
if group < > invalid
2023-10-27 02:20:25 +00:00
if group.isSubType("JFGroup")
2023-10-27 02:19:51 +00:00
unregisterOverhangData(group)
2023-10-27 02:20:25 +00:00
else if group.isSubType("JFVideo")
2023-10-27 02:19:51 +00:00
' Stop video to make sure app communicates stop playstate to server
group.control = "stop"
end if
group.visible = false
2023-10-27 02:20:25 +00:00
if group.isSubType("JFScreen")
2023-10-27 02:19:51 +00:00
group.callFunc("OnScreenHidden")
end if
else
' Exit app if for some reason we don't have anything on the stack
m.scene.exit = true
end if
group = m.groups.peek()
if group < > invalid
registerOverhangData(group)
group.visible = true
m.content.replaceChild(group, 0)
if group.isSubType("JFScreen")
group.callFunc("OnScreenShown")
else
' Restore focus
if group.lastFocus < > invalid
group.lastFocus.setFocus(true)
else
if group.focusedChild < > invalid
group.focusedChild.setFocus(true)
else
group.setFocus(true)
end if
end if
end if
else
' Exit app if the stack is empty after removing group
m.scene.exit = true
end if
end sub
'
' Return group at top of stack without removing
function getActiveScene() as object
return m.groups.peek()
end function
'
' Clear all content from group stack
sub clearScenes()
if m.content < > invalid then m.content.removeChildrenIndex(m.content.getChildCount(), 0)
2023-11-11 00:30:32 +00:00
for each group in m.groups
if LCase(group.subtype()) = "jfscreen"
group.callFunc("OnScreenHidden")
end if
end for
2023-10-27 02:19:51 +00:00
m.groups = []
end sub
'
' Clear previous scene from group stack
sub clearPreviousScene()
m.groups.pop()
end sub
'
' Delete scene from group stack at passed index
sub deleteSceneAtIndex(index = 1)
m.groups.Delete(index)
end sub
'
' Display user/device settings screen
sub settings()
settingsScreen = createObject("roSGNode", "Settings")
pushScene(settingsScreen)
end sub
'
' Register observers for overhang data
sub registerOverhangData(group)
if group.isSubType("JFGroup")
if group.overhangTitle < > invalid then m.overhang.title = group.overhangTitle
if group.optionsAvailable
m.overhang.showOptions = true
else
m.overhang.showOptions = false
end if
group.observeField("optionsAvailable", "updateOptions")
group.observeField("overhangTitle", "updateOverhangTitle")
if group.overhangVisible
m.overhang.visible = true
else
m.overhang.visible = false
end if
group.observeField("overhangVisible", "updateOverhangVisible")
else if group.isSubType("JFVideo")
m.overhang.visible = false
else
m.log.error("registerOverhangData(): Unexpected group type.", group, group.subtype())
end if
end sub
'
' Remove observers for overhang data
sub unregisterOverhangData(group)
group.unobserveField("overhangTitle")
end sub
'
' Update overhang title
sub updateOverhangTitle(msg)
m.overhang.title = msg.getData()
end sub
'
' Update options availability
sub updateOptions(msg)
m.overhang.showOptions = msg.getData()
end sub
'
' Update whether the overhang is visible or not
sub updateOverhangVisible(msg)
m.overhang.visible = msg.getData()
end sub
'
' Update username in overhang
sub updateUser()
' Passthrough to overhang
if m.overhang < > invalid then m.overhang.currentUser = m.top.currentUser
end sub
'
' Reset time
sub resetTime()
' Passthrough to overhang
m.overhang.callFunc("resetTime")
end sub
'
' Display dialog to user with an OK button
sub userMessage(title as string, message as string)
dialog = createObject("roSGNode", "StandardMessageDialog")
dialog.title = title
dialog.message = message
dialog.buttons = [tr("OK")]
dialog.observeField("buttonSelected", "dismissDialog")
m.scene.dialog = dialog
end sub
'
' Display dialog to user with an OK button
sub standardDialog(title, message)
dialog = createObject("roSGNode", "StandardDialog")
dlgPalette = createObject("roSGNode", "RSGPalette")
dlgPalette.colors = {
DialogBackgroundColor: "0x262828FF",
DialogFocusColor: "0xcececeFF",
DialogFocusItemColor: "0x202020FF",
DialogSecondaryTextColor: "0xf8f8f8ff",
DialogSecondaryItemColor: "#00a4dcFF",
DialogTextColor: "0xeeeeeeFF"
}
dialog.palette = dlgPalette
dialog.observeField("buttonSelected", "dismissDialog")
dialog.title = title
dialog.contentData = message
dialog.buttons = [tr("OK")]
m.scene.dialog = dialog
end sub
'
' Display dialog to user with an OK button
sub radioDialog(title, message)
dialog = createObject("roSGNode", "RadioDialog")
dlgPalette = createObject("roSGNode", "RSGPalette")
dlgPalette.colors = {
DialogBackgroundColor: "0x262828FF",
DialogFocusColor: "0xcececeFF",
DialogFocusItemColor: "0x202020FF",
DialogSecondaryTextColor: "0xf8f8f8ff",
DialogSecondaryItemColor: "#00a4dcFF",
DialogTextColor: "0xeeeeeeFF"
}
dialog.palette = dlgPalette
dialog.observeField("buttonSelected", "dismissDialog")
dialog.title = title
dialog.contentData = message
dialog.buttons = [tr("OK")]
m.scene.dialog = dialog
end sub
'
' Display dialog to user with an OK button
sub optionDialog(title, message, buttons)
m.top.dataReturned = false
m.top.returnData = invalid
m.userselection = false
dialog = createObject("roSGNode", "StandardMessageDialog")
dlgPalette = createObject("roSGNode", "RSGPalette")
dlgPalette.colors = {
DialogBackgroundColor: "0x262828FF",
DialogFocusColor: "0xcececeFF",
DialogFocusItemColor: "0x202020FF",
DialogSecondaryTextColor: "0xf8f8f8ff",
DialogSecondaryItemColor: "#00a4dcFF",
DialogTextColor: "0xeeeeeeFF"
}
dialog.palette = dlgPalette
dialog.observeField("buttonSelected", "optionSelected")
dialog.observeField("wasClosed", "optionClosed")
dialog.title = title
dialog.message = message
dialog.buttons = buttons
m.scene.dialog = dialog
end sub
'
' Return button the user selected
sub optionClosed()
if m.userselection then return
m.top.returnData = {
indexSelected: -1,
buttonSelected: ""
}
m.top.dataReturned = true
end sub
'
' Return button the user selected
sub optionSelected()
m.userselection = true
m.top.returnData = {
indexSelected: m.scene.dialog.buttonSelected,
buttonSelected: m.scene.dialog.buttons[m.scene.dialog.buttonSelected]
}
m.top.dataReturned = true
dismissDialog()
end sub
'
' Close currently displayed dialog
sub dismissDialog()
m.scene.dialog.close = true
end sub
'
' Returns bool indicating if dialog is currently displayed
function isDialogOpen() as boolean
return m.scene.dialog < > invalid
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" > × < / 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-11-11 00:21:43 +00:00
on Nov 11th 2023
2023-10-27 02:19:51 +00:00
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 >
