711 lines
29 KiB
HTML
711 lines
29 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width">
|
|
<title>jellyfin-roku api docs Source: source/api/Items.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 ">
|
|
<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><a href="module-OptionsSlider.html">OptionsSlider</a></li><li><a href="module-OverviewDialog.html">OverviewDialog</a></li><li><a href="module-PersonData.html">PersonData</a></li><li><a href="module-PersonDetails.html">PersonDetails</a></li><li><a href="module-PhotoData.html">PhotoData</a></li><li><a href="module-PhotoDetails.html">PhotoDetails</a></li><li><a href="module-PlaybackDialog.html">PlaybackDialog</a></li><li><a href="module-PlayedCheckmark.html">PlayedCheckmark</a></li><li><a href="module-PlaylistData.html">PlaylistData</a></li><li><a href="module-PlaylistView.html">PlaylistView</a></li><li><a href="module-PlaystateTask.html">PlaystateTask</a></li><li><a href="module-ProgramDetails.html">ProgramDetails</a></li><li><a href="module-PublicUserData.html">PublicUserData</a></li><li><a href="module-QueueManager.html">QueueManager</a></li><li><a href="module-QuickConnect.html">QuickConnect</a></li><li><a href="module-QuickConnectDialog.html">QuickConnectDialog</a></li><li><a href="module-RadioDialog.html">RadioDialog</a></li><li><a href="module-RecordProgramTask.html">RecordProgramTask</a></li><li><a href="module-SceneManager.html">SceneManager</a></li><li><a href="module-ScheduleProgramData.html">ScheduleProgramData</a></li><li><a href="module-SearchBox.html">SearchBox</a></li><li><a href="module-SearchData.html">SearchData</a></li><li><a href="module-SearchResults.html">SearchResults</a></li><li><a href="module-SearchRow.html">SearchRow</a></li><li><a href="module-SearchTask.html">SearchTask</a></li><li><a href="module-SeriesData.html">SeriesData</a></li><li><a href="module-ServerDiscoveryTask.html">ServerDiscoveryTask</a></li><li><a href="module-SetServerScreen.html">SetServerScreen</a></li><li><a href="module-ShowScenes.html">ShowScenes</a></li><li><a href="module-SongItem.html">SongItem</a></li><li><a href="module-Spinner.html">Spinner</a></li><li><a href="module-StandardDialog.html">StandardDialog</a></li><li><a href="module-Subtitles.html">Subtitles</a></li><li><a href="module-TVEpisode.html">TVEpisode</a></li><li><a href="module-TVEpisodeData.html">TVEpisodeData</a></li><li><a href="module-TVEpisodeRow.html">TVEpisodeRow</a></li><li><a href="module-TVEpisodeRowWithOptions.html">TVEpisodeRowWithOptions</a></li><li><a href="module-TVEpisodes.html">TVEpisodes</a></li><li><a href="module-TVListDetails.html">TVListDetails</a></li><li><a href="module-TVListOptions.html">TVListOptions</a></li><li><a href="module-TVSeasonData.html">TVSeasonData</a></li><li><a href="module-TVSeasonRow.html">TVSeasonRow</a></li><li><a href="module-TVShowDescription.html">TVShowDescription</a></li><li><a href="module-TVShowDetails.html">TVShowDetails</a></li><li><a href="module-TextSizeTask.html">TextSizeTask</a></li><li><a href="module-UserData.html">UserData</a></li><li><a href="module-UserItem.html">UserItem</a></li><li><a href="module-UserLibrary.html">UserLibrary</a></li><li><a href="module-UserRow.html">UserRow</a></li><li><a href="module-UserSelect.html">UserSelect</a></li><li><a href="module-VideoData.html">VideoData</a></li><li><a href="module-VideoPlayer.html">VideoPlayer</a></li><li><a href="module-VideoPlayerView.html">VideoPlayerView</a></li><li><a href="module-VideoTrackListItem.html">VideoTrackListItem</a></li><li><a href="module-ViewCreator.html">ViewCreator</a></li><li><a href="module-WhatsNewDialog.html">WhatsNewDialog</a></li><li><a href="module-baserequest.html">baserequest</a></li><li><a href="module-captionTask.html">captionTask</a></li><li><a href="module-config.html">config</a></li><li><a href="module-deviceCapabilities.html">deviceCapabilities</a></li><li><a href="module-globals.html">globals</a></li><li><a href="module-migrations.html">migrations</a></li><li><a href="module-misc.html">misc</a></li><li><a href="module-quickplay.html">quickplay</a></li><li><a href="module-schedule.html">schedule</a></li><li><a href="module-section.html">section</a></li><li><a href="module-sectionScroller.html">sectionScroller</a></li><li><a href="module-settings.html">settings</a></li><li><a href="module-userauth.html">userauth</a></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: source/api/Items.brs</h1>
|
|
|
|
<section>
|
|
<article>
|
|
<pre
|
|
class="sunlight-highlight-javascript linenums">import "pkg:/source/api/sdk.bs"
|
|
|
|
function ItemGetPlaybackInfo(id as string, startTimeTicks = 0 as longinteger)
|
|
params = {
|
|
"UserId": m.global.session.user.id,
|
|
"StartTimeTicks": startTimeTicks,
|
|
"IsPlayback": true,
|
|
"AutoOpenLiveStream": true,
|
|
"MaxStreamingBitrate": "140000000"
|
|
}
|
|
resp = APIRequest(Substitute("Items/{0}/PlaybackInfo", id), params)
|
|
return getJson(resp)
|
|
end function
|
|
|
|
function ItemPostPlaybackInfo(id as string, mediaSourceId = "" as string, audioTrackIndex = -1 as integer, subtitleTrackIndex = -1 as integer, startTimeTicks = 0 as longinteger)
|
|
body = {
|
|
"DeviceProfile": getDeviceProfile()
|
|
}
|
|
params = {
|
|
"UserId": m.global.session.user.id,
|
|
"StartTimeTicks": startTimeTicks,
|
|
"IsPlayback": true,
|
|
"AutoOpenLiveStream": true,
|
|
"MaxStreamingBitrate": "140000000",
|
|
"MaxStaticBitrate": "140000000",
|
|
"SubtitleStreamIndex": subtitleTrackIndex
|
|
}
|
|
|
|
if mediaSourceId <> "" then params.MediaSourceId = mediaSourceId
|
|
|
|
if audioTrackIndex > -1 then params.AudioStreamIndex = audioTrackIndex
|
|
|
|
req = APIRequest(Substitute("Items/{0}/PlaybackInfo", id), params)
|
|
req.SetRequest("POST")
|
|
return postJson(req, FormatJson(body))
|
|
end function
|
|
|
|
' Search across all libraries
|
|
function searchMedia(query as string)
|
|
' This appears to be done differently on the web now
|
|
' For each potential type, a separate query is done:
|
|
' varying item types, and artists, and people
|
|
if query <> ""
|
|
resp = APIRequest(Substitute("Search/Hints", m.global.session.user.id), {
|
|
"searchTerm": query,
|
|
"IncludePeople": true,
|
|
"IncludeMedia": true,
|
|
"IncludeShows": true,
|
|
"IncludeGenres": true,
|
|
"IncludeStudios": true,
|
|
"IncludeArtists": true,
|
|
"IncludeItemTypes": "LiveTvChannel,Movie,BoxSet,Series,Episode,Video,Person,Audio,MusicAlbum,MusicArtist,Playlist",
|
|
"EnableTotalRecordCount": false,
|
|
"ImageTypeLimit": 1,
|
|
"Recursive": true,
|
|
"limit": 100
|
|
})
|
|
|
|
data = getJson(resp)
|
|
results = []
|
|
for each item in data.SearchHints
|
|
tmp = CreateObject("roSGNode", "SearchData")
|
|
tmp.image = PosterImage(item.id)
|
|
tmp.json = item
|
|
results.push(tmp)
|
|
end for
|
|
data.SearchHints = results
|
|
return data
|
|
end if
|
|
return []
|
|
end function
|
|
|
|
' MetaData about an item
|
|
function ItemMetaData(id as string)
|
|
url = Substitute("Users/{0}/Items/{1}", m.global.session.user.id, id)
|
|
resp = APIRequest(url)
|
|
data = getJson(resp)
|
|
if data = invalid then return invalid
|
|
|
|
imgParams = {}
|
|
if data.type <> "Audio"
|
|
if data.UserData <> invalid and data.UserData.PlayedPercentage <> invalid
|
|
param = { "PercentPlayed": data.UserData.PlayedPercentage }
|
|
imgParams.Append(param)
|
|
end if
|
|
end if
|
|
if data.type = "Movie" or data.type = "MusicVideo"
|
|
tmp = CreateObject("roSGNode", "MovieData")
|
|
tmp.image = PosterImage(data.id, imgParams)
|
|
tmp.json = data
|
|
return tmp
|
|
else if data.type = "Series"
|
|
tmp = CreateObject("roSGNode", "SeriesData")
|
|
tmp.image = PosterImage(data.id)
|
|
tmp.json = data
|
|
return tmp
|
|
else if data.type = "Episode"
|
|
' param = { "AddPlayedIndicator": data.UserData.Played }
|
|
' imgParams.Append(param)
|
|
tmp = CreateObject("roSGNode", "TVEpisodeData")
|
|
tmp.image = PosterImage(data.id, imgParams)
|
|
tmp.json = data
|
|
return tmp
|
|
else if data.type = "BoxSet" or data.type = "Playlist"
|
|
tmp = CreateObject("roSGNode", "CollectionData")
|
|
tmp.image = PosterImage(data.id, imgParams)
|
|
tmp.json = data
|
|
return tmp
|
|
else if data.type = "Season"
|
|
tmp = CreateObject("roSGNode", "TVSeasonData")
|
|
tmp.image = PosterImage(data.id)
|
|
tmp.json = data
|
|
return tmp
|
|
else if data.type = "Video"
|
|
tmp = CreateObject("roSGNode", "VideoData")
|
|
tmp.image = PosterImage(data.id)
|
|
tmp.json = data
|
|
return tmp
|
|
else if data.type = "Trailer"
|
|
tmp = CreateObject("roSGNode", "VideoData")
|
|
tmp.json = data
|
|
return tmp
|
|
else if data.type = "TvChannel" or data.type = "Program"
|
|
tmp = CreateObject("roSGNode", "ChannelData")
|
|
tmp.image = PosterImage(data.id)
|
|
tmp.isFavorite = data.UserData.isFavorite
|
|
tmp.json = data
|
|
return tmp
|
|
else if data.type = "Person"
|
|
tmp = CreateObject("roSGNode", "PersonData")
|
|
tmp.image = PosterImage(data.id, { "MaxWidth": 300, "MaxHeight": 450 })
|
|
tmp.json = data
|
|
return tmp
|
|
else if data.type = "MusicArtist"
|
|
' User clicked on an artist and wants to see the list of their albums
|
|
tmp = CreateObject("roSGNode", "MusicArtistData")
|
|
tmp.image = PosterImage(data.id)
|
|
tmp.json = data
|
|
return tmp
|
|
else if data.type = "MusicAlbum"
|
|
' User clicked on an album and wants to see the list of songs
|
|
tmp = CreateObject("roSGNode", "MusicAlbumSongListData")
|
|
tmp.image = PosterImage(data.id)
|
|
tmp.json = data
|
|
return tmp
|
|
else if data.type = "Audio"
|
|
' User clicked on a song and wants it to play
|
|
tmp = CreateObject("roSGNode", "MusicSongData")
|
|
|
|
' Try using song's parent for poster image
|
|
tmp.image = PosterImage(data.ParentId, { "MaxWidth": 500, "MaxHeight": 500 })
|
|
|
|
' Song's parent poster image is no good, try using the song's poster image
|
|
if tmp.image = invalid
|
|
tmp.image = PosterImage(data.id, { "MaxWidth": 500, "MaxHeight": 500 })
|
|
end if
|
|
|
|
tmp.json = data
|
|
return tmp
|
|
else if data.type = "Recording"
|
|
' We know it's "Recording", but we don't do any special preprocessing
|
|
' for this data type at the moment, so just return the json.
|
|
return data
|
|
else
|
|
print "Items.brs::ItemMetaData processed unhandled type: " data.type
|
|
' Return json if we don't know what it is
|
|
return data
|
|
end if
|
|
end function
|
|
|
|
' Music Artist Data
|
|
function ArtistOverview(name as string)
|
|
req = createObject("roUrlTransfer")
|
|
url = Substitute("Artists/{0}", req.escape(name))
|
|
resp = APIRequest(url)
|
|
data = getJson(resp)
|
|
if data = invalid then return invalid
|
|
return data.overview
|
|
end function
|
|
|
|
' Get list of albums belonging to an artist
|
|
function MusicAlbumList(id as string)
|
|
url = Substitute("Users/{0}/Items", m.global.session.user.id)
|
|
resp = APIRequest(url, {
|
|
"AlbumArtistIds": id,
|
|
"includeitemtypes": "MusicAlbum",
|
|
"sortBy": "SortName",
|
|
"Recursive": true
|
|
})
|
|
|
|
data = getJson(resp)
|
|
results = []
|
|
for each item in data.Items
|
|
tmp = CreateObject("roSGNode", "MusicAlbumData")
|
|
tmp.image = PosterImage(item.id)
|
|
tmp.json = item
|
|
results.push(tmp)
|
|
end for
|
|
data.Items = results
|
|
return data
|
|
end function
|
|
|
|
' Get list of albums an artist appears on
|
|
function AppearsOnList(id as string)
|
|
url = Substitute("Users/{0}/Items", m.global.session.user.id)
|
|
resp = APIRequest(url, {
|
|
"ContributingArtistIds": id,
|
|
"ExcludeItemIds": id,
|
|
"includeitemtypes": "MusicAlbum",
|
|
"sortBy": "PremiereDate,ProductionYear,SortName",
|
|
"SortOrder": "Descending",
|
|
"Recursive": true
|
|
})
|
|
|
|
data = getJson(resp)
|
|
results = []
|
|
for each item in data.Items
|
|
tmp = CreateObject("roSGNode", "MusicAlbumData")
|
|
tmp.image = PosterImage(item.id)
|
|
tmp.json = item
|
|
results.push(tmp)
|
|
end for
|
|
data.Items = results
|
|
return data
|
|
end function
|
|
|
|
' Get list of songs belonging to an artist
|
|
function GetSongsByArtist(id as string, params = {} as object)
|
|
url = Substitute("Users/{0}/Items", m.global.session.user.id)
|
|
paramArray = {
|
|
"AlbumArtistIds": id,
|
|
"includeitemtypes": "Audio",
|
|
"sortBy": "SortName",
|
|
"Recursive": true
|
|
}
|
|
' overwrite defaults with the params provided
|
|
for each param in params
|
|
paramArray.AddReplace(param, params[param])
|
|
end for
|
|
|
|
resp = APIRequest(url, paramArray)
|
|
data = getJson(resp)
|
|
results = []
|
|
|
|
if data = invalid then return invalid
|
|
if data.Items = invalid then return invalid
|
|
if data.Items.Count() = 0 then return invalid
|
|
|
|
for each item in data.Items
|
|
tmp = CreateObject("roSGNode", "MusicAlbumData")
|
|
tmp.image = PosterImage(item.id)
|
|
tmp.json = item
|
|
results.push(tmp)
|
|
end for
|
|
data.Items = results
|
|
return data
|
|
end function
|
|
|
|
' Get Items that are under the provided item
|
|
function PlaylistItemList(id as string)
|
|
url = Substitute("Playlists/{0}/Items", id)
|
|
resp = APIRequest(url, {
|
|
"UserId": m.global.session.user.id
|
|
})
|
|
|
|
results = []
|
|
data = getJson(resp)
|
|
|
|
if data = invalid then return invalid
|
|
if data.Items = invalid then return invalid
|
|
if data.Items.Count() = 0 then return invalid
|
|
|
|
for each item in data.Items
|
|
tmp = CreateObject("roSGNode", "PlaylistData")
|
|
tmp.image = PosterImage(item.id)
|
|
tmp.json = item
|
|
results.push(tmp)
|
|
end for
|
|
data.Items = results
|
|
return data
|
|
end function
|
|
|
|
' Get Songs that are on an Album
|
|
function MusicSongList(id as string)
|
|
url = Substitute("Users/{0}/Items", m.global.session.user.id, id)
|
|
resp = APIRequest(url, {
|
|
"UserId": m.global.session.user.id,
|
|
"parentId": id,
|
|
"includeitemtypes": "Audio",
|
|
"sortBy": "SortName"
|
|
})
|
|
|
|
results = []
|
|
data = getJson(resp)
|
|
|
|
if data = invalid then return invalid
|
|
if data.Items = invalid then return invalid
|
|
if data.Items.Count() = 0 then return invalid
|
|
|
|
for each item in data.Items
|
|
tmp = CreateObject("roSGNode", "MusicSongData")
|
|
tmp.image = PosterImage(item.id)
|
|
tmp.json = item
|
|
results.push(tmp)
|
|
end for
|
|
data.Items = results
|
|
return data
|
|
end function
|
|
|
|
' Get Songs that are on an Album
|
|
function AudioItem(id as string)
|
|
url = Substitute("Users/{0}/Items/{1}", m.global.session.user.id, id)
|
|
resp = APIRequest(url, {
|
|
"UserId": m.global.session.user.id,
|
|
"includeitemtypes": "Audio",
|
|
"sortBy": "SortName"
|
|
})
|
|
|
|
return getJson(resp)
|
|
end function
|
|
|
|
' Get Instant Mix based on item
|
|
function CreateInstantMix(id as string)
|
|
url = Substitute("/Items/{0}/InstantMix", id)
|
|
resp = APIRequest(url, {
|
|
"UserId": m.global.session.user.id,
|
|
"Limit": 201
|
|
})
|
|
|
|
return getJson(resp)
|
|
end function
|
|
|
|
' Get Instant Mix based on item
|
|
function CreateArtistMix(id as string)
|
|
url = Substitute("Users/{0}/Items", m.global.session.user.id)
|
|
resp = APIRequest(url, {
|
|
"ArtistIds": id,
|
|
"Recursive": "true",
|
|
"MediaTypes": "Audio",
|
|
"Filters": "IsNotFolder",
|
|
"SortBy": "SortName",
|
|
"Limit": 300,
|
|
"Fields": "Chapters",
|
|
"ExcludeLocationTypes": "Virtual",
|
|
"EnableTotalRecordCount": false,
|
|
"CollapseBoxSetItems": false
|
|
})
|
|
|
|
return getJson(resp)
|
|
end function
|
|
|
|
' Get Intro Videos for an item
|
|
function GetIntroVideos(id as string)
|
|
url = Substitute("Users/{0}/Items/{1}/Intros", m.global.session.user.id, id)
|
|
resp = APIRequest(url, {
|
|
"UserId": m.global.session.user.id
|
|
})
|
|
|
|
return getJson(resp)
|
|
end function
|
|
|
|
function AudioStream(id as string)
|
|
songData = AudioItem(id)
|
|
if songData <> invalid
|
|
content = createObject("RoSGNode", "ContentNode")
|
|
if songData.title <> invalid
|
|
content.title = songData.title
|
|
end if
|
|
|
|
playbackInfo = ItemPostPlaybackInfo(songData.id, songData.mediaSources[0].id)
|
|
if playbackInfo <> invalid
|
|
content.id = playbackInfo.PlaySessionId
|
|
|
|
if useTranscodeAudioStream(playbackInfo)
|
|
' Transcode the audio
|
|
content.url = buildURL(playbackInfo.mediaSources[0].TranscodingURL)
|
|
else
|
|
' Direct Stream the audio
|
|
params = {
|
|
"Static": "true",
|
|
"Container": songData.mediaSources[0].container,
|
|
"MediaSourceId": songData.mediaSources[0].id
|
|
}
|
|
content.streamformat = songData.mediaSources[0].container
|
|
content.url = buildURL(Substitute("Audio/{0}/stream", songData.id), params)
|
|
end if
|
|
else
|
|
return invalid
|
|
end if
|
|
|
|
return content
|
|
else
|
|
return invalid
|
|
end if
|
|
end function
|
|
|
|
function useTranscodeAudioStream(playbackInfo)
|
|
return playbackInfo.mediaSources[0] <> invalid and playbackInfo.mediaSources[0].TranscodingURL <> invalid
|
|
end function
|
|
|
|
function BackdropImage(id as string)
|
|
imgParams = { "maxHeight": "720", "maxWidth": "1280" }
|
|
return ImageURL(id, "Backdrop", imgParams)
|
|
end function
|
|
|
|
' Seasons for a TV Show
|
|
function TVSeasons(id as string) as dynamic
|
|
url = Substitute("Shows/{0}/Seasons", id)
|
|
resp = APIRequest(url, { "UserId": m.global.session.user.id })
|
|
|
|
data = getJson(resp)
|
|
' validate data
|
|
if data = invalid or data.Items = invalid then return invalid
|
|
|
|
results = []
|
|
for each item in data.Items
|
|
imgParams = { "AddPlayedIndicator": item.UserData.Played }
|
|
tmp = CreateObject("roSGNode", "TVSeasonData")
|
|
tmp.image = PosterImage(item.id, imgParams)
|
|
tmp.json = item
|
|
results.push(tmp)
|
|
end for
|
|
data.Items = results
|
|
return data
|
|
end function
|
|
|
|
' Returns a list of TV Shows for a given TV Show and season
|
|
' Accepts strings for the TV Show Id and the season Id
|
|
function TVEpisodes(showId as string, seasonId as string) as dynamic
|
|
' Get and validate data
|
|
data = api.shows.GetEpisodes(showId, { "seasonId": seasonId, "UserId": m.global.session.user.id, "fields": "MediaStreams,MediaSources" })
|
|
if data = invalid or data.Items = invalid then return invalid
|
|
|
|
results = []
|
|
for each item in data.Items
|
|
tmp = CreateObject("roSGNode", "TVEpisodeData")
|
|
tmp.image = PosterImage(item.id, { "maxWidth": 400, "maxheight": 250 })
|
|
if isValid(tmp.image)
|
|
tmp.image.posterDisplayMode = "scaleToZoom"
|
|
end if
|
|
tmp.json = item
|
|
tmpMetaData = ItemMetaData(item.id)
|
|
|
|
' validate meta data
|
|
if isValid(tmpMetaData) and isValid(tmpMetaData.overview)
|
|
tmp.overview = tmpMetaData.overview
|
|
end if
|
|
results.push(tmp)
|
|
end for
|
|
data.Items = results
|
|
return data
|
|
end function
|
|
|
|
' Returns a list of extra features for a TV Show season
|
|
' Accepts a string that is a TV Show season id
|
|
function TVSeasonExtras(seasonId as string) as dynamic
|
|
' Get and validate TV extra features data
|
|
data = api.users.GetSpecialFeatures(m.global.session.user.id, seasonId)
|
|
if not isValid(data) then return invalid
|
|
|
|
results = []
|
|
for each item in data
|
|
tmp = CreateObject("roSGNode", "TVEpisodeData")
|
|
tmp.image = PosterImage(item.id, { "maxWidth": 400, "maxheight": 250 })
|
|
if isValid(tmp.image)
|
|
tmp.image.posterDisplayMode = "scaleToZoom"
|
|
end if
|
|
tmp.json = item
|
|
|
|
' Force item type to Video so episode auto queue is not attempted
|
|
tmp.type = "Video"
|
|
tmpMetaData = ItemMetaData(item.id)
|
|
|
|
' Validate meta data
|
|
if isValid(tmpMetaData) and isValid(tmpMetaData.overview)
|
|
tmp.overview = tmpMetaData.overview
|
|
end if
|
|
results.push(tmp)
|
|
end for
|
|
|
|
' Build that data format that the TVEpisodeRow expects
|
|
return { Items: results }
|
|
end function
|
|
|
|
function TVEpisodeShuffleList(show_id as string)
|
|
url = Substitute("Shows/{0}/Episodes", show_id)
|
|
resp = APIRequest(url, {
|
|
"UserId": m.global.session.user.id,
|
|
"Limit": 200,
|
|
"sortBy": "Random"
|
|
})
|
|
|
|
data = getJson(resp)
|
|
results = []
|
|
for each item in data.Items
|
|
tmp = CreateObject("roSGNode", "TVEpisodeData")
|
|
tmp.json = item
|
|
results.push(tmp)
|
|
end for
|
|
data.Items = results
|
|
|
|
return data
|
|
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>
|
|
|
|
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>
|