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/home/LoadItemsTask.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-27 12:27:26 +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 >
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/home/LoadItemsTask.brs< / h1 >
< section >
< article >
< pre
class="sunlight-highlight-javascript linenums">import "pkg:/source/api/Items.brs"
2023-10-06 03:18:36 +00:00
import "pkg:/source/api/baserequest.brs"
import "pkg:/source/utils/config.brs"
import "pkg:/source/utils/misc.brs"
import "pkg:/source/utils/deviceCapabilities.brs"
import "pkg:/source/api/Image.brs"
import "pkg:/source/api/sdk.bs"
sub init()
m.top.functionName = "loadItems"
end sub
sub loadItems()
results = []
' Load Libraries
if m.top.itemsToLoad = "libraries"
url = Substitute("Users/{0}/Views/", m.global.session.user.id)
resp = APIRequest(url)
data = getJson(resp)
if isValid(data) and isValid(data.Items)
for each item in data.Items
' Skip Books for now as we don't support it (issue #525)
if item.CollectionType < > "books"
tmp = CreateObject("roSGNode", "HomeData")
tmp.json = item
results.push(tmp)
end if
end for
end if
' Load Latest Additions to Libraries
else if m.top.itemsToLoad = "latest"
activeUser = m.global.session.user.id
if isValid(activeUser)
url = Substitute("Users/{0}/Items/Latest", activeUser)
params = {}
params["Limit"] = 16
params["ParentId"] = m.top.itemId
params["EnableImageTypes"] = "Primary,Backdrop,Thumb"
params["ImageTypeLimit"] = 1
params["EnableTotalRecordCount"] = false
resp = APIRequest(url, params)
data = getJson(resp)
if isValid(data)
for each item in data
' Skip Books for now as we don't support it (issue #525)
if item.Type < > "Book"
tmp = CreateObject("roSGNode", "HomeData")
tmp.json = item
results.push(tmp)
end if
end for
end if
end if
' Load Next Up
else if m.top.itemsToLoad = "nextUp"
url = "Shows/NextUp"
params = {}
params["recursive"] = true
params["SortBy"] = "DatePlayed"
params["SortOrder"] = "Descending"
params["ImageTypeLimit"] = 1
params["UserId"] = m.global.session.user.id
params["EnableRewatching"] = false
params["DisableFirstEpisode"] = false
params["limit"] = 24
params["EnableTotalRecordCount"] = false
maxDaysInNextUp = m.global.session.user.settings["ui.details.maxdaysnextup"].ToInt()
if isValid(maxDaysInNextUp)
if maxDaysInNextUp > 0
dateToday = CreateObject("roDateTime")
dateCutoff = CreateObject("roDateTime")
dateCutoff.FromSeconds(dateToday.AsSeconds() - (maxDaysInNextUp * 86400))
params["NextUpDateCutoff"] = dateCutoff.ToISOString()
end if
end if
resp = APIRequest(url, params)
data = getJson(resp)
if isValid(data) and isValid(data.Items)
for each item in data.Items
tmp = CreateObject("roSGNode", "HomeData")
tmp.json = item
results.push(tmp)
end for
end if
' Load Continue Watching
else if m.top.itemsToLoad = "continue"
activeUser = m.global.session.user.id
if isValid(activeUser)
url = Substitute("Users/{0}/Items/Resume", activeUser)
params = {}
params["recursive"] = true
params["SortBy"] = "DatePlayed"
params["SortOrder"] = "Descending"
params["Filters"] = "IsResumable"
params["EnableTotalRecordCount"] = false
resp = APIRequest(url, params)
data = getJson(resp)
if isValid(data) and isValid(data.Items)
for each item in data.Items
' Skip Books for now as we don't support it (issue #558)
if item.Type < > "Book"
tmp = CreateObject("roSGNode", "HomeData")
tmp.json = item
results.push(tmp)
end if
end for
end if
end if
else if m.top.itemsToLoad = "favorites"
url = Substitute("Users/{0}/Items", m.global.session.user.id)
params = {}
params["Filters"] = "IsFavorite"
params["Limit"] = 20
params["recursive"] = true
params["sortby"] = "random"
params["EnableTotalRecordCount"] = false
resp = APIRequest(url, params)
data = getJson(resp)
if isValid(data) and isValid(data.Items)
for each item in data.Items
' Skip Books for now as we don't support it (issue #558)
if item.Type < > "Book"
tmp = CreateObject("roSGNode", "HomeData")
params = {}
params["Tags"] = item.PrimaryImageTag
params["MaxWidth"] = 234
params["MaxHeight"] = 330
tmp.posterURL = ImageUrl(item.Id, "Primary", params)
tmp.json = item
results.push(tmp)
end if
end for
end if
else if m.top.itemsToLoad = "onNow"
url = "LiveTv/Programs/Recommended"
params = {}
params["userId"] = m.global.session.user.id
params["isAiring"] = true
params["limit"] = 16 ' 16 to be consistent with "Latest In"
params["imageTypeLimit"] = 1
params["enableImageTypes"] = "Primary,Thumb,Backdrop"
params["enableTotalRecordCount"] = false
params["fields"] = "ChannelInfo,PrimaryImageAspectRatio"
resp = APIRequest(url, params)
data = getJson(resp)
if isValid(data) and isValid(data.Items)
for each item in data.Items
tmp = CreateObject("roSGNode", "HomeData")
item.ImageURL = ImageURL(item.Id)
tmp.json = item
results.push(tmp)
end for
end if
' Extract array of persons from Views and download full metadata for each
else if m.top.itemsToLoad = "people"
for each person in m.top.peopleList
tmp = CreateObject("roSGNode", "ExtrasData")
tmp.Id = person.Id
tmp.labelText = person.Name
params = {}
params["Tags"] = person.PrimaryImageTag
params["MaxWidth"] = 234
params["MaxHeight"] = 330
tmp.posterURL = ImageUrl(person.Id, "Primary", params)
tmp.json = person
results.push(tmp)
end for
else if m.top.itemsToLoad = "specialfeatures"
params = {}
url = Substitute("Users/{0}/Items/{1}/SpecialFeatures", m.global.session.user.id, m.top.itemId)
resp = APIRequest(url, params)
data = getJson(resp)
if data < > invalid and data.count() > 0
for each specfeat in data
tmp = CreateObject("roSGNode", "ExtrasData")
results.push(tmp)
params = {}
params["Tags"] = specfeat.ImageTags.Primary
params["MaxWidth"] = 450
params["MaxHeight"] = 402
tmp.posterURL = ImageUrl(specfeat.Id, "Primary", params)
tmp.json = specfeat
end for
end if
else if m.top.itemsToLoad = "additionalparts"
additionalParts = api.videos.GetAdditionalParts(m.top.itemId)
if isValid(additionalParts)
for each part in additionalParts.items
tmp = CreateObject("roSGNode", "ExtrasData")
params = {}
params["Tags"] = part.ImageTags.Primary
params["MaxWidth"] = 450
params["MaxHeight"] = 402
tmp.posterURL = ImageUrl(part.Id, "Primary", params)
tmp.json = part
results.push(tmp)
end for
end if
else if m.top.itemsToLoad = "likethis"
params = { "userId": m.global.session.user.id, "limit": 16 }
url = Substitute("Items/{0}/Similar", m.top.itemId)
resp = APIRequest(url, params)
data = getJson(resp)
if isValid(data) and isValid(data.Items)
for each item in data.items
tmp = CreateObject("roSGNode", "ExtrasData")
tmp.posterURL = ImageUrl(item.Id, "Primary", { "Tags": item.PrimaryImageTag })
tmp.json = item
results.push(tmp)
end for
end if
else if m.top.itemsToLoad = "personMovies"
getPersonVideos("Movie", results, {})
else if m.top.itemsToLoad = "personTVShows"
getPersonVideos("Episode", results, { MaxWidth: 502, MaxHeight: 300 })
else if m.top.itemsToLoad = "personSeries"
getPersonVideos("Series", results, {})
else if m.top.itemsToLoad = "metaData"
results.push(ItemMetaData(m.top.itemId))
else if m.top.itemsToLoad = "audioStream"
results.push(AudioStream(m.top.itemId))
else if m.top.itemsToLoad = "backdropImage"
results.push(BackdropImage(m.top.itemId))
end if
m.top.content = results
end sub
sub getPersonVideos(videoType, dest, dimens)
params = { personIds: m.top.itemId, recursive: true, includeItemTypes: videoType, Limit: 50, SortBy: "Random" }
url = Substitute("Users/{0}/Items", m.global.session.user.id)
resp = APIRequest(url, params)
data = getJson(resp)
if data < > invalid and data.count() > 0
for each item in data.items
tmp = CreateObject("roSGNode", "ExtrasData")
imgParms = { "Tags": item.ImageTags.Primary }
imgParms.append(dimens)
tmp.posterURL = ImageUrl(item.Id, "Primary", imgParms)
tmp.json = item
dest.push(tmp)
end for
end if
end sub
2023-10-27 02:19:51 +00:00
< / 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-10-27 02:20:25 +00:00
on Oct 27th 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 >
