lgladsden/jf-roku
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
27b374809e
jf-roku/docs/api/module-AudioPlayerView.html

3899 lines
178 KiB
HTML
Raw Normal View History

create api docs using jsdoc
2023-10-06 03:18:36 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
AudioPlayerView - Documentation
</title>
<link href="https://www.braintreepayments.com/images/favicon-ccda0b14.png" rel="icon" type="image/png">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<!-- start Mixpanel -->
<script type="text/javascript">(function(e,a){if(!a.__SV){var b=window;try{var c,l,i,j=b.location,g=j.hash;c=function(a,b){return(l=a.match(RegExp(b+"=([^&]*)")))?l[1]:null};g&&c(g,"state")&&(i=JSON.parse(decodeURIComponent(c(g,"state"))),"mpeditor"===i.action&&(b.sessionStorage.setItem("_mpcehash",g),history.replaceState(i.desiredHash||"",e.title,j.pathname+j.search)))}catch(m){}var k,h;window.mixpanel=a;a._i=[];a.init=function(b,c,f){function e(b,a){var c=a.split(".");2==c.length&&(b=b[c[0]],a=c[1]);b[a]=function(){b.push([a].concat(Array.prototype.slice.call(arguments,
0)))}}var d=a;"undefined"!==typeof f?d=a[f]=[]:f="mixpanel";d.people=d.people||[];d.toString=function(b){var a="mixpanel";"mixpanel"!==f&&(a+="."+f);b||(a+=" (stub)");return a};d.people.toString=function(){return d.toString(1)+".people (stub)"};k="disable time_event track track_pageview track_links track_forms register register_once alias unregister identify name_tag set_config reset people.set people.set_once people.increment people.append people.union people.track_charge people.clear_charges people.delete_user".split(" ");
for(h=0;h<k.length;h++)e(d,k[h]);a._i.push([b,c,f])};a.__SV=1.2;b=e.createElement("script");b.type="text/javascript";b.async=!0;b.src="undefined"!==typeof MIXPANEL_CUSTOM_LIB_URL?MIXPANEL_CUSTOM_LIB_URL:"file:"===e.location.protocol&&"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js".match(/^\/\//)?"https://cdn.mxpnl.com/libs/mixpanel-2-latest.min.js":"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js";c=e.getElementsByTagName("script")[0];c.parentNode.insertBefore(b,c)}})(document,window.mixpanel||[]);
mixpanel.init("1919205b2da72e4da3b9b6639b444d59");</script>
<!-- end Mixpanel -->
</head>
<body>
<svg style="display: none;">
<defs>
<symbol id="linkIcon" fill="#706d77" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M0 0h24v24H0z" fill="none"/>
<path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/>
</symbol>
</defs>
</svg>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<div class="top-nav-wrapper">
<ul>
<li >
<a href="index.html">
<svg fill="#6D6D6D" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"/>
<path d="M0 0h24v24H0z" fill="none"/>
</svg>
</a>
</li>
</ul>
</div>
<nav>
<h3 class="reference-title">
Braintree SDK Client Reference
</h3>
<h3>Classes</h3><ul><li id="Logger-nav"><a href="module-log.Logger.html">Logger</a><ul class='methods'><li data-type="method" id="Logger-debug-nav"><a href="module-log.Logger.html#debug">debug</a></li><li data-type="method" id="Logger-decreaseIndent-nav"><a href="module-log.Logger.html#decreaseIndent">decreaseIndent</a></li><li data-type="method" id="Logger-error-nav"><a href="module-log.Logger.html#error">error</a></li><li data-type="method" id="Logger-increaseIndent-nav"><a href="module-log.Logger.html#increaseIndent">increaseIndent</a></li><li data-type="method" id="Logger-info-nav"><a href="module-log.Logger.html#info">info</a></li><li data-type="method" id="Logger-log-nav"><a href="module-log.Logger.html#log">log</a></li><li data-type="method" id="Logger-method-nav"><a href="module-log.Logger.html#method">method</a></li><li data-type="method" id="Logger-resetIndent-nav"><a href="module-log.Logger.html#resetIndent">resetIndent</a></li><li data-type="method" id="Logger-toString-nav"><a href="module-log.Logger.html#toString">toString</a></li><li data-type="method" id="Logger-verbose-nav"><a href="module-log.Logger.html#verbose">verbose</a></li><li data-type="method" id="Logger-warn-nav"><a href="module-log.Logger.html#warn">warn</a></li></ul></li></ul><h3>Modules</h3><ul><li id="AlbumData-nav"><a href="module-AlbumData.html">AlbumData</a><ul class='methods'><li data-type="method" id="AlbumData-setFields-nav"><a href="module-AlbumData.html#.setFields">setFields</a></li></ul></li><li id="AlbumGrid-nav"><a href="module-AlbumGrid.html">AlbumGrid</a><ul class='methods'><li data-type="method" id="AlbumGrid-getData-nav"><a href="module-AlbumGrid.html#.getData">getData</a></li><li data-type="method" id="AlbumGrid-init-nav"><a href="module-AlbumGrid.html#.init">init</a></li><li data-type="method" id="AlbumGrid-onKeyEvent-nav"><a href="module-AlbumGrid.html#.onKeyEvent">onKeyEvent</a></li></ul></li><li id="AlbumTrackList-nav"><a href="module-AlbumTrackList.html">AlbumTrackList</a><ul class='methods'><li data-type="method" id="AlbumTrackList-getData-nav"><a href="module-AlbumTrackList.html#.getData">getData</a></li><li data-type="method" id="AlbumTrackList-init-nav"><a href="module-AlbumTrackList.html#.init">init</a></li></ul></li><li id="AlbumView-nav"><a href="module-AlbumView.html">AlbumView</a><ul class='methods'><li data-type="method" id="AlbumView-OnScreenHidden-nav"><a href="module-AlbumView.html#.OnScreenHidden">OnScreenHidden</a></li><li data-type="method" id="AlbumView-adjustScreenForNoOverview-nav"><a href="module-AlbumView.html#.adjustScreenForNoOverview">adjustScreenForNoOverview</a></li><li data-type="method" id="AlbumView-createDialogPallete-nav"><a href="module-AlbumView.html#.createDialogPallete">createDialogPallete</a></li><li data-type="method" id="AlbumView-createFullDscrDlg-nav"><a href="module-AlbumView.html#.createFullDscrDlg">createFullDscrDlg</a></li><li data-type="method" id="AlbumView-init-nav"><a href="module-AlbumView.html#.init">init</a></li><li data-type="method" id="AlbumView-onDoneLoading-nav"><a href="module-AlbumView.html#.onDoneLoading">onDoneLoading</a></li><li data-type="method" id="AlbumView-onKeyEvent-nav"><a href="module-AlbumView.html#.onKeyEvent">onKeyEvent</a></li><li data-type="method" id="AlbumView-pageContentChanged-nav"><a href="module-AlbumView.html#.pageContentChanged">pageContentChanged</a></li><li data-type="method" id="AlbumView-setOnScreenTextValues-nav"><a href="module-AlbumView.html#.setOnScreenTextValues">setOnScreenTextValues</a></li><li data-type="method" id="AlbumView-setPosterImage-nav"><a href="module-AlbumView.html#.setPosterImage">setPosterImage</a></li><li data-type="method" id="AlbumView-setScreenTitle-nav"><a href="module-AlbumView.html#.setScreenTitle">setScreenTitle</a></li><li data-type="method" id="AlbumView-setupMainNode-nav"><a href="module-AlbumView.html#.setupMainNode">setupMainNode</a></li></ul></li><li id="Alpha-nav"><a href="module-Alpha.html">Alpha</a><ul class='methods'><li data-type="method" id="Alpha-init-nav"><a href="module-Alpha.html#.init">
</nav>
<div id="main">
<h1 class="page-title">
AudioPlayerView
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-source">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#line1">line 1</a>
</li>
</ul>
</dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<span class='name-container'>
<a class="link-icon" href="#.LoadNextSong">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".LoadNextSong">
<span class="type-signature">(static) </span>LoadNextSong<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line169">line 169</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.OnScreenHidden">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".OnScreenHidden">
<span class="type-signature">(static) </span>OnScreenHidden<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line248">line 248</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.audioPositionChanged">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".audioPositionChanged">
<span class="type-signature">(static) </span>audioPositionChanged<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line72">line 72</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.audioStateChanged">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".audioStateChanged">
<span class="type-signature">(static) </span>audioStateChanged<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line96">line 96</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.bufferPositionChanged">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".bufferPositionChanged">
<span class="type-signature">(static) </span>bufferPositionChanged<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line66">line 66</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.endScreenSaver">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".endScreenSaver">
<span class="type-signature">(static) </span>endScreenSaver<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line90">line 90</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.findCurrentSongIndex">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".findCurrentSongIndex">
<span class="type-signature">(static) </span>findCurrentSongIndex<span class="signature">(songList)</span><span class="type-signature"> &rarr; {integer}</span>
</h4>
</span>
<h5>Parameters:</h5>
<table class="params">
<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">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#line145">line 145</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.init">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".init">
<span class="type-signature">(static) </span>init<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line8">line 8</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.loadButtons">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".loadButtons">
<span class="type-signature">(static) </span>loadButtons<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<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">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#line183">line 183</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.loopClicked">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".loopClicked">
<span class="type-signature">(static) </span>loopClicked<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line120">line 120</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.nextClicked">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".nextClicked">
<span class="type-signature">(static) </span>nextClicked<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line132">line 132</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.onAudioStreamLoaded">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".onAudioStreamLoaded">
<span class="type-signature">(static) </span>onAudioStreamLoaded<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line189">line 189</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.onBackdropImageLoaded">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".onBackdropImageLoaded">
<span class="type-signature">(static) </span>onBackdropImageLoaded<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line195">line 195</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.onButtonSelectedChange">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".onButtonSelectedChange">
<span class="type-signature">(static) </span>onButtonSelectedChange<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<div class="description">
<p>Event handler when user selected a different playback button</p>
</div>
<dl class="details">
<dt class="tag-source">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#line54">line 54</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.onKeyEvent">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".onKeyEvent">
<span class="type-signature">(static) </span>onKeyEvent<span class="signature">(key, press)</span><span class="type-signature"> &rarr; {boolean}</span>
</h4>
</span>
<div class="description">
<p>Process key press events</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<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">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#line242">line 242</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.onMetaDataLoaded">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".onMetaDataLoaded">
<span class="type-signature">(static) </span>onMetaDataLoaded<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line201">line 201</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.onScreensaverTimeoutLoaded">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".onScreensaverTimeoutLoaded">
<span class="type-signature">(static) </span>onScreensaverTimeoutLoaded<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line14">line 14</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.pageContentChanged">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".pageContentChanged">
<span class="type-signature">(static) </span>pageContentChanged<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<div class="description">
<p>Update values on screen when page content changes</p>
</div>
<dl class="details">
<dt class="tag-source">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#line176">line 176</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.playAction">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".playAction">
<span class="type-signature">(static) </span>playAction<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line102">line 102</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.previousClicked">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".previousClicked">
<span class="type-signature">(static) </span>previousClicked<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line108">line 108</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.resetLoopModeToDefault">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".resetLoopModeToDefault">
<span class="type-signature">(static) </span>resetLoopModeToDefault<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line114">line 114</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.screenSaverActive">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".screenSaverActive">
<span class="type-signature">(static) </span>screenSaverActive<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line78">line 78</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.setBackdropImage">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".setBackdropImage">
<span class="type-signature">(static) </span>setBackdropImage<span class="signature">(data)</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<div class="description">
<p>Add backdrop image to screen</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<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">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#line233">line 233</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.setLoopButtonImage">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".setLoopButtonImage">
<span class="type-signature">(static) </span>setLoopButtonImage<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line126">line 126</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.setOnScreenTextValues">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".setOnScreenTextValues">
<span class="type-signature">(static) </span>setOnScreenTextValues<span class="signature">(json)</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<div class="description">
<p>Populate on screen text variables</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<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">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#line225">line 225</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.setPosterImage">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".setPosterImage">
<span class="type-signature">(static) </span>setPosterImage<span class="signature">(posterURL)</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<div class="description">
<p>Set poster image on screen</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<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">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#line209">line 209</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.setScreenTitle">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".setScreenTitle">
<span class="type-signature">(static) </span>setScreenTitle<span class="signature">(json)</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<div class="description">
<p>Set screen's title text</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<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">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#line217">line 217</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.setShuffleIconState">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".setShuffleIconState">
<span class="type-signature">(static) </span>setShuffleIconState<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line157">line 157</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.setTrackNumberDisplay">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".setTrackNumberDisplay">
<span class="type-signature">(static) </span>setTrackNumberDisplay<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line163">line 163</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.setupAnimationTasks">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".setupAnimationTasks">
<span class="type-signature">(static) </span>setupAnimationTasks<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line26">line 26</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.setupAudioNode">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".setupAudioNode">
<span class="type-signature">(static) </span>setupAudioNode<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<div class="description">
<p>Creates audio node used to play song(s)</p>
</div>
<dl class="details">
<dt class="tag-source">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#line40">line 40</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.setupButtons">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".setupButtons">
<span class="type-signature">(static) </span>setupButtons<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<div class="description">
<p>Setup playback buttons, default to Play button selected</p>
</div>
<dl class="details">
<dt class="tag-source">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#line47">line 47</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.setupDataTasks">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".setupDataTasks">
<span class="type-signature">(static) </span>setupDataTasks<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<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">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#line33">line 33</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.setupInfoNodes">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".setupInfoNodes">
<span class="type-signature">(static) </span>setupInfoNodes<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line60">line 60</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.setupScreenSaver">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".setupScreenSaver">
<span class="type-signature">(static) </span>setupScreenSaver<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line20">line 20</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.shuffleClicked">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".shuffleClicked">
<span class="type-signature">(static) </span>shuffleClicked<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line151">line 151</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.startScreenSaver">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".startScreenSaver">
<span class="type-signature">(static) </span>startScreenSaver<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line84">line 84</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#.toggleShuffleEnabled">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id=".toggleShuffleEnabled">
<span class="type-signature">(static) </span>toggleShuffleEnabled<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span>
</h4>
</span>
<dl class="details">
<dt class="tag-source">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#line138">line 138</a>
</li>
</ul>
</dd>
</dl>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
</footer>
<script src="scripts/linenumber.js"></script>
<script src="scripts/pagelocation.js"></script>
</body>
</html>
Reference in New Issue Copy Permalink