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 Module: config< / 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 >
< / 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-8" >
< div id = "main" >
< h1 class = "page-title" > Module: config< / h1 >
< section >
< header >
< / header >
< article >
< div class = "container-overview" >
< dl class = "details" >
< dt class = "tag-source method-doc-label method-doc-details-label" > Source:< / dt >
< dd class = "tag-source" >
< ul class = "dummy" >
< li >
< a href = "source_utils_config.brs.html" > source/utils/config.brs< / a > ,
< a href = "source_utils_config.brs.html#sunlight-1-line-1" > line 1< / a >
< / li >
< / ul >
< / dd >
< / dl >
< / div >
< h3 class = "subsection-title" > Methods< / h3 >
< dl >
< hr >
< dt >
< h4 class = "name" id = ".GetConfigTree" > < span class = "type-signature" > < static> < / span > GetConfigTree()< / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Read config tree from json config file and return< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source method-doc-label method-doc-details-label" > Source:< / dt >
< dd class = "tag-source" >
< ul class = "dummy" >
< li >
< a href = "source_utils_config.brs.html" > source/utils/config.brs< / a > ,
< a href = "source_utils_config.brs.html#sunlight-1-line-9" > line 9< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > dynamic< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".RegistryReadAll" > < span class = "type-signature" > < static> < / span > RegistryReadAll(section)< / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Return all data found inside a registry section< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > section< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source method-doc-label method-doc-details-label" > Source:< / dt >
< dd class = "tag-source" >
< ul class = "dummy" >
< li >
< a href = "source_utils_config.brs.html" > source/utils/config.brs< / a > ,
< a href = "source_utils_config.brs.html#sunlight-1-line-43" > line 43< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > dynamic< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".findConfigTreeKey" > < span class = "type-signature" > < static> < / span > findConfigTreeKey(key, tree)< / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Recursivly search the config tree for entry with settingname equal to key< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > tree< / code > < / td >
< td class = "type" >
< span class = "param-type" > dynamic< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source method-doc-label method-doc-details-label" > Source:< / dt >
< dd class = "tag-source" >
< ul class = "dummy" >
< li >
< a href = "source_utils_config.brs.html" > source/utils/config.brs< / a > ,
< a href = "source_utils_config.brs.html#sunlight-1-line-99" > line 99< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > dynamic< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".get_setting" > < span class = "type-signature" > < static> < / span > get_setting(key [, defaultValue])< / h4 >
< / dt >
< dd >
< div class = "description" >
< p > " Jellyfin" registry accessors for the default global settings< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > dynamic< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > defaultValue< / code > < / td >
< td class = "type" >
< span class = "param-type" > dynamic< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
invalid
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source method-doc-label method-doc-details-label" > Source:< / dt >
< dd class = "tag-source" >
< ul class = "dummy" >
< li >
< a href = "source_utils_config.brs.html" > source/utils/config.brs< / a > ,
< a href = "source_utils_config.brs.html#sunlight-1-line-52" > line 52< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > dynamic< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".get_user_setting" > < span class = "type-signature" > < static> < / span > get_user_setting(key)< / h4 >
< / dt >
< dd >
< div class = "description" >
< p > User registry accessors for the currently active user< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source method-doc-label method-doc-details-label" > Source:< / dt >
< dd class = "tag-source" >
< ul class = "dummy" >
< li >
< a href = "source_utils_config.brs.html" > source/utils/config.brs< / a > ,
< a href = "source_utils_config.brs.html#sunlight-1-line-75" > line 75< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > dynamic< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".registry_delete" > < span class = "type-signature" > < static> < / span > registry_delete(key [, section])< / h4 >
< / dt >
< dd >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > dynamic< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > section< / code > < / td >
< td class = "type" >
< span class = "param-type" > dynamic< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
invalid
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source method-doc-label method-doc-details-label" > Source:< / dt >
< dd class = "tag-source" >
< ul class = "dummy" >
< li >
< a href = "source_utils_config.brs.html" > source/utils/config.brs< / a > ,
< a href = "source_utils_config.brs.html#sunlight-1-line-35" > line 35< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > void< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".registry_read" > < span class = "type-signature" > < static> < / span > registry_read(key [, section])< / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Generic registry accessors< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > dynamic< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > section< / code > < / td >
< td class = "type" >
< span class = "param-type" > dynamic< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
invalid
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source method-doc-label method-doc-details-label" > Source:< / dt >
< dd class = "tag-source" >
< ul class = "dummy" >
< li >
< a href = "source_utils_config.brs.html" > source/utils/config.brs< / a > ,
< a href = "source_utils_config.brs.html#sunlight-1-line-18" > line 18< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > dynamic< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".registry_write" > < span class = "type-signature" > < static> < / span > registry_write(key, value [, section])< / h4 >
< / dt >
< dd >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > dynamic< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > dynamic< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > section< / code > < / td >
< td class = "type" >
< span class = "param-type" > dynamic< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
invalid
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source method-doc-label method-doc-details-label" > Source:< / dt >
< dd class = "tag-source" >
< ul class = "dummy" >
< li >
< a href = "source_utils_config.brs.html" > source/utils/config.brs< / a > ,
< a href = "source_utils_config.brs.html#sunlight-1-line-27" > line 27< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > void< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".set_setting" > < span class = "type-signature" > < static> < / span > set_setting(key, value)< / h4 >
< / dt >
< dd >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > dynamic< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > dynamic< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source method-doc-label method-doc-details-label" > Source:< / dt >
< dd class = "tag-source" >
< ul class = "dummy" >
< li >
< a href = "source_utils_config.brs.html" > source/utils/config.brs< / a > ,
< a href = "source_utils_config.brs.html#sunlight-1-line-60" > line 60< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > void< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".set_user_setting" > < span class = "type-signature" > < static> < / span > set_user_setting(key, value)< / h4 >
< / dt >
< dd >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > dynamic< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source method-doc-label method-doc-details-label" > Source:< / dt >
< dd class = "tag-source" >
< ul class = "dummy" >
< li >
< a href = "source_utils_config.brs.html" > source/utils/config.brs< / a > ,
< a href = "source_utils_config.brs.html#sunlight-1-line-83" > line 83< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > void< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".unset_setting" > < span class = "type-signature" > < static> < / span > unset_setting(key)< / h4 >
< / dt >
< dd >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > dynamic< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source method-doc-label method-doc-details-label" > Source:< / dt >
< dd class = "tag-source" >
< ul class = "dummy" >
< li >
< a href = "source_utils_config.brs.html" > source/utils/config.brs< / a > ,
< a href = "source_utils_config.brs.html#sunlight-1-line-67" > line 67< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > void< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".unset_user_setting" > < span class = "type-signature" > < static> < / span > unset_user_setting(key)< / h4 >
< / dt >
< dd >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source method-doc-label method-doc-details-label" > Source:< / dt >
< dd class = "tag-source" >
< ul class = "dummy" >
< li >
< a href = "source_utils_config.brs.html" > source/utils/config.brs< / a > ,
< a href = "source_utils_config.brs.html#sunlight-1-line-90" > line 90< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > void< / span >
< / dd >
< / dl >
< / dd >
< / dl >
< / article >
< / section >
< / div >
< / div >
< div class = "clearfix" > < / div >
< div class = "col-md-3" >
< div id = "toc" class = "col-md-3 hidden-xs hidden-sm hidden-md" > < / div >
< / 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 >
