diff options
author | Bryan Berry <bryan@olenepal.org> | 2010-02-17 09:39:34 (GMT) |
---|---|---|
committer | Bryan Berry <bryan@olenepal.org> | 2010-02-17 09:39:34 (GMT) |
commit | 0aa48d0503c69c9ebc1d2bb209bfbec10e8bed64 (patch) | |
tree | 5008d89f95d62696440785a85c08949a7fd27c97 /docs/symbols/Karma.kAudio.html |
initial commit. Lesson English_Animal_Identification is current template
Diffstat (limited to 'docs/symbols/Karma.kAudio.html')
-rwxr-xr-x | docs/symbols/Karma.kAudio.html | 509 |
1 files changed, 509 insertions, 0 deletions
diff --git a/docs/symbols/Karma.kAudio.html b/docs/symbols/Karma.kAudio.html new file mode 100755 index 0000000..3d1c339 --- /dev/null +++ b/docs/symbols/Karma.kAudio.html @@ -0,0 +1,509 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=utf-8" /> + <meta name="generator" content="JsDoc Toolkit" /> + + <title>JsDoc Reference - Karma.kAudio</title> + + <style type="text/css"> + /* default.css */ +body +{ + font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif; + width: 800px; +} + +.header +{ + clear: both; + background-color: #ccc; + padding: 8px; +} + +h1 +{ + font-size: 150%; + font-weight: bold; + padding: 0; + margin: 1em 0 0 .3em; +} + +hr +{ + border: none 0; + border-top: 1px solid #7F8FB1; + height: 1px; +} + +pre.code +{ + display: block; + padding: 8px; + border: 1px dashed #ccc; +} + +#index +{ + margin-top: 24px; + float: left; + width: 160px; + position: absolute; + left: 8px; + background-color: #F3F3F3; + padding: 8px; +} + +#content +{ + margin-left: 190px; + width: 600px; +} + +.classList +{ + list-style-type: none; + padding: 0; + margin: 0 0 0 8px; + font-family: arial, sans-serif; + font-size: 1em; + overflow: auto; +} + +.classList li +{ + padding: 0; + margin: 0 0 8px 0; +} + +.summaryTable { width: 100%; } + +h1.classTitle +{ + font-size:170%; + line-height:130%; +} + +h2 { font-size: 110%; } +caption, div.sectionTitle +{ + background-color: #7F8FB1; + color: #fff; + font-size:130%; + text-align: left; + padding: 2px 6px 2px 6px; + border: 1px #7F8FB1 solid; +} + +div.sectionTitle { margin-bottom: 8px; } +.summaryTable thead { display: none; } + +.summaryTable td +{ + vertical-align: top; + padding: 4px; + border-bottom: 1px #7F8FB1 solid; + border-right: 1px #7F8FB1 solid; +} + +/*col#summaryAttributes {}*/ +.summaryTable td.attributes +{ + border-left: 1px #7F8FB1 solid; + width: 140px; + text-align: right; +} + +td.attributes, .fixedFont +{ + line-height: 15px; + color: #002EBE; + font-family: "Courier New",Courier,monospace; + font-size: 13px; +} + +.summaryTable td.nameDescription +{ + text-align: left; + font-size: 13px; + line-height: 15px; +} + +.summaryTable td.nameDescription, .description +{ + line-height: 15px; + padding: 4px; + padding-left: 4px; +} + +.summaryTable { margin-bottom: 8px; } + +ul.inheritsList +{ + list-style: square; + margin-left: 20px; + padding-left: 0; +} + +.detailList { + margin-left: 20px; + line-height: 15px; +} +.detailList dt { margin-left: 20px; } + +.detailList .heading +{ + font-weight: bold; + padding-bottom: 6px; + margin-left: 0; +} + +.light, td.attributes, .light a:link, .light a:visited +{ + color: #777; + font-style: italic; +} + +.fineprint +{ + text-align: right; + font-size: 10px; +} + </style> + </head> + + <body> +<!-- ============================== header ================================= --> + <!-- begin static/header.html --> + <div id="header"> +</div> + <!-- end static/header.html --> + +<!-- ============================== classes index ============================ --> + <div id="index"> + <!-- begin publish.classesIndex --> + <div align="center"><a href="../index.html">Class Index</a> +| <a href="../files.html">File Index</a></div> +<hr /> +<h2>Classes</h2> +<ul class="classList"> + + <li><a href="../symbols/%24.ui.feedback.html">$.ui.feedback</a></li> + + <li><a href="../symbols/%24.ui.feedback.defaults.html">$.ui.feedback.defaults</a></li> + + <li><a href="../symbols/%24.ui.kFooter.html">$.ui.kFooter</a></li> + + <li><a href="../symbols/%24.ui.kFooter.defaults.html">$.ui.kFooter.defaults</a></li> + + <li><a href="../symbols/%24.ui.kHeader.html">$.ui.kHeader</a></li> + + <li><a href="../symbols/%24.ui.kHeader.defaults.html">$.ui.kHeader.defaults</a></li> + + <li><i><a href="../symbols/_global_.html">_global_</a></i></li> + + <li><a href="../symbols/Karma.html">Karma</a></li> + + <li><a href="../symbols/Karma.kAudio.html">Karma.kAudio</a></li> + + <li><a href="../symbols/Karma.kCanvas.html">Karma.kCanvas</a></li> + + <li><a href="../symbols/Karma.kImage.html">Karma.kImage</a></li> + + <li><a href="../symbols/Karma.kSvg.html">Karma.kSvg</a></li> + + <li><a href="../symbols/Karma.kVideo.html">Karma.kVideo</a></li> + +</ul> +<hr /> + <!-- end publish.classesIndex --> + </div> + + <div id="content"> +<!-- ============================== class title ============================ --> + <h1 class="classTitle"> + + Class Karma.kAudio + </h1> + +<!-- ============================== class summary ========================== --> + <p class="description"> + + + + This object is the prototype for audio files submitted to Karma in the +Karma() method + + + <br /><i>Defined in: </i> <a href="../symbols/src/js_karma.js.html">karma.js</a>. + + </p> + +<!-- ============================== constructor summary ==================== --> + + <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Karma.kAudio."> + <caption>Class Summary</caption> + <thead> + <tr> + <th scope="col">Constructor Attributes</th> + <th scope="col">Constructor Name and Description</th> + </tr> + </thead> + <tbody> + <tr> + <td class="attributes"> </td> + <td class="nameDescription" > + <div class="fixedFont"> + <b><a href="../symbols/Karma.kAudio.html#constructor">Karma.kAudio</a></b>() + </div> + <div class="description">Prototype object for audio files</div> + </td> + </tr> + </tbody> + </table> + + +<!-- ============================== properties summary ===================== --> + + + + <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class Karma.kAudio."> + <caption>Field Summary</caption> + <thead> + <tr> + <th scope="col">Field Attributes</th> + <th scope="col">Field Name and Description</th> + </tr> + </thead> + <tbody> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont"> + Karma.kAudio.<b><a href="../symbols/Karma.kAudio.html#.file">file</a></b> + </div> + <div class="description">file location of asset</div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont"> + Karma.kAudio.<b><a href="../symbols/Karma.kAudio.html#.media">media</a></b> + </div> + <div class="description">Media object.</div> + </td> + </tr> + + </tbody> + </table> + + + + + +<!-- ============================== methods summary ======================== --> + + + + <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Karma.kAudio."> + <caption>Method Summary</caption> + <thead> + <tr> + <th scope="col">Method Attributes</th> + <th scope="col">Method Name and Description</th> + </tr> + </thead> + <tbody> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kAudio.<b><a href="../symbols/Karma.kAudio.html#.play">play</a></b>() + </div> + <div class="description">Plays the audio file</div> + </td> + </tr> + + </tbody> + </table> + + + + +<!-- ============================== events summary ======================== --> + + +<!-- ============================== constructor details ==================== --> + + <div class="details"><a name="constructor"> </a> + <div class="sectionTitle"> + Class Detail + </div> + + <div class="fixedFont"> + <b>Karma.kAudio</b>() + </div> + + <div class="description"> + Prototype object for audio files + + </div> + + + + <pre class="code"> kAudio is the prototype object for audio + The audio assets are loaded in a distinctly different way + from the canvas or svg assets. They also have distinctly different + helper methods + + You initialize the kAudio assets by passing an array of objects</pre> + + + + + + + + + <dl class="detailList"> + <dt class="heading">Throws:</dt> + + <dt> + <span class="light fixedFont">{Error}</span> <b></b> + </dt> + <dd>if the individual audio asset is set to be localized but + the globale locale is not set on the Karma object</dd> + + <dt> + <span class="light fixedFont">{Error}</span> <b></b> + </dt> + <dd>if the name and file properties are not supplied</dd> + + </dl> + + + + + + </div> + + +<!-- ============================== field details ========================== --> + + <div class="sectionTitle"> + Field Detail + </div> + + <a name=".file"> </a> + <div class="fixedFont"><static> + + <span class="light">{String}</span> + <span class="light">Karma.kAudio.</span><b>file</b> + + </div> + <div class="description"> + file location of asset + + + </div> + + + + + + + + <dl class="detailList"> + <dt class="heading">Default Value:</dt> + <dd> + "" + </dd> + </dl> + + + <hr /> + + <a name=".media"> </a> + <div class="fixedFont"><static> + + <span class="light">{Audio}</span> + <span class="light">Karma.kAudio.</span><b>media</b> + + </div> + <div class="description"> + Media object. You can access the src, autobuffer, autoplay, loop, and +controls attributes +via the media property of kAudio. Read more about the properties of the <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/video.html#media-element-attributes">HTML 5 media element</a> + + + </div> + + + + + + + + <dl class="detailList"> + <dt class="heading">Default Value:</dt> + <dd> + undefined + </dd> + </dl> + + + + + + +<!-- ============================== method details ========================= --> + + <div class="sectionTitle"> + Method Detail + </div> + + <a name=".play"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kAudio.</span><b>play</b>() + + </div> + <div class="description"> + Plays the audio file + + + </div> + + + + + + + + + + + + + + + +<!-- ============================== event details ========================= --> + + + <hr /> + </div> + + +<!-- ============================== footer ================================= --> + <div class="fineprint" style="clear:both"> + + Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Wed Feb 17 2010 14:55:42 GMT+0545 (NPT) + </div> + </body> +</html> |