PageRenderTime 33ms CodeModel.GetById 22ms app.highlight 8ms RepoModel.GetById 1ms app.codeStats 0ms

/flash/MP3FileReferenceLoaderLib/asdoc-output/org/audiofx/mp3/MP3FileReferenceLoader.html

http://echo-nest-remix.googlecode.com/
HTML | 169 lines | 158 code | 2 blank | 9 comment | 0 complexity | 17418e7a8fa1f12608216a7e5c7eee59 MD5 | raw file
  1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2<html>
  3<head>
  4<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  5<link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
  6<link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
  7<meta content="MP3FileReferenceLoader,org.audiofx.mp3.MP3FileReferenceLoader,getSound" name="keywords">
  8<title>org.audiofx.mp3.MP3FileReferenceLoader</title>
  9</head>
 10<body>
 11<script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
 12<!--
 13				asdocTitle = 'MP3FileReferenceLoader - API Documentation';
 14				var baseRef = '../../../';
 15				window.onload = configPage;
 16			--></script>
 17<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
 18<tr>
 19<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?org/audiofx/mp3/MP3FileReferenceLoader.html&amp;org/audiofx/mp3/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
 20</tr>
 21<tr class="titleTableRow2">
 22<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;MP3FileReferenceLoader</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a>&nbsp;| <a href="#eventSummary">Events</a></td>
 23</tr>
 24<tr class="titleTableRow3">
 25<td colspan="2">&nbsp;</td>
 26</tr>
 27</table>
 28<script type="text/javascript" language="javascript">
 29<!--
 30if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class MP3FileReferenceLoader"); titleBar_setSubNav(false,false,false,false,true,false,true,false,false,false,false,false,false,false);}
 31--></script>
 32<div class="MainContent">
 33<table cellspacing="0" cellpadding="0" class="classHeaderTable">
 34<tr>
 35<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">org.audiofx.mp3</a></td>
 36</tr>
 37<tr>
 38<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class MP3FileReferenceLoader</td>
 39</tr>
 40<tr>
 41<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">MP3FileReferenceLoader <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> flash.events.EventDispatcher</td>
 42</tr>
 43</table>
 44<p></p>
 45  Class for loading MP3 files from a FileReference
 46  <p></p>
 47<p>
 48<span class="classHeaderTableLabel">See also</span>
 49</p>
 50<div class="seeAlso">flash.net.FileReference</div>
 51<br>
 52<hr>
 53</div>
 54<a name="methodSummary"></a>
 55<div class="summarySection">
 56<div class="summaryTableTitle">Public Methods</div>
 57<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
 58<tr>
 59<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
 60</tr>
 61<tr class="">
 62<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
 63<div class="summarySignature">
 64<a class="signatureLink" href="#MP3FileReferenceLoader()">MP3FileReferenceLoader</a>()</div>
 65<div class="summaryTableDescription">
 66   Constructs an new MP3FileReferenceLoader instance 
 67   
 68   </div>
 69</td><td class="summaryTableOwnerCol">MP3FileReferenceLoader</td>
 70</tr>
 71<tr class="">
 72<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
 73<div class="summarySignature">
 74<a class="signatureLink" href="#getSound()">getSound</a>(fr:FileReference):void</div>
 75<div class="summaryTableDescription">
 76   Once a FileReference instance has been obtained, and the user has browsed to a file, call getSound to start loading the MP3 data.</div>
 77</td><td class="summaryTableOwnerCol">MP3FileReferenceLoader</td>
 78</tr>
 79</table>
 80</div>
 81<a name="eventSummary"></a>
 82<div class="summarySection">
 83<div class="summaryTableTitle">Events</div>
 84<table id="summaryTableEvent" class="summaryTable " cellpadding="3" cellspacing="0">
 85<tr>
 86<th>&nbsp;</th><th colspan="2">Event</th><th>Summary</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
 87</tr>
 88<tr class="">
 89<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
 90<div class="summarySignature">
 91<a class="signatureLink" href="#event:complete">complete</a>
 92</div>
 93</td><td class="summaryTableDescription summaryTableCol">
 94  Dispatched when the MP3 data is loaded
 95 </td><td class="summaryTableOwnerCol">MP3FileReferenceLoader</td>
 96</tr>
 97</table>
 98</div>
 99<script type="text/javascript" language="javascript">
100<!--
101showHideInherited();
102--></script>
103<div class="MainContent">
104<a name="constructorDetail"></a>
105<div class="detailSectionHeader">Constructor detail</div>
106<a name="MP3FileReferenceLoader()"></a>
107<table cellspacing="0" cellpadding="0" class="detailHeader">
108<tr>
109<td class="detailHeaderName">MP3FileReferenceLoader</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
110</tr>
111</table>
112<div class="detailBody">
113<code>public function MP3FileReferenceLoader()</code><p>
114   Constructs an new MP3FileReferenceLoader instance 
115   
116   </p></div>
117<a name="methodDetail"></a>
118<div class="detailSectionHeader">Method detail</div>
119<a name="getSound()"></a>
120<table cellspacing="0" cellpadding="0" class="detailHeader">
121<tr>
122<td class="detailHeaderName">getSound</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
123</tr>
124</table>
125<div class="detailBody">
126<code>public function getSound(fr:FileReference):void</code><p>
127   Once a FileReference instance has been obtained, and the user has browsed to a file, call getSound to start loading the MP3 data.
128   When the data is ready, an <code>MP3SoundEvent.COMPLETE</code> event is emitted.
129   </p><span class="label">Parameters</span>
130<table border="0" cellspacing="0" cellpadding="0">
131<tr>
132<td width="20px"></td><td><code><span class="label">fr</span>:FileReference</code> &mdash; A reference to a local file.
133   </td>
134</tr>
135</table>
136<p>
137<span class="label">See also</span>
138</p>
139<div class="seeAlso">
140<a href="MP3SoundEvent.html" target="">MP3SoundEvent</a>
141</div>
142</div>
143<div class="detailSectionHeader">Event detail</div>
144<a name="event:complete"></a>
145<table cellspacing="0" cellpadding="0" class="detailHeader">
146<tr>
147<td class="detailHeaderName">complete</td><td class="detailHeaderType">event&nbsp;</td>
148</tr>
149</table>
150<div class="detailBody">
151<span class="label">Event object type: </span><a href="../mp3/MP3SoundEvent.html"><code>org.audiofx.mp3.MP3SoundEvent</code></a>
152<br>
153<span class="label">MP3SoundEvent.type property = </span><a href="../mp3/MP3SoundEvent.html#COMPLETE"><code>org.audiofx.mp3.MP3SoundEvent.COMPLETE</code></a>
154<br><p>
155  Dispatched when the MP3 data is loaded
156 </p><p>
157    Used to signal the loading of a sound by the <code>MP3FileReferenceLoader</code> following a call to <code>MP3FileReferenceLoader.getSound</code>
158   </p></div>
159<br>
160<br>
161<hr>
162<br>
163<p></p>
164<center class="copyright"> 
165</center>
166</div>
167</body>
168</html>
169<!-- -->