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: AudioPlayerView< / 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-8" >
< div id = "main" >
< h1 class = "page-title" > Module: AudioPlayerView< / 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.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 = ".LoadNextSong" > < span class = "type-signature" > < static> < / span > LoadNextSong()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-169" > line 169< / 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 = ".OnScreenHidden" > < span class = "type-signature" > < static> < / span > OnScreenHidden()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-248" > line 248< / 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 = ".audioPositionChanged" > < span class = "type-signature" > < static> < / span > audioPositionChanged()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-72" > line 72< / 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 = ".audioStateChanged" > < span class = "type-signature" > < static> < / span > audioStateChanged()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-96" > line 96< / 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 = ".bufferPositionChanged" > < span class = "type-signature" > < static> < / span > bufferPositionChanged()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-66" > line 66< / 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 = ".endScreenSaver" > < span class = "type-signature" > < static> < / span > endScreenSaver()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.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 >
< hr >
< dt >
< h4 class = "name" id = ".findCurrentSongIndex" > < span class = "type-signature" > < static> < / span > findCurrentSongIndex(songList)< / 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 > songList< / 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-145" > line 145< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > integer< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".init" > < span class = "type-signature" > < static> < / span > init()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-8" > line 8< / 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 = ".loadButtons" > < span class = "type-signature" > < static> < / span > loadButtons()< / h4 >
< / dt >
< dd >
< div class = "description" >
< p > If we have more and 1 song to play, fade in the next and previous controls< / 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-183" > line 183< / 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 = ".loopClicked" > < span class = "type-signature" > < static> < / span > loopClicked()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-120" > line 120< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".nextClicked" > < span class = "type-signature" > < static> < / span > nextClicked()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-132" > line 132< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".onAudioStreamLoaded" > < span class = "type-signature" > < static> < / span > onAudioStreamLoaded()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-189" > line 189< / 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 = ".onBackdropImageLoaded" > < span class = "type-signature" > < static> < / span > onBackdropImageLoaded()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-195" > line 195< / 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 = ".onButtonSelectedChange" > < span class = "type-signature" > < static> < / span > onButtonSelectedChange()< / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Event handler when user selected a different playback button< / 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-54" > line 54< / 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 = ".onKeyEvent" > < span class = "type-signature" > < static> < / span > onKeyEvent(key, press)< / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Process key press events< / 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 > press< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-242" > line 242< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".onMetaDataLoaded" > < span class = "type-signature" > < static> < / span > onMetaDataLoaded()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-201" > line 201< / 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 = ".onScreensaverTimeoutLoaded" > < span class = "type-signature" > < static> < / span > onScreensaverTimeoutLoaded()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-14" > line 14< / 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 = ".pageContentChanged" > < span class = "type-signature" > < static> < / span > pageContentChanged()< / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Update values on screen when page content changes< / 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-176" > line 176< / 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 = ".playAction" > < span class = "type-signature" > < static> < / span > playAction()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-102" > line 102< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".previousClicked" > < span class = "type-signature" > < static> < / span > previousClicked()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-108" > line 108< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".resetLoopModeToDefault" > < span class = "type-signature" > < static> < / span > resetLoopModeToDefault()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-114" > line 114< / 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 = ".screenSaverActive" > < span class = "type-signature" > < static> < / span > screenSaverActive()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-78" > line 78< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".setBackdropImage" > < span class = "type-signature" > < static> < / span > setBackdropImage(data)< / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Add backdrop image to screen< / 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 > data< / 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-233" > line 233< / 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 = ".setLoopButtonImage" > < span class = "type-signature" > < static> < / span > setLoopButtonImage()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-126" > line 126< / 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 = ".setOnScreenTextValues" > < span class = "type-signature" > < static> < / span > setOnScreenTextValues(json)< / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Populate on screen text variables< / 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 > json< / 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-225" > line 225< / 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 = ".setPosterImage" > < span class = "type-signature" > < static> < / span > setPosterImage(posterURL)< / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Set poster image on screen< / 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 > posterURL< / 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-209" > line 209< / 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 = ".setScreenTitle" > < span class = "type-signature" > < static> < / span > setScreenTitle(json)< / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Set screen's title text< / 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 > json< / 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-217" > line 217< / 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 = ".setShuffleIconState" > < span class = "type-signature" > < static> < / span > setShuffleIconState()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-157" > line 157< / 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 = ".setTrackNumberDisplay" > < span class = "type-signature" > < static> < / span > setTrackNumberDisplay()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-163" > line 163< / 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 = ".setupAnimationTasks" > < span class = "type-signature" > < static> < / span > setupAnimationTasks()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-26" > line 26< / 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 = ".setupAudioNode" > < span class = "type-signature" > < static> < / span > setupAudioNode()< / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Creates audio node used to play song(s)< / 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-40" > line 40< / 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 = ".setupButtons" > < span class = "type-signature" > < static> < / span > setupButtons()< / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Setup playback buttons, default to Play button selected< / 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-47" > line 47< / 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 = ".setupDataTasks" > < span class = "type-signature" > < static> < / span > setupDataTasks()< / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Creates tasks to gather data needed to render Scene and play song< / 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-33" > line 33< / 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 = ".setupInfoNodes" > < span class = "type-signature" > < static> < / span > setupInfoNodes()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.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 = ".setupScreenSaver" > < span class = "type-signature" > < static> < / span > setupScreenSaver()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-20" > line 20< / 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 = ".shuffleClicked" > < span class = "type-signature" > < static> < / span > shuffleClicked()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-151" > line 151< / a >
< / li >
< / ul >
< / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< hr >
< dt >
< h4 class = "name" id = ".startScreenSaver" > < span class = "type-signature" > < static> < / span > startScreenSaver()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-84" > line 84< / 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 = ".toggleShuffleEnabled" > < span class = "type-signature" > < static> < / span > toggleShuffleEnabled()< / h4 >
< / dt >
< dd >
< 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 = "components_music_AudioPlayerView.brs.html" > components/music/AudioPlayerView.brs< / a > ,
< a href = "components_music_AudioPlayerView.brs.html#sunlight-1-line-138" > line 138< / 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-28 01:54:11 +00:00
on Oct 28th 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 >
